Retrieves the details of an account.
","operationId":"GetAccount","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_account"}},"/v1/account_links":{"post":{"summary":"Create an account link","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":{"schema":{"required":["account","type"],"type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"The identifier of the account to create an account link for."},"collect":{"type":"string","description":"The collect parameter is deprecated. Use `collection_options` instead.","enum":["currently_due","eventually_due"]},"collection_options":{"title":"collection_options_params","type":"object","properties":{"fields":{"type":"string","description":"Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.","enum":["currently_due","eventually_due"]},"future_requirements":{"type":"string","description":"Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.","enum":["include","omit"]}},"description":"Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.","x-stripeMostCommon":["fields","future_requirements"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"refresh_url":{"type":"string","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."},"return_url":{"type":"string","description":"The URL that the user will be redirected to upon leaving or completing the linked flow."},"type":{"type":"string","description":"The type of account link the user is requesting.\n\nYou can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.","enum":["account_onboarding","account_update","capital_financing_offer","capital_financing_reporting"],"x-stripeBypassValidation":true}},"additionalProperties":false,"x-stripeMostCommon":["account","refresh_url","return_url","type"]},"encoding":{"collection_options":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_account_link"}},"/v1/account_notices":{"get":{"summary":"List AccountNotices","description":"Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
Retrieves an AccountNotice object.
Updates an AccountNotice object.
Creates an 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":{"schema":{"required":["account","components"],"type":"object","properties":{"account":{"type":"string","description":"The identifier of the account to create an Account Session for."},"components":{"title":"account_session_create_components_param","type":"object","properties":{"account_management":{"title":"account_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"account_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","external_account_collection"]}},"description":"Configuration for the [account management](/connect/supported-embedded-components/account-management/) embedded component.","x-stripeMostCommon":["enabled","features"]},"account_onboarding":{"title":"account_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"account_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","external_account_collection"]}},"description":"Configuration for the [account onboarding](/connect/supported-embedded-components/account-onboarding/) embedded component.","x-stripeMostCommon":["enabled","features"]},"app_install":{"title":"app_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"app_features_param","type":"object","properties":{"allowed_apps":{"description":"The list of apps allowed to be enabled in the embedded component.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["allowed_apps"]}},"description":"Configuration for the [app install](/connect/supported-embedded-components/app-install/) embedded component.","x-stripeMostCommon":["enabled","features"]},"app_viewport":{"title":"app_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"app_features_param","type":"object","properties":{"allowed_apps":{"description":"The list of apps allowed to be enabled in the embedded component.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["allowed_apps"]}},"description":"Configuration for the [app viewport](/connect/supported-embedded-components/app-viewport/) embedded component.","x-stripeMostCommon":["enabled","features"]},"balance_report":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [balance report](/connect/supported-embedded-components/financial-reports#balance-report) embedded component.","x-stripeMostCommon":["enabled","features"]},"balances":{"title":"payouts_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"payouts_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"edit_payout_schedule":{"type":"boolean","description":"Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."},"instant_payouts":{"type":"boolean","description":"Whether instant payouts are enabled for this component."},"standard_payouts":{"type":"boolean","description":"Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","edit_payout_schedule","external_account_collection","instant_payouts","standard_payouts"]}},"description":"Configuration for the [balances](/connect/supported-embedded-components/balances/) embedded component.","x-stripeMostCommon":["enabled","features"]},"capital_financing":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [Capital financing](/connect/supported-embedded-components/capital-financing/) embedded component.","x-stripeMostCommon":["enabled","features"]},"capital_financing_application":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [Capital financing application](/connect/supported-embedded-components/capital-financing-application/) embedded component.","x-stripeMostCommon":["enabled","features"]},"capital_financing_promotion":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [Capital financing promotion](/connect/supported-embedded-components/capital-financing-promotion/) embedded component.","x-stripeMostCommon":["enabled","features"]},"capital_overview":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [Capital overview](/connect/supported-embedded-components/capital-overview/) embedded component.","x-stripeMostCommon":["enabled","features"]},"disputes_list":{"title":"disputes_list_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"disputes_list_features_param","type":"object","properties":{"capture_payments":{"type":"boolean","description":"Whether to allow capturing and cancelling payment intents. This is `true` by default."},"destination_on_behalf_of_charge_management":{"type":"boolean","description":"Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."},"dispute_management":{"type":"boolean","description":"Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."},"refund_management":{"type":"boolean","description":"Whether sending refunds is enabled. This is `true` by default."},"smart_disputes_management":{"type":"boolean","description":"Whether to allow connected accounts to submit disputes using Smart Disputes. Defaults to the value of `dispute_management`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["capture_payments","destination_on_behalf_of_charge_management","dispute_management","refund_management","smart_disputes_management"]}},"description":"Configuration for the [disputes list](/connect/supported-embedded-components/disputes-list/) embedded component.","x-stripeMostCommon":["enabled","features"]},"documents":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [documents](/connect/supported-embedded-components/documents/) embedded component.","x-stripeMostCommon":["enabled","features"]},"export_tax_transactions":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [export tax transactions](/connect/supported-embedded-components/export-tax-transactions/) embedded component.","x-stripeMostCommon":["enabled","features"]},"financial_account":{"title":"financial_account_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"financial_account_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."},"send_money":{"type":"boolean","description":"Whether to allow sending money."},"transfer_balance":{"type":"boolean","description":"Whether to allow transferring balance."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","external_account_collection","send_money","transfer_balance"]}},"description":"Configuration for the [financial account](/connect/supported-embedded-components/financial-account/) embedded component.","x-stripeMostCommon":["enabled","features"]},"financial_account_transactions":{"title":"financial_account_transactions_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"financial_account_transactions_features_param","type":"object","properties":{"card_spend_dispute_management":{"type":"boolean","description":"Whether to allow card spend dispute management features."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["card_spend_dispute_management"]}},"description":"Configuration for the [financial account transactions](/connect/supported-embedded-components/financial-account-transactions/) embedded component.","x-stripeMostCommon":["enabled","features"]},"instant_payouts_promotion":{"title":"instant_payouts_promotion_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"instant_payouts_promotion_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."},"instant_payouts":{"type":"boolean","description":"Whether instant payouts are enabled for this component."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","external_account_collection","instant_payouts"]}},"description":"Configuration for the [instant payouts promotion](/connect/supported-embedded-components/instant-payouts-promotion/) embedded component.","x-stripeMostCommon":["enabled","features"]},"issuing_card":{"title":"issuing_card_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"issuing_card_features_param","type":"object","properties":{"card_management":{"type":"boolean","description":"Whether to allow card management features."},"card_spend_dispute_management":{"type":"boolean","description":"Whether to allow card spend dispute management features."},"cardholder_management":{"type":"boolean","description":"Whether to allow cardholder management features."},"spend_control_management":{"type":"boolean","description":"Whether to allow spend control management features."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["card_management","card_spend_dispute_management","cardholder_management","spend_control_management"]}},"description":"Configuration for the [issuing card](/connect/supported-embedded-components/issuing-card/) embedded component.","x-stripeMostCommon":["enabled","features"]},"issuing_cards_list":{"title":"issuing_cards_list_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"issuing_cards_list_features_param","type":"object","properties":{"card_management":{"type":"boolean","description":"Whether to allow card management features."},"card_spend_dispute_management":{"type":"boolean","description":"Whether to allow card spend dispute management features."},"cardholder_management":{"type":"boolean","description":"Whether to allow cardholder management features."},"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"spend_control_management":{"type":"boolean","description":"Whether to allow spend control management features."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["card_management","card_spend_dispute_management","cardholder_management","disable_stripe_user_authentication","spend_control_management"]}},"description":"Configuration for the [issuing cards list](/connect/supported-embedded-components/issuing-cards-list/) embedded component.","x-stripeMostCommon":["enabled","features"]},"notification_banner":{"title":"account_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"account_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","external_account_collection"]}},"description":"Configuration for the [notification banner](/connect/supported-embedded-components/notification-banner/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payment_details":{"title":"payments_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"payments_features_param","type":"object","properties":{"capture_payments":{"type":"boolean","description":"Whether to allow capturing and cancelling payment intents. This is `true` by default."},"destination_on_behalf_of_charge_management":{"type":"boolean","description":"Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."},"dispute_management":{"type":"boolean","description":"Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."},"refund_management":{"type":"boolean","description":"Whether sending refunds is enabled. This is `true` by default."},"smart_disputes_management":{"type":"boolean","description":"Whether to allow connected accounts to submit disputes using Smart Disputes. Defaults to the value of `dispute_management`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["capture_payments","destination_on_behalf_of_charge_management","dispute_management","refund_management","smart_disputes_management"]}},"description":"Configuration for the [payment details](/connect/supported-embedded-components/payment-details/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payment_disputes":{"title":"payment_disputes_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"payment_disputes_features_param","type":"object","properties":{"destination_on_behalf_of_charge_management":{"type":"boolean","description":"Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."},"dispute_management":{"type":"boolean","description":"Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."},"refund_management":{"type":"boolean","description":"Whether sending refunds is enabled. This is `true` by default."},"smart_disputes_management":{"type":"boolean","description":"Whether to allow connected accounts to submit disputes using Smart Disputes. Defaults to the value of `dispute_management`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["destination_on_behalf_of_charge_management","dispute_management","refund_management","smart_disputes_management"]}},"description":"Configuration for the [payment disputes](/connect/supported-embedded-components/payment-disputes/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payment_method_settings":{"title":"payment_method_settings_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"payment_method_settings_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. This is `false` by default."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication"]}},"description":"Configuration for the [payment method settings](/connect/supported-embedded-components/payment-method-settings/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payments":{"title":"payments_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"payments_features_param","type":"object","properties":{"capture_payments":{"type":"boolean","description":"Whether to allow capturing and cancelling payment intents. This is `true` by default."},"destination_on_behalf_of_charge_management":{"type":"boolean","description":"Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."},"dispute_management":{"type":"boolean","description":"Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."},"refund_management":{"type":"boolean","description":"Whether sending refunds is enabled. This is `true` by default."},"smart_disputes_management":{"type":"boolean","description":"Whether to allow connected accounts to submit disputes using Smart Disputes. Defaults to the value of `dispute_management`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["capture_payments","destination_on_behalf_of_charge_management","dispute_management","refund_management","smart_disputes_management"]}},"description":"Configuration for the [payments](/connect/supported-embedded-components/payments/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payout_details":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [payout details](/connect/supported-embedded-components/payout-details/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payout_reconciliation_report":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [payout reconciliation report](/connect/supported-embedded-components/financial-reports#payout-reconciliation-report) embedded component.","x-stripeMostCommon":["enabled","features"]},"payouts":{"title":"payouts_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"payouts_features_param","type":"object","properties":{"disable_stripe_user_authentication":{"type":"boolean","description":"Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."},"edit_payout_schedule":{"type":"boolean","description":"Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."},"external_account_collection":{"type":"boolean","description":"Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."},"instant_payouts":{"type":"boolean","description":"Whether instant payouts are enabled for this component."},"standard_payouts":{"type":"boolean","description":"Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."}},"description":"The list of features enabled in the embedded component.","x-stripeMostCommon":["disable_stripe_user_authentication","edit_payout_schedule","external_account_collection","instant_payouts","standard_payouts"]}},"description":"Configuration for the [payouts](/connect/supported-embedded-components/payouts/) embedded component.","x-stripeMostCommon":["enabled","features"]},"payouts_list":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [payouts list](/connect/supported-embedded-components/payouts-list/) embedded component.","x-stripeMostCommon":["enabled","features"]},"product_tax_code_selector":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [product tax code selector](/connect/supported-embedded-components/product-tax-code-selector/) embedded component.","x-stripeMostCommon":["enabled","features"]},"recipients":{"title":"recipients_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"recipients_features_param","type":"object","properties":{"send_money":{"type":"boolean","description":"Whether to allow sending money."}},"x-stripeMostCommon":["send_money"]}},"description":"Configuration for the [recipients](/connect/supported-embedded-components/recipients/) embedded component.","x-stripeMostCommon":["enabled","features"]},"reporting_chart":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [reporting chart](/connect/supported-embedded-components/reporting-chart/) embedded component.","x-stripeMostCommon":["enabled","features"]},"tax_registrations":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [tax registrations](/connect/supported-embedded-components/tax-registrations/) embedded component.","x-stripeMostCommon":["enabled","features"]},"tax_settings":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [tax settings](/connect/supported-embedded-components/tax-settings/) embedded component.","x-stripeMostCommon":["enabled","features"]},"tax_threshold_monitoring":{"title":"base_config_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the embedded component is enabled."},"features":{"title":"base_features_param","type":"object","properties":{},"description":"An empty list, because this embedded component has no features."}},"description":"Configuration for the [tax threshold monitoring](/connect/supported-embedded-components/tax-threshold-monitoring/) embedded component.","x-stripeMostCommon":["enabled","features"]}},"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).","x-stripeMostCommon":["account_management","account_onboarding","agentic_commerce_settings","app_install","app_viewport","balance_report","balances","capital_financing","capital_financing_application","capital_financing_manual_payment","capital_financing_promotion","capital_overview","check_scanning","disputes_list","documents","export_tax_transactions","financial_account","financial_account_rewards","financial_account_transactions","financial_accounts","financial_accounts_transactions","instant_payouts_promotion","issuing_card","issuing_cards_list","network_cost_passthrough_report","notification_banner","outbound_payment_details","payment_details","payment_disputes","payment_method_settings","payments","payout_details","payout_reconciliation_report","payouts","payouts_list","product_tax_code_selector","recipients","recipients_list","reporting_chart","tax_registrations","tax_settings","tax_threshold_monitoring","terminal_hardware_orders","terminal_hardware_shop"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["account","components"]},"encoding":{"components":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_account_session"}},"/v1/accounts":{"get":{"summary":"List all connected accounts","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":[{"name":"created","in":"query","description":"Only return connected accounts that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"AccountList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/account"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/accounts","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_accounts"},"post":{"summary":"Create an account","description":"With Connect, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform.
\n\nIf you’ve already collected information for your connected accounts, you can prefill that information when\ncreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\nYou can prefill any information on the account.
","operationId":"PostAccounts","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"account_token":{"maxLength":5000,"type":"string","description":"An [account token](https://docs.stripe.com/api#create_account_token), used to securely provide details to the account."},"business_profile":{"title":"business_profile_specs","type":"object","properties":{"annual_revenue":{"title":"annual_revenue_specs","required":["amount","currency","fiscal_year_end"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal)."},"currency":{"type":"string","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).","format":"currency"},"fiscal_year_end":{"maxLength":5000,"type":"string","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."}},"description":"The applicant's gross annual revenue for its preceding fiscal year.","x-stripeMostCommon":["amount","currency","fiscal_year_end"]},"estimated_worker_count":{"type":"integer","description":"An estimated upper bound of employees, contractors, vendors, etc. currently working for the business."},"mcc":{"maxLength":4,"type":"string","description":"[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide."},"minority_owned_business_designation":{"type":"array","description":"Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.","items":{"type":"string","enum":["lgbtqi_owned_business","minority_owned_business","none_of_these_apply","prefer_not_to_answer","women_owned_business"]}},"monthly_estimated_revenue":{"title":"monthly_estimated_revenue_specs","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal)."},"currency":{"type":"string","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).","format":"currency"}},"description":"An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.","x-stripeMostCommon":["amount","currency"]},"name":{"maxLength":5000,"type":"string","description":"The customer-facing business name."},"product_description":{"maxLength":40000,"type":"string","description":"Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes."},"specified_commercial_transactions_act_url":{"description":"A link to the business's publicly available terms related to the Specified Commercial Transaction Act. Used by the Checkout product and for Japanese payment methods.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"support_address":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"A publicly available mailing address for sending support issues to.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"support_email":{"type":"string","description":"A publicly available email address for sending support issues to."},"support_phone":{"maxLength":5000,"type":"string","description":"A publicly available phone number to call with support issues."},"support_url":{"description":"A publicly available website for handling support issues.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"url":{"type":"string","description":"The business's publicly available website."}},"description":"Business information about the account.","x-stripeMostCommon":["annual_revenue","customer_regions","estimated_worker_count","funding_source","industry","mcc","minority_owned_business_designation","monthly_estimated_revenue","name","payment_collection_methods","privacy_policy_url","product_description","singapore_account_activity_survey","specified_commercial_transactions_act_url","support_address","support_email","support_phone","support_url","terms_of_service_url","url","url_opt_out_reason"]},"business_type":{"type":"string","description":"The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.","enum":["company","government_entity","individual","non_profit"],"x-stripeBypassValidation":true},"capabilities":{"title":"capabilities_param","type":"object","properties":{"acss_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The acss_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"affirm_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The affirm_payments capability.","x-stripeMostCommon":["preview","requested"]},"afterpay_clearpay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The afterpay_clearpay_payments capability.","x-stripeMostCommon":["preview","requested"]},"alma_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The alma_payments capability.","x-stripeMostCommon":["preview","requested"]},"amazon_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The amazon_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"app_distribution":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The app_distribution capability.","x-stripeMostCommon":["preview","requested"]},"au_becs_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The au_becs_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"automatic_indirect_tax":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The automatic_indirect_tax capability.","x-stripeMostCommon":["preview","requested"]},"bacs_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bacs_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"bancontact_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bancontact_payments capability.","x-stripeMostCommon":["preview","requested"]},"bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"billie_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The billie_payments capability.","x-stripeMostCommon":["preview","requested"]},"bizum_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bizum_payments capability.","x-stripeMostCommon":["preview","requested"]},"blik_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The blik_payments capability.","x-stripeMostCommon":["preview","requested"]},"blik_recurring_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The blik_recurring_payments capability.","x-stripeMostCommon":["preview","requested"]},"boleto_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The boleto_payments capability.","x-stripeMostCommon":["preview","requested"]},"card_issuing":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The card_issuing capability.","x-stripeMostCommon":["preview","requested"]},"card_payments":{"title":"protectable_capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The card_payments capability.","x-stripeMostCommon":["preview","protections","requested"]},"cartes_bancaires_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The cartes_bancaires_payments capability.","x-stripeMostCommon":["preview","requested"]},"cashapp_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The cashapp_payments capability.","x-stripeMostCommon":["preview","requested"]},"crypto_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The crypto_payments capability.","x-stripeMostCommon":["preview","requested"]},"eps_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The eps_payments capability.","x-stripeMostCommon":["preview","requested"]},"fpx_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The fpx_payments capability.","x-stripeMostCommon":["preview","requested"]},"gb_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The gb_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"giropay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The giropay_payments capability.","x-stripeMostCommon":["preview","requested"]},"gopay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The gopay_payments capability.","x-stripeMostCommon":["preview","requested"]},"grabpay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The grabpay_payments capability.","x-stripeMostCommon":["preview","requested"]},"id_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The id_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"id_bank_transfer_payments_bca":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The id_bank_transfer_payments_bca capability.","x-stripeMostCommon":["preview","requested"]},"ideal_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The ideal_payments capability.","x-stripeMostCommon":["preview","requested"]},"india_international_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The india_international_payments capability.","x-stripeMostCommon":["preview","requested"]},"jcb_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The jcb_payments capability.","x-stripeMostCommon":["preview","requested"]},"jp_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The jp_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"kakao_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The kakao_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"klarna_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The klarna_payments capability.","x-stripeMostCommon":["preview","requested"]},"konbini_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The konbini_payments capability.","x-stripeMostCommon":["preview","requested"]},"kr_card_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The kr_card_payments capability.","x-stripeMostCommon":["preview","requested"]},"legacy_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The legacy_payments capability.","x-stripeMostCommon":["preview","requested"]},"link_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The link_payments capability.","x-stripeMostCommon":["preview","requested"]},"mb_way_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The mb_way_payments capability.","x-stripeMostCommon":["preview","requested"]},"mobilepay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The mobilepay_payments capability.","x-stripeMostCommon":["preview","requested"]},"multibanco_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The multibanco_payments capability.","x-stripeMostCommon":["preview","requested"]},"mx_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The mx_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"naver_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The naver_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"nz_bank_account_becs_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The nz_bank_account_becs_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"oxxo_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The oxxo_payments capability.","x-stripeMostCommon":["preview","requested"]},"p24_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The p24_payments capability.","x-stripeMostCommon":["preview","requested"]},"pay_by_bank_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The pay_by_bank_payments capability.","x-stripeMostCommon":["preview","requested"]},"payco_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The payco_payments capability.","x-stripeMostCommon":["preview","requested"]},"paynow_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The paynow_payments capability.","x-stripeMostCommon":["preview","requested"]},"paypal_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The paypal_payments capability.","x-stripeMostCommon":["preview","requested"]},"paypay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The paypay_payments capability.","x-stripeMostCommon":["preview","requested"]},"payto_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The payto_payments capability.","x-stripeMostCommon":["preview","requested"]},"pix_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The pix_payments capability.","x-stripeMostCommon":["preview","requested"]},"promptpay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The promptpay_payments capability.","x-stripeMostCommon":["preview","requested"]},"qris_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The qris_payments capability.","x-stripeMostCommon":["preview","requested"]},"rechnung_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The rechnung_payments capability.","x-stripeMostCommon":["preview","requested"]},"revolut_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The revolut_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"samsung_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The samsung_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"satispay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The satispay_payments capability.","x-stripeMostCommon":["preview","requested"]},"scalapay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The scalapay_payments capability.","x-stripeMostCommon":["preview","requested"]},"sepa_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sepa_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"sepa_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sepa_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"sequra_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sequra_payments capability.","x-stripeMostCommon":["preview","requested"]},"shopeepay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The shopeepay_payments capability.","x-stripeMostCommon":["preview","requested"]},"sofort_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sofort_payments capability.","x-stripeMostCommon":["preview","requested"]},"stripe_balance_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The stripe_balance_payments capability.","x-stripeMostCommon":["preview","requested"]},"sunbit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sunbit_payments capability.","x-stripeMostCommon":["preview","requested"]},"swish_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The swish_payments capability.","x-stripeMostCommon":["preview","requested"]},"tax_reporting_us_1099_k":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The tax_reporting_us_1099_k capability.","x-stripeMostCommon":["preview","requested"]},"tax_reporting_us_1099_misc":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The tax_reporting_us_1099_misc capability.","x-stripeMostCommon":["preview","requested"]},"transfers":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The transfers capability.","x-stripeMostCommon":["preview","requested"]},"treasury":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury capability.","x-stripeMostCommon":["preview","requested"]},"treasury_evolve":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury_evolve capability.","x-stripeMostCommon":["preview","requested"]},"treasury_fifth_third":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury_fifth_third capability.","x-stripeMostCommon":["preview","requested"]},"treasury_goldman_sachs":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury_goldman_sachs capability.","x-stripeMostCommon":["preview","requested"]},"twint_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The twint_payments capability.","x-stripeMostCommon":["preview","requested"]},"upi_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The upi_payments capability.","x-stripeMostCommon":["preview","requested"]},"us_bank_account_ach_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The us_bank_account_ach_payments capability.","x-stripeMostCommon":["preview","requested"]},"us_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The us_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"zip_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The zip_payments capability.","x-stripeMostCommon":["preview","requested"]}},"description":"Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.","x-stripeMostCommon":["ach_debit_payments","acss_debit_payments","affirm_payments","afterpay_clearpay_payments","agentic_facilitated_payments","agentic_payments","alipay_payments","alma_payments","amazon_pay_payments","app_distribution","apple_pay_later_payments","au_bank_transfer_payments","au_becs_debit_payments","australia_sender","automatic_indirect_tax","bacs_debit_payments","bacs_debit_stripe_sun_payments","bancontact_payments","bank_transfer_payments","beneficiary_transfers","billie_payments","bizum_payments","blik_payments","blik_recurring_payments","boleto_payments","bridge_orchestration","ca_bank_transfer_payments","capchase_pay_payments","card_issuing","card_issuing_charge_card","card_issuing_charge_card_fifth_third","card_issuing_charge_card_stripe","card_issuing_consumer","card_issuing_consumer_revolving_credit_card_celtic","card_issuing_debit_card_cross_river","card_issuing_fa_prepaid_card_cross_river","card_issuing_fa_prepaid_card_lead","card_issuing_fa_spend_card_celtic","card_issuing_fa_spend_card_stripe","card_issuing_prepaid_card_cross_river","card_issuing_prepaid_card_lead","card_issuing_spend_card_cross_river","card_payments","cartes_bancaires_payments","cash_advances","cashapp_payments","click_to_pay_payments","crypto_financial_account_recipients","crypto_financial_accounts","crypto_payments","crypto_transfers","crypto_transfers_platform","demo_onboarding","demo_pay_payments","dispute_deflection","dispute_resolution","dk_bank_transfer_payments","duitnow_payments","dummy_passthrough_card_payments","edenred_payments","eps_payments","fpx_payments","fr_meal_voucher_conecs_payments","fund_and_send","funding_credit","gb_bank_transfer_payments","gcash_payments","getbalance_payments","gift_card_payments","giropay_payments","gopay_payments","grabpay_payments","gross_settlement","id_bank_transfer_payments","id_bank_transfer_payments_bca","id_credit_transfer_payments","ideal_payments","india_international_payments","jcb_payments","jp_bank_transfer_payments","kakao_pay_payments","klarna_international_payments","klarna_payments","konbini_payments","konbini_seven_eleven_payments","kr_card_payments","kr_market_payments","kriya_payments","legacy_payments","link_payments","loans","mb_way_payments","merchant_outbound_transfers_external_account","mobilepay_payments","momo_payments","mondu_payments","money_manager_business_storage_dda_usd","money_manager_business_storage_inbound_aud","money_manager_business_storage_inbound_eur","money_manager_business_storage_inbound_eurc","money_manager_business_storage_inbound_gbp","money_manager_business_storage_inbound_usd","money_manager_business_storage_inbound_usdc","money_manager_business_storage_outbound_aud","money_manager_business_storage_outbound_eur","money_manager_business_storage_outbound_eurc","money_manager_business_storage_outbound_gbp","money_manager_business_storage_outbound_usd","money_manager_business_storage_outbound_usdc","multibanco_payments","mx_bank_transfer_payments","naver_pay_payments","netbanking_payments","ng_bank_payments","ng_bank_transfer_payments","ng_card_payments","ng_market_payments","ng_ussd_payments","ng_wallet_payments","no_bank_transfer_payments","nz_bank_account_becs_debit_payments","nz_bank_transfer_payments","octopus_payments","oxxo_payments","p24_payments","pay_by_bank_payments","payco_payments","paynow_payments","payouts","paypal_payments","paypay_payments","payto_payments","pix_payments","promptpay_payments","qris_payments","rechnung_payments","revolut_pay_payments","samsung_pay_payments","satispay_payments","scalapay_payments","sepa_bank_transfer_payments","sepa_debit_payments","sequra_payments","shop_pay_payments","shopeepay_payments","skip_the_dishes","sofort_payments","south_korea_market_payments","stablecoin_custodial","steam_marketplace","storer_financial_addresses_bank_accounts","storer_holds_currencies_eur","storer_holds_currencies_eurc","storer_holds_currencies_gbp","storer_holds_currencies_usd","storer_holds_currencies_usdc","stripe_balance_payments","stripe_funded_fee_credits","submerchant_payments","sunbit_payments","swish_payments","tamara_payments","tax_reporting_us_1099_k","tax_reporting_us_1099_misc","touch_n_go_payments","transfers","treasury","treasury_evolve","treasury_fifth_third","treasury_goldman_sachs","tripadvisor_supplier","truemoney_payments","twint_payments","upi_payments","us_bank_account_ach_payments","us_bank_transfer_payments","us_cash_voucher_transfers","us_paper_check_payments","vipps_payments","wechat_pay_payments","wero_payments","zip_payments"]},"company":{"title":"company_specs","type":"object","properties":{"address":{"title":"legal_entity_and_kyc_address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The company's primary address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"address_kana":{"title":"japan_address_kana_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kana variation of the company's primary address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"address_kanji":{"title":"japan_address_kanji_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kanji variation of the company's primary address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"administrative_address":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The location where the business is administered.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"directors_provided":{"type":"boolean","description":"Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided."},"directorship_declaration":{"title":"company_directorship_declaration","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the directorship declaration attestation was made.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the directorship declaration attestation was made."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the directorship declaration attestation was made."}},"description":"This hash is used to attest that the directors information provided to Stripe is both current and correct.","x-stripeMostCommon":["date","ip","user_agent"]},"executives_provided":{"type":"boolean","description":"Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement."},"export_license_id":{"maxLength":5000,"type":"string","description":"The export license ID number of the company, also referred as Import Export Code (India only)."},"export_purpose_code":{"maxLength":5000,"type":"string","description":"The purpose code to use for export transactions (India only)."},"name":{"maxLength":200,"type":"string","description":"The company's legal name."},"name_kana":{"maxLength":200,"type":"string","description":"The Kana variation of the company's legal name (Japan only)."},"name_kanji":{"maxLength":200,"type":"string","description":"The Kanji variation of the company's legal name (Japan only)."},"owners_provided":{"type":"boolean","description":"Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement."},"ownership_declaration":{"title":"company_ownership_declaration","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the beneficial owner attestation was made.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the beneficial owner attestation was made."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the beneficial owner attestation was made."}},"description":"This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.","x-stripeMostCommon":["date","ip","user_agent"]},"ownership_exemption_reason":{"type":"string","description":"This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.","enum":["","qualified_entity_exceeds_ownership_threshold","qualifies_as_financial_institution"]},"phone":{"maxLength":5000,"type":"string","description":"The company's phone number (used for verification)."},"principal_place_of_business":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The primary location where the business conducts operations.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"registration_date":{"description":"When the business was incorporated or registered.","anyOf":[{"title":"registration_date_specs","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of registration, between 1 and 31."},"month":{"type":"integer","description":"The month of registration, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of registration."}},"x-stripeMostCommon":["day","month","year"]},{"type":"string","enum":[""]}]},"registration_number":{"maxLength":5000,"type":"string","description":"The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong)."},"representative_declaration":{"title":"company_representative_declaration","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the representative declaration attestation was made.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the representative declaration attestation was made."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the representative declaration attestation was made."}},"description":"This hash is used to attest that the representative is authorized to act as the representative of their legal entity.","x-stripeMostCommon":["date","ip","user_agent"]},"structure":{"type":"string","description":"The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.","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"],"x-stripeBypassValidation":true},"tax_id":{"maxLength":5000,"type":"string","description":"The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)\n\nChanging this value requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"tax_id_registrar":{"maxLength":5000,"type":"string","description":"The jurisdiction in which the `tax_id` is registered (Germany-based companies only)."},"vat_id":{"maxLength":5000,"type":"string","description":"The VAT number of the company."},"verification":{"title":"verification_specs","type":"object","properties":{"document":{"title":"verification_document_specs","type":"object","properties":{"back":{"maxLength":500,"type":"string","description":"The back of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."},"front":{"maxLength":500,"type":"string","description":"The front of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."}},"description":"A document verifying the business.","x-stripeMostCommon":["back","front"]}},"description":"Information on the verification state of the company.","x-stripeMostCommon":["document"]}},"description":"Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.","x-stripeMostCommon":["address","address_kana","address_kanji","administrative_address","contact_point_verification_address","cross_border_transaction_classifications","directors_provided","directorship_declaration","executives_provided","export_license_id","export_purpose_code","fiscal_code","invoicing_recipient_code","name","name_kana","name_kanji","owners_provided","ownership_declaration","ownership_exemption_reason","pan","phone","physical_address","principal_place_of_business","registered_email","registration_date","registration_number","representative_declaration","stock_data","structure","tax_deduction_account_number","tax_id","tax_id_registrar","trust_owned","vat_id","vat_registration_status","verification"]},"controller":{"title":"controller_specs","type":"object","properties":{"application":{"title":"controller_application_specs","required":["loss_liable"],"type":"object","properties":{"loss_liable":{"type":"boolean","description":"Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances)."},"onboarding_owner":{"type":"boolean","description":"Whether the controller owns onboarding for this account."},"pricing_controls":{"type":"boolean","description":"Whether the controller has pricing controls for this account."}},"description":"A hash of configuration describing the Connect application that controls the account.","x-stripeMostCommon":["loss_liable","onboarding_owner","pricing_controls"]},"dashboard":{"title":"controller_dashboard_specs","type":"object","properties":{"type":{"type":"string","description":"Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.","enum":["express","full","none"]}},"description":"Properties of the account's dashboard.","x-stripeMostCommon":["type"]},"fees":{"title":"controller_fees_specs","type":"object","properties":{"payer":{"type":"string","description":"A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).","enum":["account","application"]}},"description":"A hash of configuration for who pays Stripe fees for product usage on this account.","x-stripeMostCommon":["payer"]},"losses":{"title":"controller_losses_specs","type":"object","properties":{"payments":{"type":"string","description":"A value indicating who is liable when this account can't pay back negative balances resulting from payments. Defaults to `stripe`.","enum":["application","stripe"]}},"description":"A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.","x-stripeMostCommon":["payments"]},"requirement_collection":{"type":"string","description":"A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.","enum":["application","stripe"]},"stripe_dashboard":{"title":"controller_dashboard_specs","type":"object","properties":{"type":{"type":"string","description":"Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.","enum":["express","full","none"]}},"description":"A hash of configuration for Stripe-hosted dashboards.","x-stripeMostCommon":["type"]}},"description":"A hash of configuration describing the account controller's attributes.","x-stripeMostCommon":["application","dashboard","fees","losses","requirement_collection","stripe_dashboard"]},"country":{"maxLength":5000,"type":"string","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."},"default_currency":{"type":"string","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).","format":"currency"},"documents":{"title":"documents_specs","type":"object","properties":{"bank_account_ownership_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.","x-stripeMostCommon":["files"]},"company_license":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of a company's license to operate.","x-stripeMostCommon":["files"]},"company_memorandum_of_association":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents showing the company's governing document (for example, a memorandum of association, constitution, or articles of association).","x-stripeMostCommon":["files"]},"company_ministerial_decree":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.","x-stripeMostCommon":["files"]},"company_registration_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.","x-stripeMostCommon":["files"]},"company_tax_id_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of a company's tax ID.","x-stripeMostCommon":["files"]},"proof_of_address":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of address.","x-stripeMostCommon":["files"]},"proof_of_ultimate_beneficial_ownership":{"title":"signer_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}},"signer":{"title":"signer_name_param","type":"object","properties":{"person":{"maxLength":5000,"type":"string","description":"The token of the person signing the document, if applicable."}},"description":"Information regarding the person signing the document if applicable.","x-stripeMostCommon":["person"]}},"description":"One or more documents that demonstrate proof of ultimate beneficial ownership.","x-stripeMostCommon":["files","signer"]}},"description":"Documents that may be submitted to satisfy various informational requests.","x-stripeMostCommon":["articles_of_association","bank_account_ownership_verification","company_address_verification","company_license","company_memorandum_of_association","company_ministerial_decree","company_registration_verification","company_tax_id_verification","company_vat_id_verification","proof_of_address","proof_of_annual_turnover","proof_of_business_activity","proof_of_business_activity_additional","proof_of_business_presence","proof_of_partnership_deed","proof_of_ultimate_beneficial_ownership"]},"email":{"type":"string","description":"The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"external_account":{"maxLength":5000,"type":"string","description":"A card or bank account to attach to the account for receiving [payouts](/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](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.Retrieves the details of an account.
","operationId":"GetAccountsAccount","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_account"},"post":{"summary":"Update an account","description":"Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.
\n\nFor accounts where controller.requirement_collection\nis application, which includes Custom accounts, you can update any information on the account.
For accounts where controller.requirement_collection\nis stripe, which includes Standard and Express accounts, you can update all information until you create\nan Account Link or Account Session to start Connect onboarding,\nafter which some properties can no longer be updated.
To update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.
","operationId":"PostAccountsAccount","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"account_token":{"maxLength":5000,"type":"string","description":"An [account token](https://docs.stripe.com/api#create_account_token), used to securely provide details to the account."},"business_profile":{"title":"business_profile_update_specs","type":"object","properties":{"annual_revenue":{"title":"annual_revenue_specs","required":["amount","currency","fiscal_year_end"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal)."},"currency":{"type":"string","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).","format":"currency"},"fiscal_year_end":{"maxLength":5000,"type":"string","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."}},"description":"The applicant's gross annual revenue for its preceding fiscal year.","x-stripeMostCommon":["amount","currency","fiscal_year_end"]},"estimated_worker_count":{"type":"integer","description":"An estimated upper bound of employees, contractors, vendors, etc. currently working for the business."},"mcc":{"maxLength":4,"type":"string","description":"[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide."},"minority_owned_business_designation":{"type":"array","description":"Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.","items":{"type":"string","enum":["lgbtqi_owned_business","minority_owned_business","none_of_these_apply","prefer_not_to_answer","women_owned_business"]}},"monthly_estimated_revenue":{"title":"monthly_estimated_revenue_specs","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal)."},"currency":{"type":"string","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).","format":"currency"}},"description":"An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.","x-stripeMostCommon":["amount","currency"]},"name":{"maxLength":5000,"type":"string","description":"The customer-facing business name."},"product_description":{"maxLength":40000,"type":"string","description":"Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes."},"specified_commercial_transactions_act_url":{"description":"A link to the business's publicly available terms related to the Specified Commercial Transaction Act. Only used for accounts in Japan.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"support_address":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"A publicly available mailing address for sending support issues to.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"support_email":{"type":"string","description":"A publicly available email address for sending support issues to."},"support_phone":{"maxLength":5000,"type":"string","description":"A publicly available phone number to call with support issues."},"support_url":{"description":"A publicly available website for handling support issues.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"url":{"type":"string","description":"The business's publicly available website."}},"description":"Business information about the account.","x-stripeMostCommon":["annual_revenue","customer_regions","estimated_worker_count","funding_source","industry","mcc","minority_owned_business_designation","monthly_estimated_revenue","name","payment_collection_methods","privacy_policy_url","product_description","singapore_account_activity_survey","specified_commercial_transactions_act_url","support_address","support_email","support_phone","support_url","terms_of_service_url","url","url_opt_out_reason"]},"business_type":{"type":"string","description":"The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.","enum":["company","government_entity","individual","non_profit"],"x-stripeBypassValidation":true},"capabilities":{"title":"capabilities_param","type":"object","properties":{"acss_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The acss_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"affirm_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The affirm_payments capability.","x-stripeMostCommon":["preview","requested"]},"afterpay_clearpay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The afterpay_clearpay_payments capability.","x-stripeMostCommon":["preview","requested"]},"alma_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The alma_payments capability.","x-stripeMostCommon":["preview","requested"]},"amazon_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The amazon_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"app_distribution":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The app_distribution capability.","x-stripeMostCommon":["preview","requested"]},"au_becs_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The au_becs_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"automatic_indirect_tax":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The automatic_indirect_tax capability.","x-stripeMostCommon":["preview","requested"]},"bacs_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bacs_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"bancontact_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bancontact_payments capability.","x-stripeMostCommon":["preview","requested"]},"bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"billie_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The billie_payments capability.","x-stripeMostCommon":["preview","requested"]},"bizum_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The bizum_payments capability.","x-stripeMostCommon":["preview","requested"]},"blik_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The blik_payments capability.","x-stripeMostCommon":["preview","requested"]},"blik_recurring_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The blik_recurring_payments capability.","x-stripeMostCommon":["preview","requested"]},"boleto_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The boleto_payments capability.","x-stripeMostCommon":["preview","requested"]},"card_issuing":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The card_issuing capability.","x-stripeMostCommon":["preview","requested"]},"card_payments":{"title":"protectable_capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The card_payments capability.","x-stripeMostCommon":["preview","protections","requested"]},"cartes_bancaires_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The cartes_bancaires_payments capability.","x-stripeMostCommon":["preview","requested"]},"cashapp_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The cashapp_payments capability.","x-stripeMostCommon":["preview","requested"]},"crypto_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The crypto_payments capability.","x-stripeMostCommon":["preview","requested"]},"eps_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The eps_payments capability.","x-stripeMostCommon":["preview","requested"]},"fpx_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The fpx_payments capability.","x-stripeMostCommon":["preview","requested"]},"gb_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The gb_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"giropay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The giropay_payments capability.","x-stripeMostCommon":["preview","requested"]},"gopay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The gopay_payments capability.","x-stripeMostCommon":["preview","requested"]},"grabpay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The grabpay_payments capability.","x-stripeMostCommon":["preview","requested"]},"id_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The id_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"id_bank_transfer_payments_bca":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The id_bank_transfer_payments_bca capability.","x-stripeMostCommon":["preview","requested"]},"ideal_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The ideal_payments capability.","x-stripeMostCommon":["preview","requested"]},"india_international_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The india_international_payments capability.","x-stripeMostCommon":["preview","requested"]},"jcb_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The jcb_payments capability.","x-stripeMostCommon":["preview","requested"]},"jp_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The jp_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"kakao_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The kakao_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"klarna_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The klarna_payments capability.","x-stripeMostCommon":["preview","requested"]},"konbini_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The konbini_payments capability.","x-stripeMostCommon":["preview","requested"]},"kr_card_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The kr_card_payments capability.","x-stripeMostCommon":["preview","requested"]},"legacy_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The legacy_payments capability.","x-stripeMostCommon":["preview","requested"]},"link_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The link_payments capability.","x-stripeMostCommon":["preview","requested"]},"mb_way_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The mb_way_payments capability.","x-stripeMostCommon":["preview","requested"]},"mobilepay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The mobilepay_payments capability.","x-stripeMostCommon":["preview","requested"]},"multibanco_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The multibanco_payments capability.","x-stripeMostCommon":["preview","requested"]},"mx_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The mx_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"naver_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The naver_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"nz_bank_account_becs_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The nz_bank_account_becs_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"oxxo_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The oxxo_payments capability.","x-stripeMostCommon":["preview","requested"]},"p24_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The p24_payments capability.","x-stripeMostCommon":["preview","requested"]},"pay_by_bank_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The pay_by_bank_payments capability.","x-stripeMostCommon":["preview","requested"]},"payco_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The payco_payments capability.","x-stripeMostCommon":["preview","requested"]},"paynow_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The paynow_payments capability.","x-stripeMostCommon":["preview","requested"]},"paypal_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The paypal_payments capability.","x-stripeMostCommon":["preview","requested"]},"paypay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The paypay_payments capability.","x-stripeMostCommon":["preview","requested"]},"payto_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The payto_payments capability.","x-stripeMostCommon":["preview","requested"]},"pix_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The pix_payments capability.","x-stripeMostCommon":["preview","requested"]},"promptpay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The promptpay_payments capability.","x-stripeMostCommon":["preview","requested"]},"qris_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The qris_payments capability.","x-stripeMostCommon":["preview","requested"]},"rechnung_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The rechnung_payments capability.","x-stripeMostCommon":["preview","requested"]},"revolut_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The revolut_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"samsung_pay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The samsung_pay_payments capability.","x-stripeMostCommon":["preview","requested"]},"satispay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The satispay_payments capability.","x-stripeMostCommon":["preview","requested"]},"scalapay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The scalapay_payments capability.","x-stripeMostCommon":["preview","requested"]},"sepa_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sepa_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"sepa_debit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sepa_debit_payments capability.","x-stripeMostCommon":["preview","requested"]},"sequra_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sequra_payments capability.","x-stripeMostCommon":["preview","requested"]},"shopeepay_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The shopeepay_payments capability.","x-stripeMostCommon":["preview","requested"]},"sofort_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sofort_payments capability.","x-stripeMostCommon":["preview","requested"]},"stripe_balance_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The stripe_balance_payments capability.","x-stripeMostCommon":["preview","requested"]},"sunbit_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The sunbit_payments capability.","x-stripeMostCommon":["preview","requested"]},"swish_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The swish_payments capability.","x-stripeMostCommon":["preview","requested"]},"tax_reporting_us_1099_k":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The tax_reporting_us_1099_k capability.","x-stripeMostCommon":["preview","requested"]},"tax_reporting_us_1099_misc":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The tax_reporting_us_1099_misc capability.","x-stripeMostCommon":["preview","requested"]},"transfers":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The transfers capability.","x-stripeMostCommon":["preview","requested"]},"treasury":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury capability.","x-stripeMostCommon":["preview","requested"]},"treasury_evolve":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury_evolve capability.","x-stripeMostCommon":["preview","requested"]},"treasury_fifth_third":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury_fifth_third capability.","x-stripeMostCommon":["preview","requested"]},"treasury_goldman_sachs":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The treasury_goldman_sachs capability.","x-stripeMostCommon":["preview","requested"]},"twint_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The twint_payments capability.","x-stripeMostCommon":["preview","requested"]},"upi_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The upi_payments capability.","x-stripeMostCommon":["preview","requested"]},"us_bank_account_ach_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The us_bank_account_ach_payments capability.","x-stripeMostCommon":["preview","requested"]},"us_bank_transfer_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The us_bank_transfer_payments capability.","x-stripeMostCommon":["preview","requested"]},"zip_payments":{"title":"capability_param","type":"object","properties":{"requested":{"type":"boolean","description":"Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays."}},"description":"The zip_payments capability.","x-stripeMostCommon":["preview","requested"]}},"description":"Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.","x-stripeMostCommon":["ach_debit_payments","acss_debit_payments","affirm_payments","afterpay_clearpay_payments","agentic_facilitated_payments","agentic_payments","alipay_payments","alma_payments","amazon_pay_payments","app_distribution","apple_pay_later_payments","au_bank_transfer_payments","au_becs_debit_payments","australia_sender","automatic_indirect_tax","bacs_debit_payments","bacs_debit_stripe_sun_payments","bancontact_payments","bank_transfer_payments","beneficiary_transfers","billie_payments","bizum_payments","blik_payments","blik_recurring_payments","boleto_payments","bridge_orchestration","ca_bank_transfer_payments","capchase_pay_payments","card_issuing","card_issuing_charge_card","card_issuing_charge_card_fifth_third","card_issuing_charge_card_stripe","card_issuing_consumer","card_issuing_consumer_revolving_credit_card_celtic","card_issuing_debit_card_cross_river","card_issuing_fa_prepaid_card_cross_river","card_issuing_fa_prepaid_card_lead","card_issuing_fa_spend_card_celtic","card_issuing_fa_spend_card_stripe","card_issuing_prepaid_card_cross_river","card_issuing_prepaid_card_lead","card_issuing_spend_card_cross_river","card_payments","cartes_bancaires_payments","cash_advances","cashapp_payments","click_to_pay_payments","crypto_financial_account_recipients","crypto_financial_accounts","crypto_payments","crypto_transfers","crypto_transfers_platform","demo_onboarding","demo_pay_payments","dispute_deflection","dispute_resolution","dk_bank_transfer_payments","duitnow_payments","dummy_passthrough_card_payments","edenred_payments","eps_payments","fpx_payments","fr_meal_voucher_conecs_payments","fund_and_send","funding_credit","gb_bank_transfer_payments","gcash_payments","getbalance_payments","gift_card_payments","giropay_payments","gopay_payments","grabpay_payments","gross_settlement","id_bank_transfer_payments","id_bank_transfer_payments_bca","id_credit_transfer_payments","ideal_payments","india_international_payments","jcb_payments","jp_bank_transfer_payments","kakao_pay_payments","klarna_international_payments","klarna_payments","konbini_payments","konbini_seven_eleven_payments","kr_card_payments","kr_market_payments","kriya_payments","legacy_payments","link_payments","loans","mb_way_payments","merchant_outbound_transfers_external_account","mobilepay_payments","momo_payments","mondu_payments","money_manager_business_storage_dda_usd","money_manager_business_storage_inbound_aud","money_manager_business_storage_inbound_eur","money_manager_business_storage_inbound_eurc","money_manager_business_storage_inbound_gbp","money_manager_business_storage_inbound_usd","money_manager_business_storage_inbound_usdc","money_manager_business_storage_outbound_aud","money_manager_business_storage_outbound_eur","money_manager_business_storage_outbound_eurc","money_manager_business_storage_outbound_gbp","money_manager_business_storage_outbound_usd","money_manager_business_storage_outbound_usdc","multibanco_payments","mx_bank_transfer_payments","naver_pay_payments","netbanking_payments","ng_bank_payments","ng_bank_transfer_payments","ng_card_payments","ng_market_payments","ng_ussd_payments","ng_wallet_payments","no_bank_transfer_payments","nz_bank_account_becs_debit_payments","nz_bank_transfer_payments","octopus_payments","oxxo_payments","p24_payments","pay_by_bank_payments","payco_payments","paynow_payments","payouts","paypal_payments","paypay_payments","payto_payments","pix_payments","promptpay_payments","qris_payments","rechnung_payments","revolut_pay_payments","samsung_pay_payments","satispay_payments","scalapay_payments","sepa_bank_transfer_payments","sepa_debit_payments","sequra_payments","shop_pay_payments","shopeepay_payments","skip_the_dishes","sofort_payments","south_korea_market_payments","stablecoin_custodial","steam_marketplace","storer_financial_addresses_bank_accounts","storer_holds_currencies_eur","storer_holds_currencies_eurc","storer_holds_currencies_gbp","storer_holds_currencies_usd","storer_holds_currencies_usdc","stripe_balance_payments","stripe_funded_fee_credits","submerchant_payments","sunbit_payments","swish_payments","tamara_payments","tax_reporting_us_1099_k","tax_reporting_us_1099_misc","touch_n_go_payments","transfers","treasury","treasury_evolve","treasury_fifth_third","treasury_goldman_sachs","tripadvisor_supplier","truemoney_payments","twint_payments","upi_payments","us_bank_account_ach_payments","us_bank_transfer_payments","us_cash_voucher_transfers","us_paper_check_payments","vipps_payments","wechat_pay_payments","wero_payments","zip_payments"]},"company":{"title":"company_update_specs","type":"object","properties":{"address":{"title":"legal_entity_and_kyc_address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The company's primary address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"address_kana":{"title":"japan_address_kana_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kana variation of the company's primary address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"address_kanji":{"title":"japan_address_kanji_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kanji variation of the company's primary address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"administrative_address":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The location where the business is administered.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"directors_provided":{"type":"boolean","description":"Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided."},"directorship_declaration":{"title":"company_directorship_declaration","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the directorship declaration attestation was made.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the directorship declaration attestation was made."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the directorship declaration attestation was made."}},"description":"This hash is used to attest that the directors information provided to Stripe is both current and correct.","x-stripeMostCommon":["date","ip","user_agent"]},"executives_provided":{"type":"boolean","description":"Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](/api/persons) for accounts with a `relationship.executive` requirement."},"export_license_id":{"maxLength":5000,"type":"string","description":"The export license ID number of the company, also referred as Import Export Code (India only)."},"export_purpose_code":{"maxLength":5000,"type":"string","description":"The purpose code to use for export transactions (India only)."},"name":{"maxLength":200,"type":"string","description":"The company's legal name."},"name_kana":{"maxLength":200,"type":"string","description":"The Kana variation of the company's legal name (Japan only)."},"name_kanji":{"maxLength":200,"type":"string","description":"The Kanji variation of the company's legal name (Japan only)."},"owners_provided":{"type":"boolean","description":"Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](/api/persons) for accounts with a `relationship.owner` requirement."},"ownership_declaration":{"title":"company_ownership_declaration","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the beneficial owner attestation was made.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the beneficial owner attestation was made."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the beneficial owner attestation was made."}},"description":"This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.","x-stripeMostCommon":["date","ip","user_agent"]},"ownership_exemption_reason":{"type":"string","description":"This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.","enum":["","qualified_entity_exceeds_ownership_threshold","qualifies_as_financial_institution"]},"phone":{"maxLength":5000,"type":"string","description":"The company's phone number (used for verification)."},"principal_place_of_business":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The primary location where the business conducts operations.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"registration_date":{"anyOf":[{"title":"registration_date_specs","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of registration, between 1 and 31."},"month":{"type":"integer","description":"The month of registration, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of registration."}},"x-stripeMostCommon":["day","month","year"]},{"type":"string","enum":[""]}]},"registration_number":{"maxLength":5000,"type":"string","description":"The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong)."},"representative_declaration":{"title":"company_representative_declaration","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the representative declaration attestation was made.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the representative declaration attestation was made."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the representative declaration attestation was made."}},"description":"This hash is used to attest that the representative is authorized to act as the representative of their legal entity.","x-stripeMostCommon":["date","ip","user_agent"]},"structure":{"type":"string","description":"The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.","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"],"x-stripeBypassValidation":true},"tax_id":{"maxLength":5000,"type":"string","description":"The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)\n\nChanging this value requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"tax_id_registrar":{"maxLength":5000,"type":"string","description":"The jurisdiction in which the `tax_id` is registered (Germany-based companies only)."},"vat_id":{"maxLength":5000,"type":"string","description":"The VAT number of the company."},"verification":{"title":"verification_specs","type":"object","properties":{"document":{"title":"verification_document_specs","type":"object","properties":{"back":{"maxLength":500,"type":"string","description":"The back of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."},"front":{"maxLength":500,"type":"string","description":"The front of a document returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."}},"description":"A document verifying the business.","x-stripeMostCommon":["back","front"]}},"description":"Information on the verification state of the company.","x-stripeMostCommon":["document"]}},"description":"Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.","x-stripeMostCommon":["address","address_kana","address_kanji","administrative_address","contact_point_verification_address","cross_border_transaction_classifications","directors_provided","directorship_declaration","executives_provided","export_license_id","export_purpose_code","fiscal_code","invoicing_recipient_code","name","name_kana","name_kanji","owners_provided","ownership_declaration","ownership_exemption_reason","pan","phone","physical_address","principal_place_of_business","registered_email","registration_date","registration_number","representative_declaration","stock_data","structure","tax_deduction_account_number","tax_id","tax_id_registrar","trust_owned","vat_id","vat_registration_status","verification"]},"default_currency":{"type":"string","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).","format":"currency"},"documents":{"title":"documents_specs_update","type":"object","properties":{"bank_account_ownership_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a check.","x-stripeMostCommon":["files"]},"company_license":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of a company's license to operate.","x-stripeMostCommon":["files"]},"company_memorandum_of_association":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents showing the company's governing document (for example, a memorandum of association, constitution, or articles of association).","x-stripeMostCommon":["files"]},"company_ministerial_decree":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.","x-stripeMostCommon":["files"]},"company_registration_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.","x-stripeMostCommon":["files"]},"company_tax_id_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of a company's tax ID.","x-stripeMostCommon":["files"]},"proof_of_address":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that demonstrate proof of address.","x-stripeMostCommon":["files"]},"proof_of_registration":{"title":"signer_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}},"signer":{"title":"signer_name_param","type":"object","properties":{"person":{"maxLength":5000,"type":"string","description":"The token of the person signing the document, if applicable."}},"description":"Information regarding the person signing the document if applicable.","x-stripeMostCommon":["person"]}},"description":"One or more documents showing the company’s proof of registration with the national business registry.","x-stripeMostCommon":["files","signer"]},"proof_of_ultimate_beneficial_ownership":{"title":"signer_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}},"signer":{"title":"signer_name_param","type":"object","properties":{"person":{"maxLength":5000,"type":"string","description":"The token of the person signing the document, if applicable."}},"description":"Information regarding the person signing the document if applicable.","x-stripeMostCommon":["person"]}},"description":"One or more documents that demonstrate proof of ultimate beneficial ownership.","x-stripeMostCommon":["files","signer"]}},"description":"Documents that may be submitted to satisfy various informational requests.","x-stripeMostCommon":["articles_of_association","bank_account_ownership_verification","company_address_verification","company_license","company_memorandum_of_association","company_ministerial_decree","company_registration_verification","company_tax_id_verification","company_vat_id_verification","proof_of_address","proof_of_annual_turnover","proof_of_business_activity","proof_of_business_activity_additional","proof_of_business_presence","proof_of_partnership_deed","proof_of_registration","proof_of_ultimate_beneficial_ownership"]},"email":{"type":"string","description":"The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"external_account":{"maxLength":5000,"type":"string","description":"A card or bank account to attach to the account for receiving [payouts](/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](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.With Connect, you can delete accounts you manage.
\n\nTest-mode accounts can be deleted at any time.
\n\nLive-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero.
\n\nIf you want to delete your own account, use the account information tab in your account settings instead.
","operationId":"DeleteAccountsAccount","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_connect_account"}},"/v1/accounts/{account}/capabilities":{"get":{"summary":"List all account capabilities","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":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ListAccountCapability","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/capability"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_account_capabilities"}},"/v1/accounts/{account}/capabilities/{capability}":{"get":{"summary":"Retrieve an Account Capability","description":"Retrieves information about the specified Account Capability.
","operationId":"GetAccountsAccountCapabilitiesCapability","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"capability","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/capability"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_account_capability"},"post":{"summary":"Update an Account Capability","description":"Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
List external accounts for an account.
","operationId":"GetAccountsAccountExternalAccounts","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"object","in":"query","description":"Filter external accounts according to a particular object type.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string","enum":["bank_account","card"],"x-stripeBypassValidation":true,"x-stripeParam":{"class_name":"object_type"}},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ExternalAccountList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.","items":{"$ref":"#/components/schemas/external_account"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_external_accounts"},"post":{"summary":"Create an external account","description":"Create an external account for a given account.
","operationId":"PostAccountsAccountExternalAccounts","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["external_account"],"type":"object","properties":{"default_for_currency":{"type":"boolean","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"external_account":{"maxLength":5000,"type":"string","description":"A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead.","x-stripeBypassValidation":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."}},"additionalProperties":false,"x-stripeMostCommon":["external_account","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_external_account"}},"/v1/accounts/{account}/external_accounts/{id}":{"get":{"summary":"Retrieve an external account","description":"Retrieve a specified external account for a given account.
","operationId":"GetAccountsAccountExternalAccountsId","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"Unique identifier for the external account to be retrieved.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_external_account"},"post":{"summary":"Update a bank account","description":"Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.
\n\nYou can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.
You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.
","operationId":"PostAccountsAccountExternalAccountsId","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name of the person or business that owns the bank account."},"account_holder_type":{"maxLength":5000,"type":"string","description":"The type of entity that holds the account. This can be either `individual` or `company`.","enum":["","company","individual"]},"account_type":{"maxLength":5000,"type":"string","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"]},"address_city":{"maxLength":5000,"type":"string","description":"City/District/Suburb/Town/Village."},"address_country":{"maxLength":5000,"type":"string","description":"Billing address country, if provided when creating card."},"address_line1":{"maxLength":5000,"type":"string","description":"Address line 1 (Street address/PO Box/Company name)."},"address_line2":{"maxLength":5000,"type":"string","description":"Address line 2 (Apartment/Suite/Unit/Building)."},"address_state":{"maxLength":5000,"type":"string","description":"State/County/Province/Region."},"address_zip":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"default_for_currency":{"type":"boolean","description":"When set to true, this becomes the default external account for its currency."},"documents":{"title":"external_account_documents_param","type":"object","properties":{"bank_account_ownership_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.","x-stripeMostCommon":["files"]}},"description":"Documents that may be submitted to satisfy various informational requests.","x-stripeMostCommon":["bank_account_ownership_verification"]},"exp_month":{"maxLength":5000,"type":"string","description":"Two digit number representing the card’s expiration month."},"exp_year":{"maxLength":5000,"type":"string","description":"Four digit number representing the card’s expiration year."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":5000,"type":"string","description":"Cardholder name."}},"additionalProperties":false,"x-stripeMostCommon":["default_for_currency","metadata"]},"encoding":{"documents":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_external_account,update_connect_external_account_card"},"delete":{"summary":"Delete an external account","description":"Delete a specified external account for a given account.
","operationId":"DeleteAccountsAccountExternalAccountsId","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"Unique identifier for the external account to be deleted.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_connect_external_account"}},"/v1/accounts/{account}/login_links":{"post":{"summary":"Create a login link","description":"Creates a login link for a connected account to access the Express Dashboard.
\n\nYou can only create login links for accounts that use the Express Dashboard and are connected to your platform.
","operationId":"PostAccountsAccountLoginLinks","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/login_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_login_link"}},"/v1/accounts/{account}/persons":{"get":{"summary":"List all persons","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":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"relationship","in":"query","description":"Filters on the list of people returned based on the person's relationship to the account's company.","required":false,"style":"deepObject","explode":true,"schema":{"title":"all_people_relationship_specs","type":"object","properties":{"authorizer":{"type":"boolean","description":"A filter on the list of people returned based on whether these people are authorizers of the account's representative."},"director":{"type":"boolean","description":"A filter on the list of people returned based on whether these people are directors of the account's company."},"executive":{"type":"boolean","description":"A filter on the list of people returned based on whether these people are executives of the account's company."},"legal_guardian":{"type":"boolean","description":"A filter on the list of people returned based on whether these people are legal guardians of the account's representative."},"owner":{"type":"boolean","description":"A filter on the list of people returned based on whether these people are owners of the account's company."},"representative":{"type":"boolean","description":"A filter on the list of people returned based on whether these people are the representative of the account's company."}},"x-stripeMostCommon":["authorizer","director","executive","legal_guardian","officer","owner","partner","representative"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PersonList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/person"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_people"},"post":{"summary":"Create a person","description":"Creates a new person.
","operationId":"PostAccountsAccountPersons","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"additional_tos_acceptances":{"title":"person_additional_tos_acceptances_specs","type":"object","properties":{"account":{"title":"settings_terms_of_service_specs","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the account representative accepted the service agreement.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the account representative accepted the service agreement."},"user_agent":{"description":"The user agent of the browser from which the account representative accepted the service agreement.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Details on the legal guardian's acceptance of the main Stripe service agreement.","x-stripeMostCommon":["date","ip","user_agent"]}},"description":"Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.","x-stripeMostCommon":["account","representative"]},"address":{"title":"legal_entity_and_kyc_address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The person's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"address_kana":{"title":"japan_address_kana_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kana variation of the person's address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"address_kanji":{"title":"japan_address_kanji_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kanji variation of the person's address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"dob":{"description":"The person's date of birth.","anyOf":[{"title":"date_of_birth_specs","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"x-stripeMostCommon":["day","month","year"]},{"type":"string","enum":[""]}]},"documents":{"title":"person_documents_specs","type":"object","properties":{"company_authorization":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]}}},"description":"One or more documents that demonstrate proof that this person is authorized to represent the company.","x-stripeMostCommon":["files"]},"passport":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]}}},"description":"One or more documents showing the person's passport page with photo and personal data.","x-stripeMostCommon":["files"]},"visa":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]}}},"description":"One or more documents showing the person's visa required for living in the country where they are residing.","x-stripeMostCommon":["files"]}},"description":"Documents that may be submitted to satisfy various informational requests.","x-stripeMostCommon":["DASHBOARD_proof_of_liveness","company_authorization","passport","visa"]},"email":{"type":"string","description":"The person's email address."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"first_name":{"maxLength":5000,"type":"string","description":"The person's first name."},"first_name_kana":{"maxLength":5000,"type":"string","description":"The Kana variation of the person's first name (Japan only)."},"first_name_kanji":{"maxLength":5000,"type":"string","description":"The Kanji variation of the person's first name (Japan only)."},"full_name_aliases":{"description":"A list of alternate names or aliases that the person is known by.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"gender":{"type":"string","description":"The person's gender (International regulations require either \"male\" or \"female\")."},"id_number":{"maxLength":5000,"type":"string","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).\n\nChanging this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"id_number_secondary":{"maxLength":5000,"type":"string","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).\n\nChanging this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"last_name":{"maxLength":5000,"type":"string","description":"The person's last name."},"last_name_kana":{"maxLength":5000,"type":"string","description":"The Kana variation of the person's last name (Japan only)."},"last_name_kanji":{"maxLength":5000,"type":"string","description":"The Kanji variation of the person's last name (Japan only)."},"maiden_name":{"maxLength":5000,"type":"string","description":"The person's maiden name."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"nationality":{"maxLength":5000,"type":"string","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."},"person_token":{"maxLength":5000,"type":"string","description":"A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person."},"phone":{"type":"string","description":"The person's phone number."},"political_exposure":{"type":"string","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"]},"registered_address":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The person's registered address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"relationship":{"title":"relationship_specs","type":"object","properties":{"authorizer":{"type":"boolean","description":"Whether the person is the authorizer of the account's representative."},"director":{"type":"boolean","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."},"executive":{"type":"boolean","description":"Whether the person has significant responsibility to control, manage, or direct the organization."},"legal_guardian":{"type":"boolean","description":"Whether the person is the legal guardian of the account's representative."},"owner":{"type":"boolean","description":"Whether the person is an owner of the account’s legal entity."},"percent_ownership":{"description":"The percent owned by the person of the account's legal entity.","anyOf":[{"type":"number"},{"type":"string","enum":[""]}]},"representative":{"type":"boolean","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."},"title":{"maxLength":5000,"type":"string","description":"The person's title (e.g., CEO, Support Engineer)."}},"description":"The relationship that this person has with the account's legal entity.","x-stripeMostCommon":["authorizer","controller","director","executive","legal_guardian","officer","owner","partner","percent_ownership","representative","title"]},"ssn_last_4":{"type":"string","description":"The last four digits of the person's Social Security number (U.S. only).\n\nChanging this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"us_cfpb_data":{"title":"us_cfpb_data_specs","type":"object","properties":{"ethnicity_details":{"title":"us_cfpb_ethnicity_details_specs","type":"object","properties":{"ethnicity":{"type":"array","description":"The persons ethnicity","items":{"type":"string","enum":["cuban","hispanic_or_latino","mexican","not_hispanic_or_latino","other_hispanic_or_latino","prefer_not_to_answer","puerto_rican"]}},"ethnicity_other":{"maxLength":5000,"type":"string","description":"Please specify your origin, when other is selected."}},"description":"The persons ethnicity details","x-stripeMostCommon":["ethnicity","ethnicity_other"]},"race_details":{"title":"us_cfpb_race_details_specs","type":"object","properties":{"race":{"type":"array","description":"The persons race.","items":{"type":"string","enum":["african_american","american_indian_or_alaska_native","asian","asian_indian","black_or_african_american","chinese","ethiopian","filipino","guamanian_or_chamorro","haitian","jamaican","japanese","korean","native_hawaiian","native_hawaiian_or_other_pacific_islander","nigerian","other_asian","other_black_or_african_american","other_pacific_islander","prefer_not_to_answer","samoan","somali","vietnamese","white"]}},"race_other":{"maxLength":5000,"type":"string","description":"Please specify your race, when other is selected."}},"description":"The persons race details","x-stripeMostCommon":["race","race_other"]},"self_identified_gender":{"maxLength":5000,"type":"string","description":"The persons self-identified gender"}},"description":"Demographic data related to the person.","x-stripeMostCommon":["ethnicity_details","race_details","self_identified_gender"]},"verification":{"title":"person_verification_specs","type":"object","properties":{"additional_document":{"title":"person_verification_document_specs","type":"object","properties":{"back":{"maxLength":500,"type":"string","description":"The back of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."},"front":{"maxLength":500,"type":"string","description":"The front of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."}},"description":"A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.","x-stripeMostCommon":["back","electronic_id","front"]},"document":{"title":"person_verification_document_specs","type":"object","properties":{"back":{"maxLength":500,"type":"string","description":"The back of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."},"front":{"maxLength":500,"type":"string","description":"The front of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."}},"description":"An identifying document, either a passport or local ID card.","x-stripeMostCommon":["back","electronic_id","front"]}},"description":"The person's verification status.","x-stripeMostCommon":["additional_document","document","proof_of_liveness"]}},"additionalProperties":false,"x-stripeMostCommon":["address","dob","email","first_name","id_number","last_name","metadata","phone","relationship","ssn_last_4"]},"encoding":{"additional_tos_acceptances":{"style":"deepObject","explode":true},"address":{"style":"deepObject","explode":true},"address_kana":{"style":"deepObject","explode":true},"address_kanji":{"style":"deepObject","explode":true},"dob":{"style":"deepObject","explode":true},"documents":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"full_name_aliases":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"registered_address":{"style":"deepObject","explode":true},"relationship":{"style":"deepObject","explode":true},"us_cfpb_data":{"style":"deepObject","explode":true},"verification":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_person"}},"/v1/accounts/{account}/persons/{person}":{"get":{"summary":"Retrieve a person","description":"Retrieves an existing person.
","operationId":"GetAccountsAccountPersonsPerson","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"person","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_person"},"post":{"summary":"Update a person","description":"Updates an existing person.
","operationId":"PostAccountsAccountPersonsPerson","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"person","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"additional_tos_acceptances":{"title":"person_additional_tos_acceptances_specs","type":"object","properties":{"account":{"title":"settings_terms_of_service_specs","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp marking when the account representative accepted the service agreement.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the account representative accepted the service agreement."},"user_agent":{"description":"The user agent of the browser from which the account representative accepted the service agreement.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Details on the legal guardian's acceptance of the main Stripe service agreement.","x-stripeMostCommon":["date","ip","user_agent"]}},"description":"Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.","x-stripeMostCommon":["account","representative"]},"address":{"title":"legal_entity_and_kyc_address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The person's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"address_kana":{"title":"japan_address_kana_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kana variation of the person's address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"address_kanji":{"title":"japan_address_kanji_specs","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City or ward."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Block or building number."},"line2":{"maxLength":5000,"type":"string","description":"Building details."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code."},"state":{"maxLength":5000,"type":"string","description":"Prefecture."},"town":{"maxLength":5000,"type":"string","description":"Town or cho-me."}},"description":"The Kanji variation of the person's address (Japan only).","x-stripeMostCommon":["city","country","db_code","line1","line2","postal_code","state","town"]},"dob":{"description":"The person's date of birth.","anyOf":[{"title":"date_of_birth_specs","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"x-stripeMostCommon":["day","month","year"]},{"type":"string","enum":[""]}]},"documents":{"title":"person_documents_specs","type":"object","properties":{"company_authorization":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]}}},"description":"One or more documents that demonstrate proof that this person is authorized to represent the company.","x-stripeMostCommon":["files"]},"passport":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]}}},"description":"One or more documents showing the person's passport page with photo and personal data.","x-stripeMostCommon":["files"]},"visa":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]}}},"description":"One or more documents showing the person's visa required for living in the country where they are residing.","x-stripeMostCommon":["files"]}},"description":"Documents that may be submitted to satisfy various informational requests.","x-stripeMostCommon":["DASHBOARD_proof_of_liveness","company_authorization","passport","visa"]},"email":{"type":"string","description":"The person's email address."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"first_name":{"maxLength":5000,"type":"string","description":"The person's first name."},"first_name_kana":{"maxLength":5000,"type":"string","description":"The Kana variation of the person's first name (Japan only)."},"first_name_kanji":{"maxLength":5000,"type":"string","description":"The Kanji variation of the person's first name (Japan only)."},"full_name_aliases":{"description":"A list of alternate names or aliases that the person is known by.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"gender":{"type":"string","description":"The person's gender (International regulations require either \"male\" or \"female\")."},"id_number":{"maxLength":5000,"type":"string","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).\n\nChanging this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"id_number_secondary":{"maxLength":5000,"type":"string","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).\n\nChanging this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"last_name":{"maxLength":5000,"type":"string","description":"The person's last name."},"last_name_kana":{"maxLength":5000,"type":"string","description":"The Kana variation of the person's last name (Japan only)."},"last_name_kanji":{"maxLength":5000,"type":"string","description":"The Kanji variation of the person's last name (Japan only)."},"maiden_name":{"maxLength":5000,"type":"string","description":"The person's maiden name."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"nationality":{"maxLength":5000,"type":"string","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."},"person_token":{"maxLength":5000,"type":"string","description":"A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person."},"phone":{"type":"string","description":"The person's phone number."},"political_exposure":{"type":"string","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"]},"registered_address":{"title":"address_specs","type":"object","properties":{"city":{"maxLength":100,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":200,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":200,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The person's registered address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"relationship":{"title":"relationship_specs","type":"object","properties":{"authorizer":{"type":"boolean","description":"Whether the person is the authorizer of the account's representative."},"director":{"type":"boolean","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."},"executive":{"type":"boolean","description":"Whether the person has significant responsibility to control, manage, or direct the organization."},"legal_guardian":{"type":"boolean","description":"Whether the person is the legal guardian of the account's representative."},"owner":{"type":"boolean","description":"Whether the person is an owner of the account’s legal entity."},"percent_ownership":{"description":"The percent owned by the person of the account's legal entity.","anyOf":[{"type":"number"},{"type":"string","enum":[""]}]},"representative":{"type":"boolean","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."},"title":{"maxLength":5000,"type":"string","description":"The person's title (e.g., CEO, Support Engineer)."}},"description":"The relationship that this person has with the account's legal entity.","x-stripeMostCommon":["authorizer","controller","director","executive","legal_guardian","officer","owner","partner","percent_ownership","representative","title"]},"ssn_last_4":{"type":"string","description":"The last four digits of the person's Social Security number (U.S. only).\n\nChanging this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance)."},"us_cfpb_data":{"title":"us_cfpb_data_specs","type":"object","properties":{"ethnicity_details":{"title":"us_cfpb_ethnicity_details_specs","type":"object","properties":{"ethnicity":{"type":"array","description":"The persons ethnicity","items":{"type":"string","enum":["cuban","hispanic_or_latino","mexican","not_hispanic_or_latino","other_hispanic_or_latino","prefer_not_to_answer","puerto_rican"]}},"ethnicity_other":{"maxLength":5000,"type":"string","description":"Please specify your origin, when other is selected."}},"description":"The persons ethnicity details","x-stripeMostCommon":["ethnicity","ethnicity_other"]},"race_details":{"title":"us_cfpb_race_details_specs","type":"object","properties":{"race":{"type":"array","description":"The persons race.","items":{"type":"string","enum":["african_american","american_indian_or_alaska_native","asian","asian_indian","black_or_african_american","chinese","ethiopian","filipino","guamanian_or_chamorro","haitian","jamaican","japanese","korean","native_hawaiian","native_hawaiian_or_other_pacific_islander","nigerian","other_asian","other_black_or_african_american","other_pacific_islander","prefer_not_to_answer","samoan","somali","vietnamese","white"]}},"race_other":{"maxLength":5000,"type":"string","description":"Please specify your race, when other is selected."}},"description":"The persons race details","x-stripeMostCommon":["race","race_other"]},"self_identified_gender":{"maxLength":5000,"type":"string","description":"The persons self-identified gender"}},"description":"Demographic data related to the person.","x-stripeMostCommon":["ethnicity_details","race_details","self_identified_gender"]},"verification":{"title":"person_verification_specs","type":"object","properties":{"additional_document":{"title":"person_verification_document_specs","type":"object","properties":{"back":{"maxLength":500,"type":"string","description":"The back of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."},"front":{"maxLength":500,"type":"string","description":"The front of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."}},"description":"A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.","x-stripeMostCommon":["back","electronic_id","front"]},"document":{"title":"person_verification_document_specs","type":"object","properties":{"back":{"maxLength":500,"type":"string","description":"The back of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."},"front":{"maxLength":500,"type":"string","description":"The front of an ID returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size."}},"description":"An identifying document, either a passport or local ID card.","x-stripeMostCommon":["back","electronic_id","front"]}},"description":"The person's verification status.","x-stripeMostCommon":["additional_document","document","proof_of_liveness"]}},"additionalProperties":false,"x-stripeMostCommon":["address","dob","email","first_name","id_number","last_name","metadata","phone","relationship","ssn_last_4"]},"encoding":{"additional_tos_acceptances":{"style":"deepObject","explode":true},"address":{"style":"deepObject","explode":true},"address_kana":{"style":"deepObject","explode":true},"address_kanji":{"style":"deepObject","explode":true},"dob":{"style":"deepObject","explode":true},"documents":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"full_name_aliases":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"registered_address":{"style":"deepObject","explode":true},"relationship":{"style":"deepObject","explode":true},"us_cfpb_data":{"style":"deepObject","explode":true},"verification":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/person"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_person"},"delete":{"summary":"Delete a person","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 representative. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
With Connect, you can reject accounts that you have flagged as suspicious.
\n\nOnly accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.
","operationId":"PostAccountsAccountReject","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["reason"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payouts_action":{"type":"string","description":"Whether to pause payouts on the account as part of the rejection. Defaults to `pause`. Use `none` to leave payouts enabled.","enum":["none","pause"],"x-stripeEnum":{"kind":"closed","values":[{"value":"none"},{"value":"pause"}]}},"reason":{"type":"string","description":"The reason for rejecting the account. Can be `fraud_payment_method_casher`, `fraud_payment_method_tester`, `fraud_no_intent_to_fulfill`, `fraud_other`, `credit`, `terms_of_service`, or `other`.","enum":["credit","fraud_no_intent_to_fulfill","fraud_other","fraud_payment_method_casher","fraud_payment_method_tester","other","terms_of_service"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"value":"credit"},{"value":"fraud_no_intent_to_fulfill"},{"value":"fraud_other"},{"value":"fraud_payment_method_casher"},{"value":"fraud_payment_method_tester"},{"value":"other"},{"value":"terms_of_service"}]}}},"additionalProperties":false,"x-stripeMostCommon":["payouts_action","reason"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"reject_connect_account"}},"/v1/accounts/{account}/unreject":{"post":{"summary":"Unreject an account","description":"With Connect, you can unreject accounts that you have previously rejected.
\n\nOnly accounts that were rejected by your platform can be unrejected. This API cannot be used to unreject accounts that were rejected by Stripe.
\n\nUnreject will only enable charges and/or payouts if there are no other restrictions other than those placed by a previous rejection. If you have separately paused charges and/or payouts outside of rejection, those pauses will remain in place after unrejection.
","operationId":"PostAccountsAccountUnreject","parameters":[{"name":"account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"unreject_connect_account"}},"/v1/apple_pay/domains":{"get":{"description":"List apple pay domains.
","operationId":"GetApplePayDomains","parameters":[{"name":"domain_name","in":"query","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ApplePayDomainList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/apple_pay_domain"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/apple_pay/domains","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"post":{"description":"Create an apple pay domain.
","operationId":"PostApplePayDomains","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["domain_name"],"type":"object","properties":{"domain_name":{"type":"string"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["domain_name"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apple_pay_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/apple_pay/domains/{domain}":{"get":{"description":"Retrieve an apple pay domain.
","operationId":"GetApplePayDomainsDomain","parameters":[{"name":"domain","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apple_pay_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"delete":{"description":"Delete an apple pay domain.
","operationId":"DeleteApplePayDomainsDomain","parameters":[{"name":"domain","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_apple_pay_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/application_fees":{"get":{"summary":"List all application fees","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":[{"name":"charge","in":"query","description":"Only return application fees for the charge specified by this charge ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"created","in":"query","description":"Only return applications fees that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PlatformEarningList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/application_fee"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/application_fees","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_application_fees"}},"/v1/application_fees/{fee}/refunds/{id}":{"get":{"summary":"Retrieve an application fee refund","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"fee","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fee_refund"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_application_fee_refund"},"post":{"summary":"Update an application fee refund","description":"Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n\nThis request only accepts metadata as an argument.
","operationId":"PostApplicationFeesFeeRefundsId","parameters":[{"name":"fee","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fee_refund"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_application_fee_refund"}},"/v1/application_fees/{id}":{"get":{"summary":"Retrieve an application fee","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application_fee"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_application_fee"}},"/v1/application_fees/{id}/refunds":{"get":{"summary":"List all application fee refunds","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.
Refunds an application fee that has previously been collected but not yet refunded.\nFunds will be refunded to the Stripe account from which the fee was originally collected.
\n\nYou can optionally refund only part of an application fee.\nYou can do so multiple times, until the entire fee has been refunded.
\n\nOnce entirely refunded, an application fee can’t be refunded again.\nThis method will raise an error when called on an already-refunded application fee,\nor when trying to refund more money than is left on an application fee.
","operationId":"PostApplicationFeesIdRefunds","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."}},"additionalProperties":false,"x-stripeMostCommon":["amount","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fee_refund"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_application_fee_refund"}},"/v1/apps/installs":{"get":{"summary":"List all app installs","description":"Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it; other callers see the installs on their own account. The key selects the environment: a live key lists live installs, a sandbox API key lists the installs on that sandbox, and the key of an app’s managed sandbox filtering by app lists that app’s installs across every sandbox. For existing accounts that still use legacy test mode, a test mode key lists legacy test mode installs.
Creates an app install. An account installs its own private app with its own key; public and testing installs are made from the Dashboard. An app developer or embedding platform acting on a connected account through Stripe-Account installs or reinstalls its app there. For a private app, creating an install installs the newest completed upload; when that version is already installed with nothing pending, the existing install is returned.
Retrieves an app install. The installing account, the app’s developer (with the keys of the account that owns the app or of the app’s managed sandbox), and the embedding platform that created the install can retrieve it.
","operationId":"GetAppsInstallsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps.install"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_app_install"},"post":{"summary":"Update an app install","description":"Reauthorizes an app install. The installer grants the permissions, content security policy entries, and endpoints that the version being installed requests. An account reauthorizes its own installs on any channel with its own key; app developers and embedding platforms reauthorize installs on connected accounts through Stripe-Account. For private apps, the version being installed is the newest completed upload.
Uninstalls an app from the account that installed it.
","operationId":"PostAppsInstallsIdUninstall","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps.install"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"uninstall_app_install"}},"/v1/apps/secrets":{"get":{"summary":"List secrets","description":"List all secrets stored on the given scope.
","operationId":"GetAppsSecrets","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"scope","in":"query","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.","required":true,"style":"deepObject","explode":true,"schema":{"title":"scope_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The secret scope type.","enum":["account","user"]},"user":{"maxLength":5000,"type":"string","description":"The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`."}},"x-stripeMostCommon":["type","user"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SecretServiceResourceSecretList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/apps.secret"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/apps/secrets","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_secrets"},"post":{"summary":"Set a Secret","description":"Create or replace a secret in the secret store.
","operationId":"PostAppsSecrets","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","payload","scope"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","description":"The Unix timestamp for the expiry time of the secret, after which the secret deletes.","format":"unix-time"},"name":{"maxLength":5000,"type":"string","description":"A name for the secret that's unique within the scope."},"payload":{"maxLength":5000,"type":"string","description":"The plaintext secret value to be stored."},"scope":{"title":"scope_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The secret scope type.","enum":["account","user"]},"user":{"maxLength":5000,"type":"string","description":"The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`."}},"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.","x-stripeMostCommon":["type","user"]}},"additionalProperties":false,"x-stripeMostCommon":["expires_at","name","payload","scope"]},"encoding":{"expand":{"style":"deepObject","explode":true},"scope":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps.secret"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"set_connect_secret"}},"/v1/apps/secrets/delete":{"post":{"summary":"Delete a Secret","description":"Deletes a secret from the secret store by name and scope.
","operationId":"PostAppsSecretsDelete","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","scope"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"name":{"maxLength":5000,"type":"string","description":"A name for the secret that's unique within the scope."},"scope":{"title":"scope_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The secret scope type.","enum":["account","user"]},"user":{"maxLength":5000,"type":"string","description":"The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`."}},"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.","x-stripeMostCommon":["type","user"]}},"additionalProperties":false,"x-stripeMostCommon":["name","scope"]},"encoding":{"expand":{"style":"deepObject","explode":true},"scope":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps.secret"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_connect_secret"}},"/v1/apps/secrets/find":{"get":{"summary":"Find a Secret","description":"Finds a secret in the secret store by name and scope.
","operationId":"GetAppsSecretsFind","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"name","in":"query","description":"A name for the secret that's unique within the scope.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"scope","in":"query","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.","required":true,"style":"deepObject","explode":true,"schema":{"title":"scope_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The secret scope type.","enum":["account","user"]},"user":{"maxLength":5000,"type":"string","description":"The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`."}},"x-stripeMostCommon":["type","user"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps.secret"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"find_connect_secret"}},"/v1/balance":{"get":{"summary":"Retrieve balance","description":"Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances.
","operationId":"GetBalance","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/balance"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_balance"}},"/v1/balance_settings":{"get":{"summary":"Retrieve balance settings","description":"Retrieves balance settings for a given connected account.\n Related guide: Making API calls for connected accounts
","operationId":"GetBalanceSettings","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/balance_settings"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_balance_settings"},"post":{"summary":"Update balance settings","description":"Updates balance settings for a given connected account.\n Related guide: Making API calls for connected accounts
","operationId":"PostBalanceSettings","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payments":{"title":"payments","type":"object","properties":{"debit_negative_balances":{"type":"boolean","description":"A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/connect/account-balances)."},"payouts":{"title":"payouts","type":"object","properties":{"automatic_transfer_rules_by_currency":{"description":"Configures per-currency rules for automatically transferring funds from the payments balance to a FinancialAccount.","anyOf":[{"type":"object","additionalProperties":{"anyOf":[{"type":"array","items":{"title":"automatic_transfer_rule","required":["payout_method","type"],"type":"object","properties":{"payout_method":{"type":"string","description":"The ID of the FinancialAccount that funds will be transferred to during automatic transfers."},"transfer_up_to_amount":{"type":"integer","description":"The maximum amount in minor units to transfer to the FinancialAccount. Required and only applicable when `type` is `transfer_up_to_amount`."},"type":{"type":"string","description":"The type of automatic transfer rule.","enum":["transfer_all","transfer_up_to_amount"]}},"x-stripeMostCommon":["destination_currency","payout_method","transfer_up_to_amount","type"]}},{"type":"string","enum":[""]}]}},{"type":"string","enum":[""]}]},"minimum_balance_by_currency":{"description":"The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).","anyOf":[{"type":"object","additionalProperties":{"anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]}},{"type":"string","enum":[""]}]},"schedule":{"title":"payout_schedule","type":"object","properties":{"interval":{"type":"string","description":"How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.","enum":["daily","manual","monthly","weekly"],"x-stripeBypassValidation":true},"monthly_payout_days":{"type":"array","description":"The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.","items":{"type":"integer"}},"weekly_payout_days":{"type":"array","description":"The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. Required and applicable only if `interval` is `weekly`.","items":{"type":"string","enum":["friday","monday","thursday","tuesday","wednesday"],"x-stripeBypassValidation":true}}},"description":"Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](/connect/bank-transfers#payout-information) documentation.","x-stripeMostCommon":["interval","monthly_payout_days","weekly_payout_days"]},"statement_descriptor":{"maxLength":22,"type":"string","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."}},"description":"Settings specific to the account's payouts.","x-stripeMostCommon":["automatic_transfer_rules_by_currency","default_payout_method_for_currency","minimum_balance_by_currency","schedule","statement_descriptor"]},"settlement_timing":{"title":"settlement_timing","type":"object","properties":{"delay_days_override":{"description":"Change `delay_days` for this account, which determines the number of days charge funds are held before becoming available. The maximum value is 31. Passing an empty string to `delay_days_override` will return `delay_days` to the default, which is the lowest available value for the account. [Learn more about controlling delay days](/connect/manage-payout-schedule).","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"start_of_day":{"description":"Customized start of day configuration for automatic payouts to group and send payments in local timezones with a customized day starting time. For details, see our [Customized start of day](/connect/customized-start-of-day) documentation.","anyOf":[{"title":"start_of_day","type":"object","properties":{"hour":{"type":"integer","description":"Hour at which the customized start of day begins according to the given timezone. Must be a [supported customized start of day hour](/connect/customized-start-of-day#available-timezones-and-cutoffs)."},"minutes":{"type":"integer","description":"Minutes at which the customized start of day begins according to the given timezone. Must be either 0 or 30."},"timezone":{"maxLength":5000,"type":"string","description":"Timezone for the customized start of day. Must be a [supported customized start of day timezone](/connect/customized-start-of-day#available-timezones-and-cutoffs)."}},"x-stripeMostCommon":["hour","minutes","timezone"]},{"type":"string","enum":[""]}]}},"description":"Settings related to the account's balance settlement timing.","x-stripeMostCommon":["delay_days_override","payment_method_options","start_of_day"]}},"description":"Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).","x-stripeMostCommon":["debit_negative_balances","payouts","settlement_currencies","settlement_timing"]}},"additionalProperties":false,"x-stripeMostCommon":["payments"]},"encoding":{"expand":{"style":"deepObject","explode":true},"payments":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/balance_settings"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_balance_settings"}},"/v1/balance_transactions":{"get":{"summary":"List all balance transactions","description":"Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in sorted order, with the most recent transactions appearing first.
\n\nThe previous name of this endpoint was “Balance history,” and it used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
\n\nNote that this endpoint previously used the path /v1/balance/history/:id.
Lists billing active and inactive alerts
","operationId":"GetBillingAlerts","parameters":[{"name":"alert_type","in":"query","description":"Filter results to only include this type of alert.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["usage_threshold"],"x-stripeBypassValidation":true}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"meter","in":"query","description":"Filter results to only include alerts with the given meter.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ThresholdsResourceAlertList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing.alert"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing/alerts","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_alerts"},"post":{"summary":"Create a billing alert","description":"Creates a billing alert
","operationId":"PostBillingAlerts","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["alert_type","title"],"type":"object","properties":{"alert_type":{"type":"string","description":"The type of alert to create.","enum":["usage_threshold"],"x-stripeBypassValidation":true},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"title":{"maxLength":256,"type":"string","description":"The title of the alert."},"usage_threshold":{"title":"usage_threshold_config","required":["gte","meter","recurrence"],"type":"object","properties":{"filters":{"type":"array","description":"The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.","items":{"title":"usage_alert_filter","required":["type"],"type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"Limit the scope to this usage alert only to this customer."},"type":{"type":"string","description":"What type of filter is being applied to this usage alert.","enum":["customer"]}},"x-stripeMostCommon":["customer","type"]}},"gte":{"type":"integer","description":"Defines the threshold value that triggers the alert. The value must be greater than 0."},"meter":{"maxLength":5000,"type":"string","description":"The [Billing Meter](/api/billing/meter) ID whose usage is monitored."},"recurrence":{"type":"string","description":"Defines how the alert will behave.","enum":["one_time"],"x-stripeBypassValidation":true}},"description":"The configuration of the usage threshold.","x-stripeMostCommon":["filters","gte","meter","recurrence"]}},"additionalProperties":false,"x-stripeMostCommon":["alert_type","title","usage_threshold"]},"encoding":{"expand":{"style":"deepObject","explode":true},"usage_threshold":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.alert"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_alert"}},"/v1/billing/alerts/{id}":{"get":{"summary":"Retrieve a billing alert","description":"Retrieves a billing alert given an ID
","operationId":"GetBillingAlertsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.alert"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_alert"}},"/v1/billing/alerts/{id}/activate":{"post":{"summary":"Activate a billing alert","description":"Reactivates this alert, allowing it to trigger again.
","operationId":"PostBillingAlertsIdActivate","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.alert"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"activate_billing_alert"}},"/v1/billing/alerts/{id}/archive":{"post":{"summary":"Archive a billing alert","description":"Archives this alert, removing it from the list view and APIs. This is non-reversible.
","operationId":"PostBillingAlertsIdArchive","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.alert"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"archive_billing_alert"}},"/v1/billing/alerts/{id}/deactivate":{"post":{"summary":"Deactivate a billing alert","description":"Deactivates this alert, preventing it from triggering.
","operationId":"PostBillingAlertsIdDeactivate","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.alert"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"deactivate_billing_alert"}},"/v1/billing/analytics/meter_usage":{"get":{"summary":"Retrieves aggregated meter usage data","description":"Returns aggregated meter usage data for a customer within a specified time interval. The data can be grouped by various dimensions and can include multiple meters if specified.
","operationId":"GetBillingAnalyticsMeterUsage","parameters":[{"name":"customer","in":"query","description":"The customer id to fetch meter usage data for.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ends_at","in":"query","description":"The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.","required":true,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"meters","in":"query","description":"An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"title":"meter_param","required":["meter"],"type":"object","properties":{"dimension_filters":{"type":"object","additionalProperties":{"type":"array","items":{"maxLength":100,"type":"string"}},"description":"Key-value pairs used to filter usage events by meter dimension values. Each value is an array that can include multiple values for the key. If specified, usage is filtered for matching usage events."},"dimension_group_by_keys":{"type":"array","description":"List of meter dimension keys to group by. If specified, usage events will be grouped by the given meter dimension key's values.","items":{"maxLength":100,"type":"string"}},"meter":{"maxLength":5000,"type":"string","description":"Meter id to query usage for."},"tenant_filters":{"type":"object","additionalProperties":{"type":"array","items":{"maxLength":100,"type":"string"}},"description":"Key-value pairs used to filter usage events by high cardinality tenant dimension values. Each value is an array that can include multiple values for the key. If specified, usage is filtered for matching usage events."}},"x-stripeMostCommon":["dimension_filters","dimension_group_by_keys","meter","tenant_filters","tenant_group_by_keys"]}}},{"name":"starts_at","in":"query","description":"The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.","required":true,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"}},{"name":"timezone","in":"query","description":"The timezone to use for the start and end times. Defaults to UTC if not specified.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string","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/Coyhaique","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"]}},{"name":"value_grouping_window","in":"query","description":"Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["day","hour","month","week"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.analytics.meter_usage"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_meter_usage"}},"/v1/billing/credit_balance_summary":{"get":{"summary":"Retrieve the credit balance summary for a customer","description":"Retrieves the credit balance summary for a customer.
","operationId":"GetBillingCreditBalanceSummary","parameters":[{"name":"customer","in":"query","description":"The customer whose credit balance summary you're retrieving.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"The account representing the customer whose credit balance summary you're retrieving.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"filter","in":"query","description":"The filter criteria for the credit balance summary.","required":true,"style":"deepObject","explode":true,"schema":{"title":"balance_summary_filter_param","required":["type"],"type":"object","properties":{"applicability_scope":{"title":"scope_param","type":"object","properties":{"price_type":{"type":"string","description":"The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.","enum":["metered"]},"prices":{"type":"array","description":"A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`. Limit 20 prices.","items":{"title":"applicable_price_param","required":["id"],"type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The price ID this credit grant should apply to."}},"x-stripeMostCommon":["id"]}}},"description":"The billing credit applicability scope for which to fetch credit balance summary.","x-stripeMostCommon":["billable_items","price_type","prices","rate_cards"]},"credit_grant":{"maxLength":5000,"type":"string","description":"The credit grant for which to fetch credit balance summary."},"type":{"type":"string","description":"Specify the type of this filter.","enum":["applicability_scope","credit_grant"]}},"x-stripeMostCommon":["applicability_scope","credit_grant","type"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_balance_summary"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_credit_balance_summary"}},"/v1/billing/credit_balance_transactions":{"get":{"summary":"List credit balance transactions","description":"Retrieve a list of credit balance transactions.
","operationId":"GetBillingCreditBalanceTransactions","parameters":[{"name":"credit_grant","in":"query","description":"The credit grant for which to fetch credit balance transactions.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer","in":"query","description":"The customer whose credit balance transactions you're retrieving.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"The account representing the customer whose credit balance transactions you're retrieving.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"BillingCreditGrantsResourceBalanceTransactionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing.credit_balance_transaction"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing/credit_grants","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"all_credit_balance_transactions"}},"/v1/billing/credit_balance_transactions/{id}":{"get":{"summary":"Retrieve a credit balance transaction","description":"Retrieves a credit balance transaction.
","operationId":"GetBillingCreditBalanceTransactionsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_balance_transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_credit_balance_transaction"}},"/v1/billing/credit_grants":{"get":{"summary":"List credit grants","description":"Retrieve a list of credit grants.
","operationId":"GetBillingCreditGrants","parameters":[{"name":"customer","in":"query","description":"Only return credit grants for this customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"Only return credit grants for this account representing the customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"BillingCreditGrantsResourceCreditGrantList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing.credit_grant"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing/credit_grants","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"all_credit_grants"},"post":{"summary":"Create a credit grant","description":"Creates a credit grant.
","operationId":"PostBillingCreditGrants","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","applicability_config"],"type":"object","properties":{"amount":{"title":"amount_param","required":["type"],"type":"object","properties":{"monetary":{"title":"monetary_amount_param","required":["currency","value"],"type":"object","properties":{"currency":{"type":"string","description":"Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.","format":"currency"},"value":{"type":"integer","description":"A positive integer representing the amount of the credit grant."}},"description":"The monetary amount.","x-stripeMostCommon":["currency","value"]},"type":{"type":"string","description":"The type of this amount. We currently only support `monetary` billing credits.","enum":["monetary"],"x-stripeBypassValidation":true}},"description":"Amount of this credit grant.","x-stripeMostCommon":["custom_pricing_unit","monetary","type"]},"applicability_config":{"title":"applicability_config_param","required":["scope"],"type":"object","properties":{"scope":{"title":"scope_param","type":"object","properties":{"price_type":{"type":"string","description":"The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.","enum":["metered"]},"prices":{"type":"array","description":"A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`. Limit 20 prices.","items":{"title":"applicable_price_param","required":["id"],"type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The price ID this credit grant should apply to."}},"x-stripeMostCommon":["id"]}}},"description":"Specify the scope of this applicability config.","x-stripeMostCommon":["billable_items","price_type","prices","rate_cards"]}},"description":"Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.","x-stripeMostCommon":["scope"]},"category":{"type":"string","description":"The category of this credit grant. It defaults to `paid` if not specified.","enum":["paid","promotional"]},"customer":{"maxLength":5000,"type":"string","description":"ID of the customer receiving the billing credits."},"customer_account":{"maxLength":5000,"type":"string","description":"ID of the account representing the customer receiving the billing credits."},"effective_at":{"type":"integer","description":"The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.","format":"unix-time"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","description":"The time when the billing credits expire. If not specified, the billing credits don't expire.","format":"unix-time"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format."},"name":{"maxLength":100,"type":"string","description":"A descriptive name shown in the Dashboard."},"priority":{"type":"integer","description":"The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100."}},"additionalProperties":false,"x-stripeMostCommon":["amount","applicability_config","category","customer","customer_account","effective_at","expires_at","metadata","name","priority"]},"encoding":{"amount":{"style":"deepObject","explode":true},"applicability_config":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_grant"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_credit_grant"}},"/v1/billing/credit_grants/{id}":{"get":{"summary":"Retrieve a credit grant","description":"Retrieves a credit grant.
","operationId":"GetBillingCreditGrantsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_grant"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_credit_grant"},"post":{"summary":"Update a credit grant","description":"Updates a credit grant.
","operationId":"PostBillingCreditGrantsId","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"description":"The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.","anyOf":[{"type":"integer","format":"unix-time"},{"type":"string","enum":[""]}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format."}},"additionalProperties":false,"x-stripeMostCommon":["expires_at","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"expires_at":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_grant"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_credit_grant"}},"/v1/billing/credit_grants/{id}/expire":{"post":{"summary":"Expire a credit grant","description":"Expires a credit grant.
","operationId":"PostBillingCreditGrantsIdExpire","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_grant"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"expire_credit_grant"}},"/v1/billing/credit_grants/{id}/void":{"post":{"summary":"Void a credit grant","description":"Voids a credit grant.
","operationId":"PostBillingCreditGrantsIdVoid","parameters":[{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.credit_grant"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"void_credit_grant"}},"/v1/billing/feedback_options":{"get":{"summary":"List all feedback options","description":"Returns a list of your feedback options.
","operationId":"GetBillingFeedbackOptions","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Filter results to only include feedback options with the given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["active","inactive"],"x-stripeEnum":{"kind":"closed","values":[{"description":"The feedback option is active and available for use.","value":"active"},{"description":"The feedback option has been deactivated and is no longer available for use.","value":"inactive"}]}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"Resource for List Endpoint","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing.feedback_option"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"Resource for the List Endpoint of Feedback Option.","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_feedback_options"},"post":{"summary":"Create a feedback option","description":"Creates a new feedback option.
","operationId":"PostBillingFeedbackOptions","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["description"],"type":"object","properties":{"description":{"maxLength":100,"type":"string","description":"The text of the feedback option, which customers see when canceling. Maximum 100 characters."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["description"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.feedback_option"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_feedback_option"}},"/v1/billing/feedback_options/{id}":{"get":{"summary":"Retrieve a feedback option","description":"Retrieves a feedback option object given an ID.
","operationId":"GetBillingFeedbackOptionsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The ID of the feedback option to retrieve.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.feedback_option"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_feedback_option"},"post":{"summary":"Update a feedback option","description":"Updates the description of an existing feedback option.
","operationId":"PostBillingFeedbackOptionsId","parameters":[{"name":"id","in":"path","description":"The ID of the feedback option to update.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"description":{"maxLength":100,"type":"string","description":"The text of the feedback option, which customers see when canceling. Maximum 100 characters."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["description"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.feedback_option"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_feedback_option"}},"/v1/billing/feedback_options/{id}/deactivate":{"post":{"summary":"Deactivate a feedback option","description":"Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.
","operationId":"PostBillingFeedbackOptionsIdDeactivate","parameters":[{"name":"id","in":"path","description":"The ID of the feedback option to deactivate.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.feedback_option"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"deactivate_billing_feedback_option"}},"/v1/billing/margins":{"get":{"summary":"List all margins","description":"Retrieve a list of your margins.
","operationId":"GetBillingMargins","parameters":[{"name":"active","in":"query","description":"Only return margins that are active or inactive. For example, pass `true` to only list active margins.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"MarginList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/margin"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing/margins","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_margins"},"post":{"summary":"Create a margin","description":"Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
Retrieve a margin object with the given ID.
","operationId":"GetBillingMarginsMargin","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"margin","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/margin"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_margin"},"post":{"summary":"Update a margin","description":"Update the specified margin object. Certain fields of the margin object are not editable.
","operationId":"PostBillingMarginsMargin","parameters":[{"name":"margin","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the margin can be applied to invoices, invoice items, or invoice line items or not."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"Name of the margin, which is displayed to customers, such as on invoices."}},"additionalProperties":false,"x-stripeMostCommon":["active","metadata","name"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/margin"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_margin"}},"/v1/billing/meter_event_adjustments":{"post":{"summary":"Create a billing meter event adjustment","description":"Creates a billing meter event adjustment.
","operationId":"PostBillingMeterEventAdjustments","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["event_name","type"],"type":"object","properties":{"cancel":{"title":"event_adjustment_cancel_settings_param","type":"object","properties":{"identifier":{"maxLength":100,"type":"string","description":"Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them."}},"description":"Specifies which event to cancel.","x-stripeMostCommon":["identifier"]},"event_name":{"maxLength":100,"type":"string","description":"The name of the meter event. Corresponds with the `event_name` field on a meter."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","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"]}},"additionalProperties":false,"x-stripeMostCommon":["cancel","event_name","type"]},"encoding":{"cancel":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter_event_adjustment"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_meter_event_adjustment"}},"/v1/billing/meter_events":{"post":{"summary":"Create a billing meter event","description":"Creates a billing meter event.
","operationId":"PostBillingMeterEvents","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["event_name","payload"],"type":"object","properties":{"event_name":{"maxLength":100,"type":"string","description":"The name of the meter event. Corresponds with the `event_name` field on a meter."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"identifier":{"maxLength":100,"type":"string","description":"A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. Stripe enforces uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations."},"payload":{"type":"object","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/meters/configure#meter-configuration-attributes)."},"timestamp":{"type":"integer","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"}},"additionalProperties":false,"x-stripeMostCommon":["event_name","identifier","payload","timestamp"]},"encoding":{"expand":{"style":"deepObject","explode":true},"payload":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter_event"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_meter_event"}},"/v1/billing/meters":{"get":{"summary":"List billing meters","description":"Retrieve a list of billing meters.
","operationId":"GetBillingMeters","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Filter results to only include meters with the given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["active","inactive"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"BillingMeterResourceBillingMeterList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing.meter"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing/meters","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"all_billing_meters"},"post":{"summary":"Create a billing meter","description":"Creates a billing meter.
","operationId":"PostBillingMeters","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["default_aggregation","display_name","event_name"],"type":"object","properties":{"customer_mapping":{"title":"customer_mapping_param","required":["event_payload_key","type"],"type":"object","properties":{"event_payload_key":{"maxLength":100,"type":"string","description":"The key in the meter event payload to use for mapping the event to a customer."},"type":{"type":"string","description":"The method for mapping a meter event to a customer. Must be `by_id`.","enum":["by_id"]}},"description":"Fields that specify how to map a meter event to a customer.","x-stripeMostCommon":["event_payload_key","type"]},"default_aggregation":{"title":"aggregation_settings_param","required":["formula"],"type":"object","properties":{"formula":{"type":"string","description":"Specifies how events are aggregated.","enum":["count","last","sum"],"x-stripeBypassValidation":true}},"description":"The default settings to aggregate a meter's events with.","x-stripeMostCommon":["formula"]},"display_name":{"maxLength":250,"type":"string","description":"The meter’s name. Not visible to the customer."},"event_name":{"maxLength":100,"type":"string","description":"The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events."},"event_time_window":{"type":"string","description":"The time window which meter events have been pre-aggregated for, if any.","enum":["day","hour"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"value_settings":{"title":"meter_value_settings_param","required":["event_payload_key"],"type":"object","properties":{"event_payload_key":{"maxLength":100,"type":"string","description":"The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to \"bytes_used\"."}},"description":"Fields that specify how to calculate a meter event's value.","x-stripeMostCommon":["event_payload_key"]}},"additionalProperties":false,"x-stripeMostCommon":["customer_mapping","default_aggregation","display_name","event_name","event_time_window","value_settings"]},"encoding":{"customer_mapping":{"style":"deepObject","explode":true},"default_aggregation":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"value_settings":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_meter"}},"/v1/billing/meters/{id}":{"get":{"summary":"Retrieve a billing meter","description":"Retrieves a billing meter given an ID.
","operationId":"GetBillingMetersId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_meter"},"post":{"summary":"Update a billing meter","description":"Updates a billing meter.
","operationId":"PostBillingMetersId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"display_name":{"maxLength":250,"type":"string","description":"The meter’s name. Not visible to the customer."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["display_name"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_meter"}},"/v1/billing/meters/{id}/deactivate":{"post":{"summary":"Deactivate a billing meter","description":"When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.
","operationId":"PostBillingMetersIdDeactivate","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"deactivate_billing_meter"}},"/v1/billing/meters/{id}/event_summaries":{"get":{"summary":"List billing meter event summaries","description":"Retrieve a list of billing meter event summaries.
","operationId":"GetBillingMetersIdEventSummaries","parameters":[{"name":"customer","in":"query","description":"The customer for which to fetch event summaries.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"end_time","in":"query","description":"The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.","required":true,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"Unique identifier for the object.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"start_time","in":"query","description":"The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.","required":true,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"value_grouping_window","in":"query","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. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["day","hour"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"BillingMeterResourceBillingMeterEventSummaryList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing.meter_event_summary"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing/meters/[^/]+/event_summaries","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"all_billing_meter_event_summaries"}},"/v1/billing/meters/{id}/reactivate":{"post":{"summary":"Reactivate a billing meter","description":"When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
","operationId":"PostBillingMetersIdReactivate","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing.meter"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"reactivate_billing_meter"}},"/v1/billing_portal/configurations":{"get":{"summary":"List portal configurations","description":"Returns a list of configurations that describe the functionality of the customer portal.
","operationId":"GetBillingPortalConfigurations","parameters":[{"name":"active","in":"query","description":"Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"is_default","in":"query","description":"Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PortalPublicResourceConfigurationList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/billing_portal.configuration"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/billing_portal/configurations","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_portal_configurations"},"post":{"summary":"Create a portal configuration","description":"Creates a configuration that describes the functionality and behavior of a PortalSession
","operationId":"PostBillingPortalConfigurations","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["features"],"type":"object","properties":{"business_profile":{"title":"business_profile_create_param","type":"object","properties":{"headline":{"description":"The messaging shown to customers in the portal.","anyOf":[{"maxLength":60,"type":"string"},{"type":"string","enum":[""]}]},"privacy_policy_url":{"type":"string","description":"A link to the business’s publicly available privacy policy."},"terms_of_service_url":{"type":"string","description":"A link to the business’s publicly available terms of service."}},"description":"The business information shown to customers in the portal.","x-stripeMostCommon":["headline","privacy_policy_url","terms_of_service_url"]},"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 [overridden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"features":{"title":"features_creation_param","type":"object","properties":{"customer_update":{"title":"customer_update_creation_param","required":["enabled"],"type":"object","properties":{"allowed_updates":{"description":"The types of customer updates that are supported. When empty, customers are not updateable.","anyOf":[{"type":"array","items":{"type":"string","enum":["address","email","name","phone","shipping","tax_id"]}},{"type":"string","enum":[""]}]},"enabled":{"type":"boolean","description":"Whether the feature is enabled."}},"description":"Information about updating the customer details in the portal.","x-stripeMostCommon":["allowed_updates","enabled"]},"invoice_history":{"title":"invoice_list_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled."}},"description":"Information about showing the billing history in the portal.","x-stripeMostCommon":["enabled"]},"payment_method_update":{"title":"payment_method_update_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"payment_method_configuration":{"description":"The [Payment Method Configuration](/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set or set to an empty string, the default payment method configuration is used.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Information about updating payment methods in the portal.","x-stripeMostCommon":["enabled","payment_method_configuration"]},"subscription_cancel":{"title":"subscription_cancel_creation_param","required":["enabled"],"type":"object","properties":{"cancellation_reason":{"title":"subscription_cancellation_reason_creation_param","required":["enabled","options"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"feedback_options":{"description":"The IDs of custom feedback options to use for this cancellation reason.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"options":{"description":"Which cancellation reasons will be given as options to the customer.","anyOf":[{"type":"array","items":{"type":"string","enum":["customer_service","low_quality","missing_features","other","switched_service","too_complex","too_expensive","unused"]}},{"type":"string","enum":[""]}]}},"description":"Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer","x-stripeMostCommon":["enabled","feedback_options","options"]},"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"mode":{"type":"string","description":"Whether to cancel subscriptions immediately or at the end of the billing period.","enum":["at_period_end","immediately"]},"proration_behavior":{"type":"string","description":"Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.","enum":["always_invoice","create_prorations","none"]}},"description":"Information about canceling subscriptions in the portal.","x-stripeMostCommon":["cancellation_reason","cancellation_redirect","enabled","mode","proration_behavior","restrictions","retention_options"]},"subscription_update":{"title":"subscription_update_creation_param","required":["enabled"],"type":"object","properties":{"billing_cycle_anchor":{"type":"string","description":"Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `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://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["now","unchanged"],"x-stripeEnum":{"kind":"open","values":[{"description":"Resets the subscription's billing cycle anchor to the current time.","value":"now"},{"description":"Keeps the subscription's billing cycle anchor unchanged.","value":"unchanged"}]}},"default_allowed_updates":{"description":"The types of subscription updates that are supported. When empty, subscriptions are not updateable.","anyOf":[{"type":"array","items":{"type":"string","enum":["price","promotion_code","quantity"]}},{"type":"string","enum":[""]}]},"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"products":{"description":"The list of up to 10 products that support subscription updates.","anyOf":[{"type":"array","items":{"title":"subscription_update_product_param","required":["prices","product"],"type":"object","properties":{"adjustable_quantity":{"title":"subscription_update_product_adjustable_quantity_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative integer."},"maximum":{"type":"integer","description":"The maximum quantity that can be set for the product."},"minimum":{"type":"integer","description":"The minimum quantity that can be set for the product."}},"description":"Control whether the quantity of the product can be adjusted.","x-stripeMostCommon":["enabled","maximum","minimum"]},"prices":{"type":"array","description":"The list of price IDs for the product that a subscription can be updated to.","items":{"maxLength":5000,"type":"string"}},"product":{"maxLength":5000,"type":"string","description":"The product id."}},"x-stripeMostCommon":["adjustable_quantity","prices","product"]}},{"type":"string","enum":[""]}]},"proration_behavior":{"type":"string","description":"Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.","enum":["always_invoice","create_prorations","none"]},"schedule_at_period_end":{"title":"schedule_update_at_period_end_creating_param","type":"object","properties":{"conditions":{"type":"array","description":"List of conditions. When any condition is true, the update will be scheduled at the end of the current period.","items":{"title":"schedule_update_at_period_end_condition_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of condition.","enum":["decreasing_item_amount","shortening_interval"]}},"x-stripeMostCommon":["type"]}}},"description":"Setting to control when an update should be scheduled at the end of the period instead of applying immediately.","x-stripeMostCommon":["conditions"]},"trial_update_behavior":{"type":"string","description":"The behavior when updating a subscription that is trialing.","enum":["continue_trial","end_trial"]}},"description":"Information about updating subscriptions in the portal.","x-stripeMostCommon":["billing_cycle_anchor","default_allowed_updates","enabled","packaging","products","proration_behavior","proration_date","restrictions","schedule_at_period_end","trial_update_behavior"]}},"description":"Information about the features available in the portal.","x-stripeMostCommon":["customer_update","invoice_history","payment_method_update","subscription_cancel","subscription_update","usage_based_billing"]},"login_page":{"title":"login_page_create_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal."}},"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).","x-stripeMostCommon":["enabled"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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 name of the configuration.","anyOf":[{"maxLength":256,"type":"string"},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["business_profile","default_return_url","features","login_page","metadata","name"]},"encoding":{"business_profile":{"style":"deepObject","explode":true},"default_return_url":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"features":{"style":"deepObject","explode":true},"login_page":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"name":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_portal.configuration"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_portal_configuration"}},"/v1/billing_portal/configurations/{configuration}":{"get":{"summary":"Retrieve a portal configuration","description":"Retrieves a configuration that describes the functionality of the customer portal.
","operationId":"GetBillingPortalConfigurationsConfiguration","parameters":[{"name":"configuration","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_portal.configuration"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_portal_configuration"},"post":{"summary":"Update a portal configuration","description":"Updates a configuration that describes the functionality of the customer portal.
","operationId":"PostBillingPortalConfigurationsConfiguration","parameters":[{"name":"configuration","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the configuration is active and can be used to create portal sessions."},"business_profile":{"title":"business_profile_update_param","type":"object","properties":{"headline":{"description":"The messaging shown to customers in the portal.","anyOf":[{"maxLength":60,"type":"string"},{"type":"string","enum":[""]}]},"privacy_policy_url":{"description":"A link to the business’s publicly available privacy policy.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"terms_of_service_url":{"description":"A link to the business’s publicly available terms of service.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"The business information shown to customers in the portal.","x-stripeMostCommon":["headline","privacy_policy_url","terms_of_service_url"]},"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 [overridden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"features":{"title":"features_updating_param","type":"object","properties":{"customer_update":{"title":"customer_update_updating_param","type":"object","properties":{"allowed_updates":{"description":"The types of customer updates that are supported. When empty, customers are not updateable.","anyOf":[{"type":"array","items":{"type":"string","enum":["address","email","name","phone","shipping","tax_id"]}},{"type":"string","enum":[""]}]},"enabled":{"type":"boolean","description":"Whether the feature is enabled."}},"description":"Information about updating the customer details in the portal.","x-stripeMostCommon":["allowed_updates","enabled"]},"invoice_history":{"title":"invoice_list_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled."}},"description":"Information about showing the billing history in the portal.","x-stripeMostCommon":["enabled"]},"payment_method_update":{"title":"payment_method_update_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"payment_method_configuration":{"description":"The [Payment Method Configuration](/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set or set to an empty string, the default payment method configuration is used.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Information about updating payment methods in the portal.","x-stripeMostCommon":["enabled","payment_method_configuration"]},"subscription_cancel":{"title":"subscription_cancel_updating_param","type":"object","properties":{"cancellation_reason":{"title":"subscription_cancellation_reason_updating_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"feedback_options":{"description":"The IDs of custom feedback options to use for this cancellation reason.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"options":{"description":"Which cancellation reasons will be given as options to the customer.","anyOf":[{"type":"array","items":{"type":"string","enum":["customer_service","low_quality","missing_features","other","switched_service","too_complex","too_expensive","unused"]}},{"type":"string","enum":[""]}]}},"description":"Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer","x-stripeMostCommon":["enabled","feedback_options","options"]},"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"mode":{"type":"string","description":"Whether to cancel subscriptions immediately or at the end of the billing period.","enum":["at_period_end","immediately"]},"proration_behavior":{"type":"string","description":"Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.","enum":["always_invoice","create_prorations","none"]}},"description":"Information about canceling subscriptions in the portal.","x-stripeMostCommon":["cancellation_reason","cancellation_redirect","enabled","mode","proration_behavior","restrictions","retention_options"]},"subscription_update":{"title":"subscription_update_updating_param","type":"object","properties":{"billing_cycle_anchor":{"type":"string","description":"Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `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://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["now","unchanged"],"x-stripeEnum":{"kind":"open","values":[{"description":"Resets the subscription's billing cycle anchor to the current time.","value":"now"},{"description":"Keeps the subscription's billing cycle anchor unchanged.","value":"unchanged"}]}},"default_allowed_updates":{"description":"The types of subscription updates that are supported. When empty, subscriptions are not updateable.","anyOf":[{"type":"array","items":{"type":"string","enum":["price","promotion_code","quantity"]}},{"type":"string","enum":[""]}]},"enabled":{"type":"boolean","description":"Whether the feature is enabled."},"products":{"description":"The list of up to 10 products that support subscription updates.","anyOf":[{"type":"array","items":{"title":"subscription_update_product_param","required":["prices","product"],"type":"object","properties":{"adjustable_quantity":{"title":"subscription_update_product_adjustable_quantity_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative integer."},"maximum":{"type":"integer","description":"The maximum quantity that can be set for the product."},"minimum":{"type":"integer","description":"The minimum quantity that can be set for the product."}},"description":"Control whether the quantity of the product can be adjusted.","x-stripeMostCommon":["enabled","maximum","minimum"]},"prices":{"type":"array","description":"The list of price IDs for the product that a subscription can be updated to.","items":{"maxLength":5000,"type":"string"}},"product":{"maxLength":5000,"type":"string","description":"The product id."}},"x-stripeMostCommon":["adjustable_quantity","prices","product"]}},{"type":"string","enum":[""]}]},"proration_behavior":{"type":"string","description":"Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.","enum":["always_invoice","create_prorations","none"]},"schedule_at_period_end":{"title":"schedule_update_at_period_end_updating_param","type":"object","properties":{"conditions":{"description":"List of conditions. When any condition is true, the update will be scheduled at the end of the current period.","anyOf":[{"type":"array","items":{"title":"schedule_update_at_period_end_condition_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of condition.","enum":["decreasing_item_amount","shortening_interval"]}},"x-stripeMostCommon":["type"]}},{"type":"string","enum":[""]}]}},"description":"Setting to control when an update should be scheduled at the end of the period instead of applying immediately.","x-stripeMostCommon":["conditions"]},"trial_update_behavior":{"type":"string","description":"The behavior when updating a subscription that is trialing.","enum":["continue_trial","end_trial"]}},"description":"Information about updating subscriptions in the portal.","x-stripeMostCommon":["billing_cycle_anchor","default_allowed_updates","enabled","packaging","products","proration_behavior","proration_date","restrictions","schedule_at_period_end","trial_update_behavior"]}},"description":"Information about the features available in the portal.","x-stripeMostCommon":["customer_update","invoice_history","payment_method_update","subscription_cancel","subscription_update","usage_based_billing"]},"login_page":{"title":"login_page_update_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to generate a shareable URL [`login_page.url`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-login_page-url) that will take your customers to a hosted login page for the customer portal.\n\nSet to `false` to deactivate the `login_page.url`."}},"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).","x-stripeMostCommon":["enabled"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"description":"The name of the configuration.","anyOf":[{"maxLength":256,"type":"string"},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["active","business_profile","default_return_url","features","login_page","metadata","name"]},"encoding":{"business_profile":{"style":"deepObject","explode":true},"default_return_url":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"features":{"style":"deepObject","explode":true},"login_page":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"name":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_portal.configuration"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_portal_configuration"}},"/v1/billing_portal/sessions":{"post":{"summary":"Create a portal session","description":"Creates a session of the customer portal.
","operationId":"PostBillingPortalSessions","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"after_expiration":{"title":"after_expiration_param","required":["type"],"type":"object","properties":{"customer_login":{"title":"after_expiration_customer_login_param","type":"object","properties":{"expires_at":{"type":"integer","description":"The Unix timestamp after which the customer can no longer recover this session. Leave unset to allow recovery without a deadline.","format":"unix-time"}},"description":"Configuration for authenticating the customer after the session expires.","x-stripeMostCommon":["expires_at"]},"type":{"type":"string","description":"The behavior to apply when the session expires.","enum":["customer_login"],"x-stripeEnum":{"kind":"open","values":[{"description":"Allow the customer to authenticate by email to create a replacement session.","value":"customer_login"}]}}},"description":"Behavior after the portal session expires.","x-stripeMostCommon":["customer_login","type"]},"configuration":{"maxLength":5000,"type":"string","description":"The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration."},"customer":{"maxLength":5000,"type":"string","description":"The ID of an existing customer."},"customer_account":{"maxLength":5000,"type":"string","description":"The ID of an existing account."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"flow_data":{"title":"flow_data_param","required":["type"],"type":"object","properties":{"after_completion":{"title":"flow_data_after_completion_param","required":["type"],"type":"object","properties":{"hosted_confirmation":{"title":"after_completion_hosted_confirmation_param","type":"object","properties":{"custom_message":{"maxLength":500,"type":"string","description":"A custom message to display to the customer after the flow is completed."}},"description":"Configuration when `after_completion.type=hosted_confirmation`.","x-stripeMostCommon":["custom_message"]},"redirect":{"title":"after_completion_redirect_param","required":["return_url"],"type":"object","properties":{"return_url":{"type":"string","description":"The URL the customer will be redirected to after the flow is completed."}},"description":"Configuration when `after_completion.type=redirect`.","x-stripeMostCommon":["return_url"]},"type":{"type":"string","description":"The specified behavior after the flow is completed.","enum":["hosted_confirmation","portal_homepage","redirect"]}},"description":"Behavior after the flow is completed.","x-stripeMostCommon":["hosted_confirmation","redirect","type"]},"subscription_cancel":{"title":"flow_data_subscription_cancel_param","required":["subscription"],"type":"object","properties":{"retention":{"title":"retention_param","required":["coupon_offer","type"],"type":"object","properties":{"coupon_offer":{"title":"coupon_offer_param","required":["coupon"],"type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The ID of the coupon to be offered."}},"description":"Configuration when `retention.type=coupon_offer`.","x-stripeMostCommon":["coupon"]},"type":{"type":"string","description":"Type of retention strategy to use with the customer.","enum":["coupon_offer"]}},"description":"Specify a retention strategy to be used in the cancellation flow.","x-stripeMostCommon":["coupon_offer","type"]},"subscription":{"maxLength":5000,"type":"string","description":"The ID of the subscription to be canceled."}},"description":"Configuration when `flow_data.type=subscription_cancel`.","x-stripeMostCommon":["retention","subscription"]},"subscription_update":{"title":"flow_data_subscription_update_param","required":["subscription"],"type":"object","properties":{"subscription":{"maxLength":5000,"type":"string","description":"The ID of the subscription to be updated."}},"description":"Configuration when `flow_data.type=subscription_update`.","x-stripeMostCommon":["subscription"]},"subscription_update_confirm":{"title":"flow_data_subscription_update_confirm_param","required":["items","subscription"],"type":"object","properties":{"discounts":{"type":"array","description":"The coupon or promotion code to apply to this subscription update.","items":{"title":"subscription_update_confirm_discount_params","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The ID of the coupon to apply to this subscription update."},"promotion_code":{"maxLength":5000,"type":"string","description":"The ID of a promotion code to apply to this subscription update."}},"x-stripeMostCommon":["coupon","promotion_code"]}},"items":{"type":"array","description":"The [subscription item](https://docs.stripe.com/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":{"title":"subscription_update_confirm_item_params","required":["id"],"type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated."},"price":{"maxLength":5000,"type":"string","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://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products)."},"quantity":{"type":"integer","description":"[Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow."}},"x-stripeMostCommon":["deleted","id","price","quantity"]}},"subscription":{"maxLength":5000,"type":"string","description":"The ID of the subscription to be updated."}},"description":"Configuration when `flow_data.type=subscription_update_confirm`.","x-stripeMostCommon":["discounts","items","recurring_items","subscription"]},"type":{"type":"string","description":"Type of flow that the customer will go through.","enum":["customer_update","payment_method_update","subscription_cancel","subscription_update","subscription_update_confirm"],"x-stripeBypassValidation":true}},"description":"Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.","x-stripeMostCommon":["after_completion","subscription_cancel","subscription_pause","subscription_update","subscription_update_confirm","type"]},"locale":{"type":"string","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"]},"on_behalf_of":{"type":"string","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://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays."},"return_url":{"type":"string","description":"The default URL to redirect customers to when they click on the portal's link to return to your website."}},"additionalProperties":false,"x-stripeMostCommon":["after_expiration","configuration","customer","customer_account","flow_data","locale","on_behalf_of","return_url"]},"encoding":{"after_expiration":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"flow_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_portal.session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_portal_session"}},"/v1/capital/financing_offers":{"get":{"summary":"List financing offers","description":"Retrieves the financing offers available for Connected accounts that belong to your platform.
","operationId":"GetCapitalFinancingOffers","parameters":[{"name":"connected_account","in":"query","description":"limit list to offers belonging to given connected account","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"created","in":"query","description":"Only return offers that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"limit list to offers with given status","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string","enum":["accepted","canceled","completed","delivered","expired","fully_repaid","paid_out","rejected","revoked","undelivered"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CapitalConnectConnectFinancingList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/capital.financing_offer"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/capital/financing_offers","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_capital_connect_financing_offers"}},"/v1/capital/financing_offers/{financing_offer}":{"get":{"summary":"Retrieve a given financing offer","description":"Get the details of the financing offer
","operationId":"GetCapitalFinancingOffersFinancingOffer","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financing_offer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/capital.financing_offer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_capital_connect_financing_offer"}},"/v1/capital/financing_offers/{financing_offer}/mark_delivered":{"post":{"summary":"Mark that a financing offer has been delivered","description":"Acknowledges that platform has received and delivered the financing_offer to\nthe intended merchant recipient.
","operationId":"PostCapitalFinancingOffersFinancingOfferMarkDelivered","parameters":[{"name":"financing_offer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/capital.financing_offer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"mark_delivered_capital_connect_financing_offer"}},"/v1/capital/financing_summary":{"get":{"summary":"Retrieve financing summary","description":"Retrieve the financing summary object for the account.
","operationId":"GetCapitalFinancingSummary","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/capital.financing_summary"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_capital_connect_financing_summary"}},"/v1/capital/financing_transactions":{"get":{"summary":"List all financing transactions","description":"Returns a list of financing transactions. The transactions are returned in sorted order,\nwith the most recent transactions appearing first.
","operationId":"GetCapitalFinancingTransactions","parameters":[{"name":"charge","in":"query","description":"For transactions of type `payment` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financing_offer","in":"query","description":"Returns transactions that were created that apply to this financing offer ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"reversed_transaction","in":"query","description":"Only returns transactions that are responsible for reversing this financing transaction ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"treasury_transaction","in":"query","description":"For transactions of type `payment` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CapitalConnectFinancingTransactionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/capital.financing_transaction"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_capital_connect_financing_transactions"}},"/v1/capital/financing_transactions/{financing_transaction}":{"get":{"summary":"Retrieve a given financing transaction","description":"Retrieves a financing transaction for a financing offer.
","operationId":"GetCapitalFinancingTransactionsFinancingTransaction","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financing_transaction","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/capital.financing_transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_capital_connect_financing_transaction"}},"/v1/charges":{"get":{"summary":"List all charges","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":[{"name":"created","in":"query","description":"Only return charges that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return charges for the customer specified by this customer ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_intent","in":"query","description":"Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"transfer_group","in":"query","description":"Only return charges for this transfer group, limited to 100.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ChargeList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/charge"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/charges","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_charges"},"post":{"summary":"Create a charge","description":"This method is deprecated and will be removed soon. If your integration uses it, you need to update it to use a different payment flow, such as the Payment Intents API.
","operationId":"PostCharges","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."},"application_fee":{"type":"integer"},"application_fee_amount":{"type":"integer","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://docs.stripe.com/connect/direct-charges#collect-fees)."},"capture":{"type":"boolean","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://docs.stripe.com/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://docs.stripe.com/charges/placing-a-hold) documentation."},"currency":{"type":"string","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).","format":"currency"},"customer":{"maxLength":500,"type":"string","description":"The ID of an existing customer that will be charged in this request."},"description":{"maxLength":40000,"type":"string","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."},"destination":{"title":"destination_specs","required":["account"],"type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"ID of an existing, connected Stripe account."},"amount":{"type":"integer","description":"The amount to transfer to the destination account without creating an `Application Fee` object. Cannot be combined with the `application_fee` parameter. Must be less than or equal to the charge amount."}},"x-stripeMostCommon":["account","amount"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"on_behalf_of":{"maxLength":5000,"type":"string","description":"The Stripe account ID for which these funds are intended. You can specify the business of record as the connected account using the `on_behalf_of` attribute on the charge. For details, see [Creating Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant)."},"radar_options":{"title":"radar_options_with_hidden_options","type":"object","properties":{"session":{"maxLength":5000,"type":"string","description":"A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."}},"description":"Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.","x-stripeMostCommon":["session","skip_rules"]},"receipt_email":{"type":"string","description":"The email address to which this charge's [receipt](https://docs.stripe.com/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://docs.stripe.com/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)."},"shipping":{"title":"optional_fields_shipping","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"carrier":{"maxLength":5000,"type":"string","description":"The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."},"name":{"maxLength":5000,"type":"string","description":"Recipient name."},"phone":{"maxLength":5000,"type":"string","description":"Recipient phone (including extension)."},"tracking_number":{"maxLength":5000,"type":"string","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."}},"description":"Shipping information for the charge. Helps prevent fraud on charges for physical goods.","x-stripeMostCommon":["address","carrier","name","phone","tracking_number"]},"source":{"maxLength":5000,"type":"string","description":"A payment source to be charged. This can be the ID of a [card](https://docs.stripe.com/api#cards) (i.e., credit or debit card), a [bank account](https://docs.stripe.com/api#bank_accounts), a [source](https://docs.stripe.com/api#sources), a [token](https://docs.stripe.com/api#tokens), or a [connected account](https://docs.stripe.com/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://docs.stripe.com/api#cards), [bank accounts](https://docs.stripe.com/api#bank_accounts), and attached [sources](https://docs.stripe.com/api#sources)---you must also pass the ID of the associated customer.","x-stripeBypassValidation":true},"statement_descriptor":{"maxLength":22,"type":"string","description":"For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix."},"statement_descriptor_suffix":{"maxLength":22,"type":"string","description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor."},"transfer_data":{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the transfer. Often useful for displaying to users."},"destination":{"maxLength":5000,"type":"string","description":"ID of an existing, connected Stripe account."}},"description":"An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.","x-stripeMostCommon":["amount","description","destination"]},"transfer_group":{"type":"string","description":"A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options)."}},"additionalProperties":false,"x-stripeMostCommon":["amount","application_fee","currency","customer","description","destination","metadata","receipt_email","shipping","source","statement_descriptor","statement_descriptor_suffix"]},"encoding":{"destination":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"radar_options":{"style":"deepObject","explode":true},"shipping":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/charge"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_charge"}},"/v1/charges/search":{"get":{"summary":"Search charges","description":"Search for charges you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetChargesSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for charges](https://docs.stripe.com/search#query-fields-for-charges).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/charge"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_charges"}},"/v1/charges/{charge}":{"get":{"summary":"Retrieve a charge","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":[{"name":"charge","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/charge"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_charge"},"post":{"summary":"Update a charge","description":"Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
","operationId":"PostChargesCharge","parameters":[{"name":"charge","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"customer":{"maxLength":5000,"type":"string","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."},"description":{"maxLength":40000,"type":"string","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fraud_details":{"title":"fraud_details","required":["user_report"],"type":"object","properties":{"user_report":{"maxLength":5000,"type":"string","description":"Either `safe` or `fraudulent`.","enum":["","fraudulent","safe"]}},"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.","x-stripeMostCommon":["user_report"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment_details":{"title":"payment_details_charge_params","type":"object","properties":{"car_rental":{"title":"car_rental","required":["booking_number","days_rented","pickup_at","return_at"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"booking_number":{"maxLength":100,"type":"string","description":"The booking number associated with the car rental."},"car_class_code":{"maxLength":4,"type":"string","description":"Class code of the car."},"car_make":{"maxLength":10,"type":"string","description":"Make of the car."},"car_model":{"maxLength":10,"type":"string","description":"Model of the car."},"company":{"maxLength":26,"type":"string","description":"The name of the rental car company."},"customer_service_phone_number":{"maxLength":16,"type":"string","description":"The customer service phone number of the car rental company."},"days_rented":{"type":"integer","description":"Number of days the car is being rented."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"distance":{"title":"car_rental_distance","type":"object","properties":{"amount":{"type":"integer","description":"Distance traveled."},"unit":{"type":"string","description":"Unit of measurement for the distance traveled. One of `miles` or `kilometers`.","enum":["kilometers","miles"]}},"description":"The details of the distance traveled during the rental period.","x-stripeMostCommon":["amount","unit"]},"drivers":{"type":"array","description":"The details of the passengers in the travel reservation","items":{"title":"car_rental_driver","required":["name"],"type":"object","properties":{"driver_identification_number":{"maxLength":20,"type":"string","description":"Driver's identification number."},"driver_tax_number":{"maxLength":20,"type":"string","description":"Driver's tax number."},"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the car reservation."}},"x-stripeMostCommon":["driver_identification_number","driver_tax_number","name"]}},"extra_charges":{"type":"array","description":"List of additional charges being billed.","items":{"type":"string","enum":["extra_mileage","gas","late_return","one_way_service","parking_violation"]}},"no_show":{"type":"boolean","description":"Indicates if the customer did not keep nor cancel their booking."},"pickup_address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Car pick-up address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"pickup_at":{"type":"integer","description":"Car pick-up time. Measured in seconds since the Unix epoch.","format":"unix-time"},"pickup_location_name":{"maxLength":38,"type":"string","description":"Name of the pickup location."},"rate_amount":{"type":"integer","description":"Rental rate."},"rate_interval":{"type":"string","description":"The frequency at which the rate amount is applied. One of `day`, `week` or `month`","enum":["day","month","week"]},"renter_name":{"maxLength":100,"type":"string","description":"The name of the person or entity renting the car."},"return_address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Car return address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"return_at":{"type":"integer","description":"Car return time. Measured in seconds since the Unix epoch.","format":"unix-time"},"return_location_name":{"maxLength":38,"type":"string","description":"Name of the return location."},"tax_exempt":{"type":"boolean","description":"Indicates whether the goods or services are tax-exempt or tax is not collected."},"vehicle_identification_number":{"maxLength":20,"type":"string","description":"The vehicle identification number."}},"description":"Car rental details for this PaymentIntent.","x-stripeMostCommon":["affiliate","booking_number","car_class_code","car_make","car_model","company","customer_service_phone_number","days_rented","delivery","distance","drivers","extra_charges","no_show","pickup_address","pickup_at","pickup_location_name","rate_amount","rate_interval","renter_name","return_address","return_at","return_location_name","tax_exempt","vehicle_identification_number"]},"car_rental_data":{"description":"Car rental data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"car_rental_data","required":["drop_off","pickup","total"],"type":"object","properties":{"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Name of affiliate partner."}},"description":"Affiliate (such as travel agency) details for the rental.","x-stripeMostCommon":["code","name"]},"booking_number":{"maxLength":255,"type":"string","description":"Booking confirmation number for the car rental."},"carrier_name":{"maxLength":255,"type":"string","description":"Name of the car rental company."},"customer_service_phone_number":{"type":"string","description":"Customer service phone number for the car rental company."},"days_rented":{"type":"integer","description":"Number of days the car is being rented."},"distance":{"title":"distance","required":["amount","unit"],"type":"object","properties":{"amount":{"type":"integer","description":"Distance traveled."},"unit":{"type":"string","description":"Unit of measurement for the distance traveled. One of `miles` or `kilometers`.","enum":["kilometers","miles"]}},"description":"Distance details for the rental.","x-stripeMostCommon":["amount","unit"]},"drivers":{"type":"array","description":"List of drivers for the rental.","items":{"title":"driver","required":["name"],"type":"object","properties":{"date_of_birth":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"Day of birth (1-31)."},"month":{"type":"integer","description":"Month of birth (1-12)."},"year":{"type":"integer","description":"Year of birth (must be greater than 1900)."}},"description":"Driver's date of birth.","x-stripeMostCommon":["day","month","year"]},"driver_identification_number":{"maxLength":20,"type":"string","description":"Driver's identification number."},"driver_tax_number":{"maxLength":20,"type":"string","description":"Driver's tax number."},"name":{"maxLength":198,"type":"string","description":"Driver's full name."}},"x-stripeMostCommon":["date_of_birth","driver_identification_number","driver_tax_number","name"]}},"drop_off":{"title":"location","required":["address","time"],"type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the rental location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"location_name":{"maxLength":38,"type":"string","description":"Location name."},"time":{"type":"integer","description":"Timestamp for the location.","format":"unix-time"}},"description":"Drop-off location details.","x-stripeMostCommon":["address","location_name","time"]},"insurances":{"type":"array","description":"Insurance details for the rental.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount of the insurance coverage in cents."},"currency":{"type":"string","description":"Currency of the insurance amount.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the insurance company."},"insurance_type":{"type":"string","description":"Type of insurance coverage.","enum":["liability_supplement","loss_damage_waiver","other","partial_damage_waiver","personal_accident","personal_effects"],"x-stripeEnum":{"kind":"open","values":[{"description":"Supplemental liability insurance coverage.","value":"liability_supplement"},{"description":"Agreement waiving responsibility for loss or damage to the vehicle.","value":"loss_damage_waiver"},{"description":"Other types of insurance coverage.","value":"other"},{"description":"Agreement limiting responsibility for loss or damage to the vehicle.","value":"partial_damage_waiver"},{"description":"Insurance covering personal accidents during the rental period.","value":"personal_accident"},{"description":"Insurance covering personal belongings during the rental period.","value":"personal_effects"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"no_show_indicator":{"type":"boolean","description":"Indicates if the customer was a no-show."},"pickup":{"title":"location","required":["address","time"],"type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the rental location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"location_name":{"maxLength":38,"type":"string","description":"Location name."},"time":{"type":"integer","description":"Timestamp for the location.","format":"unix-time"}},"description":"Pickup location details.","x-stripeMostCommon":["address","location_name","time"]},"renter_name":{"maxLength":198,"type":"string","description":"Name of the person renting the vehicle."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total amount in cents."},"currency":{"type":"string","description":"Currency of the amount.","format":"currency"},"discounts":{"title":"discounts","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."},"coupon":{"maxLength":25,"type":"string","description":"Coupon code applied to the rental."},"maximum_free_miles_or_kilometers":{"type":"integer","description":"Maximum number of free miles or kilometers included."}},"description":"Discount details for the rental.","x-stripeMostCommon":["corporate_client_code","coupon","maximum_free_miles_or_kilometers"]},"extra_charges":{"type":"array","description":"Additional charges for the rental.","items":{"title":"extra_charge","required":["amount","type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount of the extra charge in cents."},"type":{"type":"string","description":"Type of extra charge.","enum":["extra_mileage","gas","gps","late_charge","one_way_drop_off","other","parking","phone","regular_mileage","towing"]}},"x-stripeMostCommon":["amount","type"]}},"rate_per_unit":{"type":"integer","description":"Rate per unit for the rental."},"rate_unit":{"type":"string","description":"Unit of measurement for the rate.","enum":["days","kilometers","miles","months","weeks"],"x-stripeEnum":{"kind":"open","values":[{"description":"Rental rate charged per day.","value":"days"},{"description":"Rental rate charged per kilometer.","value":"kilometers"},{"description":"Rental rate charged per mile.","value":"miles"},{"description":"Rental rate charged per month.","value":"months"},{"description":"Rental rate charged per week.","value":"weeks"}]}},"tax":{"title":"tax","type":"object","properties":{"tax_exempt_indicator":{"type":"boolean","description":"Indicates if the transaction is tax exempt."},"tax_items":{"type":"array","description":"Array of tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount."},"rate":{"type":"integer","description":"Tax rate applied."},"type":{"maxLength":40,"type":"string","description":"Type of tax applied."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown for the rental.","x-stripeMostCommon":["tax_exempt_indicator","tax_items"]}},"description":"Total cost breakdown for the rental.","x-stripeMostCommon":["amount","currency","discounts","extra_charges","rate_per_unit","rate_unit","tax"]},"vehicle":{"title":"vehicle","type":"object","properties":{"make":{"maxLength":40,"type":"string","description":"Make of the rental vehicle."},"model":{"maxLength":40,"type":"string","description":"Model of the rental vehicle."},"odometer":{"type":"integer","description":"Odometer reading at the time of rental."},"type":{"type":"string","description":"Type of the rental vehicle.","enum":["cargo_van","compact","economy","exotic","exotic_suv","fifteen_passenger_van","four_wheel_drive","full_size","intermediate","large_suv","large_truck","luxury","medium_suv","midsize","mini","minivan","miscellaneous","moped","moving_van","premium","regular","small_medium_truck","small_suv","special","standard","stretch","subcompact","taxi","twelve_foot_truck","twelve_passenger_van","twenty_foot_truck","twenty_four_foot_truck","twenty_six_foot_truck","unique"],"x-stripeEnum":{"kind":"open","values":[{"description":"Van designed for cargo transport.","value":"cargo_van"},{"description":"Compact car.","value":"compact"},{"description":"Economy-class car.","value":"economy"},{"description":"Exotic or high-performance vehicle.","value":"exotic"},{"description":"Exotic or luxury sport utility vehicle.","value":"exotic_suv"},{"description":"Van with capacity for fifteen passengers.","value":"fifteen_passenger_van"},{"description":"Four-wheel-drive vehicle.","value":"four_wheel_drive"},{"description":"Full-sized car.","value":"full_size"},{"description":"Intermediate-sized car.","value":"intermediate"},{"description":"Large sport utility vehicle.","value":"large_suv"},{"description":"Large truck.","value":"large_truck"},{"description":"Luxury car.","value":"luxury"},{"description":"Medium sport utility vehicle.","value":"medium_suv"},{"description":"Midsize car.","value":"midsize"},{"description":"Mini-sized car.","value":"mini"},{"description":"Minivan.","value":"minivan"},{"description":"Other miscellaneous vehicle types.","value":"miscellaneous"},{"description":"Moped or motorized scooter.","value":"moped"},{"description":"Van designed for moving goods.","value":"moving_van"},{"description":"Premium car.","value":"premium"},{"description":"Regular vehicle type.","value":"regular"},{"description":"Small to medium truck.","value":"small_medium_truck"},{"description":"Small sport utility vehicle.","value":"small_suv"},{"description":"Special vehicle type.","value":"special"},{"description":"Standard-sized car.","value":"standard"},{"description":"Stretch limousine.","value":"stretch"},{"description":"Subcompact car.","value":"subcompact"},{"description":"Taxi or for-hire vehicle.","value":"taxi"},{"description":"Truck with twelve-foot cargo space.","value":"twelve_foot_truck"},{"description":"Van with capacity for twelve passengers.","value":"twelve_passenger_van"},{"description":"Truck with twenty-foot cargo space.","value":"twenty_foot_truck"},{"description":"Truck with twenty-four-foot cargo space.","value":"twenty_four_foot_truck"},{"description":"Truck with twenty-six-foot cargo space.","value":"twenty_six_foot_truck"},{"description":"Unique or specialty vehicle.","value":"unique"}]}},"vehicle_class":{"type":"string","description":"Class of the rental vehicle.","enum":["business","economy","first_class","premium_economy"]},"vehicle_identification_number":{"maxLength":20,"type":"string","description":"Vehicle identification number (VIN)."}},"description":"Vehicle details for the rental.","x-stripeMostCommon":["make","model","odometer","type","vehicle_class","vehicle_identification_number"]}},"x-stripeMostCommon":["affiliate","booking_number","carrier_name","customer_service_phone_number","days_rented","distance","drivers","drop_off","insurances","no_show_indicator","pickup","renter_name","total","vehicle"]}},{"type":"string","enum":[""]}]},"customer_reference":{"description":"A unique value to identify the customer. This field is available only for card payments.\n\nThis field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"event_details":{"title":"event","required":["name"],"type":"object","properties":{"access_controlled_venue":{"type":"boolean","description":"Indicates if the tickets are digitally checked when entering the venue."},"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The event location's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"company":{"maxLength":5000,"type":"string","description":"The name of the company"},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"ends_at":{"type":"integer","description":"Event end time. Measured in seconds since the Unix epoch.","format":"unix-time"},"genre":{"maxLength":5000,"type":"string","description":"Type of the event entertainment (concert, sports event etc)"},"name":{"maxLength":5000,"type":"string","description":"The name of the event."},"starts_at":{"type":"integer","description":"Event start time. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Event details for this PaymentIntent","x-stripeMostCommon":["access_controlled_venue","address","affiliate","company","delivery","ends_at","genre","name","starts_at"]},"flight":{"title":"flight","required":["segments"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"agency_number":{"maxLength":8,"type":"string","description":"The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking."},"carrier":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"passenger_name":{"maxLength":26,"type":"string","description":"The name of the person or entity on the reservation."},"passengers":{"type":"array","description":"The details of the passengers in the travel reservation.","items":{"title":"flight_passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the flight reservation."}},"x-stripeMostCommon":["name"]}},"segments":{"type":"array","description":"The individual flight segments associated with the trip.","items":{"title":"flight_segment","required":["departs_at"],"type":"object","properties":{"amount":{"type":"integer","description":"The flight segment amount."},"arrival_airport":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) airport code for the arrival airport."},"arrives_at":{"type":"integer","description":"The arrival time for the flight segment. Measured in seconds since the Unix epoch.","format":"unix-time"},"carrier":{"maxLength":2,"type":"string","description":"The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment."},"departs_at":{"type":"integer","description":"The departure time for the flight segment. Measured in seconds since the Unix epoch.","format":"unix-time"},"departure_airport":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) airport code for the departure airport."},"flight_number":{"maxLength":4,"type":"string","description":"The flight number associated with the segment"},"service_class":{"type":"string","description":"The fare class for the segment.","enum":["business","economy","first","premium_economy"]}},"x-stripeMostCommon":["amount","arrival_airport","arrives_at","carrier","departs_at","departure_airport","flight_number","service_class"]}},"ticket_number":{"maxLength":14,"type":"string","description":"The ticket number associated with the travel reservation."}},"description":"Flight reservation details for this PaymentIntent","x-stripeMostCommon":["affiliate","agency_number","carrier","delivery","passenger_name","passengers","segments","ticket_number"]},"flight_data":{"description":"Flight data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"flight_data","required":["segments","total"],"type":"object","properties":{"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Name of affiliate partner."},"travel_authorization_code":{"maxLength":64,"type":"string","description":"Code provided by the company to a travel agent authorizing ticket issuance."}},"description":"Affiliate details if applicable.","x-stripeMostCommon":["code","name","travel_authorization_code"]},"booking_number":{"maxLength":255,"type":"string","description":"Reservation reference."},"computerized_reservation_system":{"maxLength":4,"type":"string","description":"Computerized reservation system used to make the reservation and purchase the ticket."},"endorsements_and_restrictions":{"maxLength":20,"type":"string","description":"Ticket restrictions."},"insurances":{"type":"array","description":"List of insurances.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Insurance cost."},"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Insurance company name."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance covering lost, damaged, or delayed baggage.","value":"baggage"},{"description":"Insurance covering losses due to airline bankruptcy.","value":"bankruptcy"},{"description":"Insurance covering flight cancellation.","value":"cancelation"},{"description":"Insurance covering general emergency situations.","value":"emergency"},{"description":"Insurance covering medical emergencies during travel.","value":"medical"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"passengers":{"type":"array","description":"List of passengers.","items":{"title":"passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":198,"type":"string","description":"Passenger's full name."}},"x-stripeMostCommon":["name"]}},"segments":{"type":"array","description":"List of flight segments.","items":{"title":"segment","required":["arrival","carrier_code","departure","service_class"],"type":"object","properties":{"amount":{"type":"integer","description":"Segment fare amount."},"arrival":{"title":"arrival","required":["airport"],"type":"object","properties":{"airport":{"maxLength":5000,"type":"string","description":"Arrival airport IATA code."},"arrives_at":{"type":"integer","description":"Arrival date/time.","format":"unix-time"},"city":{"maxLength":99,"type":"string","description":"Arrival city."},"country":{"maxLength":5000,"type":"string","description":"Arrival country."}},"description":"Arrival details.","x-stripeMostCommon":["airport","arrives_at","city","country"]},"carrier_code":{"maxLength":5000,"type":"string","description":"Airline carrier code."},"carrier_name":{"maxLength":25,"type":"string","description":"Carrier name."},"currency":{"type":"string","description":"Segment currency.","format":"currency"},"departure":{"title":"departure","required":["airport","departs_at"],"type":"object","properties":{"airport":{"maxLength":5000,"type":"string","description":"Departure airport IATA code."},"city":{"maxLength":99,"type":"string","description":"Departure city."},"country":{"maxLength":5000,"type":"string","description":"Departure country."},"departs_at":{"type":"integer","description":"Departure date/time.","format":"unix-time"}},"description":"Departure details.","x-stripeMostCommon":["airport","city","country","departs_at"]},"exchange_ticket_number":{"maxLength":20,"type":"string","description":"Exchange ticket number."},"fare_basis_code":{"maxLength":20,"type":"string","description":"Fare basis code."},"fees":{"type":"integer","description":"Additional fees."},"flight_number":{"maxLength":20,"type":"string","description":"Flight number."},"is_stop_over_indicator":{"type":"boolean","description":"Stopover indicator."},"refundable":{"type":"boolean","description":"Refundable ticket indicator."},"service_class":{"type":"string","description":"Class of service.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating.","value":"business"},{"description":"Economy class seating.","value":"economy"},{"description":"First class seating with premium amenities.","value":"first_class"},{"description":"Premium economy class with enhanced seating and services.","value":"premium_economy"}]}},"tax_amount":{"type":"integer","description":"Tax amount for segment."},"ticket_number":{"maxLength":20,"type":"string","description":"Ticket number."}},"x-stripeMostCommon":["amount","arrival","carrier_code","carrier_name","currency","departure","exchange_ticket_number","fare_basis_code","fees","flight_number","is_stop_over_indicator","refundable","service_class","tax_amount","ticket_number"]}},"ticket_electronically_issued_indicator":{"type":"boolean","description":"Electronic ticket indicator."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total flight amount."},"credit_reason":{"type":"string","description":"Reason for credit.","enum":["other","partial_ticket_refund","passenger_transport_ancillary_cancellation","ticket_and_ancillary_cancellation","ticket_cancellation"],"x-stripeEnum":{"kind":"open","values":[{"description":"Other credit reasons.","value":"other"},{"description":"Partial refund of the ticket cost.","value":"partial_ticket_refund"},{"description":"Cancellation of passenger transport and ancillary services.","value":"passenger_transport_ancillary_cancellation"},{"description":"Cancellation of both ticket and ancillary services.","value":"ticket_and_ancillary_cancellation"},{"description":"Cancellation of the ticket only.","value":"ticket_cancellation"}]}},"currency":{"type":"string","description":"Total currency.","format":"currency"},"discounts":{"title":"discounts","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."}},"description":"Discount details.","x-stripeMostCommon":["corporate_client_code"]},"extra_charges":{"type":"array","description":"Additional charges.","items":{"title":"extra_charge","type":"object","properties":{"amount":{"type":"integer","description":"Amount of additional charges."},"type":{"type":"string","description":"Type of additional charges.","enum":["additional_fees","ancillary_service_charges","exchange_fee"],"x-stripeEnum":{"kind":"open","values":[{"description":"Additional fees charged for the flight.","value":"additional_fees"},{"description":"Charges for ancillary services such as baggage, seat selection, or meals.","value":"ancillary_service_charges"},{"description":"Fee charged for exchanging or changing the ticket.","value":"exchange_fee"}]}}},"x-stripeMostCommon":["amount","type"]}},"tax":{"title":"tax","type":"object","properties":{"tax_items":{"type":"array","description":"Array of tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount."},"rate":{"type":"integer","description":"Tax rate."},"type":{"maxLength":40,"type":"string","description":"Type of tax."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown.","x-stripeMostCommon":["tax_items"]}},"description":"Total cost breakdown.","x-stripeMostCommon":["amount","credit_reason","currency","discounts","extra_charges","tax"]},"transaction_type":{"type":"string","description":"Type of flight transaction.","enum":["exchange_ticket","miscellaneous","refund","ticket_purchase"],"x-stripeEnum":{"kind":"open","values":[{"description":"Exchange or modification of an existing ticket.","value":"exchange_ticket"},{"description":"Other miscellaneous flight-related transactions.","value":"miscellaneous"},{"description":"Refund for a canceled or unused ticket.","value":"refund"},{"description":"Purchase of a new flight ticket.","value":"ticket_purchase"}]}}},"x-stripeMostCommon":["affiliate","booking_number","computerized_reservation_system","endorsements_and_restrictions","insurances","passengers","segments","ticket_electronically_issued_indicator","total","transaction_type"]}},{"type":"string","enum":[""]}]},"lodging":{"title":"lodging","required":["checkin_at","checkout_at"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The lodging location's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"adults":{"type":"integer","description":"The number of adults on the booking"},"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"booking_number":{"maxLength":100,"type":"string","description":"The booking number associated with the lodging reservation."},"category":{"type":"string","description":"The lodging category","enum":["hotel","vacation_rental"]},"checkin_at":{"type":"integer","description":"Lodging check-in time. Measured in seconds since the Unix epoch.","format":"unix-time"},"checkout_at":{"type":"integer","description":"Lodging check-out time. Measured in seconds since the Unix epoch.","format":"unix-time"},"customer_service_phone_number":{"type":"string","description":"The customer service phone number of the lodging company."},"daily_room_rate_amount":{"type":"integer","description":"The daily lodging room rate."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"extra_charges":{"type":"array","description":"List of additional charges being billed.","items":{"type":"string","enum":["gift_shop","laundry","mini_bar","other","restaurant","telephone"]}},"fire_safety_act_compliance":{"type":"boolean","description":"Indicates whether the lodging location is compliant with the Fire Safety Act."},"name":{"maxLength":100,"type":"string","description":"The name of the lodging location."},"no_show":{"type":"boolean","description":"Indicates if the customer did not keep their booking while failing to cancel the reservation."},"number_of_rooms":{"type":"integer","description":"The number of rooms on the booking"},"passengers":{"type":"array","description":"The details of the passengers in the travel reservation","items":{"title":"lodging_passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the lodging reservation."}},"x-stripeMostCommon":["name"]}},"property_phone_number":{"type":"string","description":"The phone number of the lodging location."},"room_class":{"maxLength":5000,"type":"string","description":"The room class for this purchase."},"room_nights":{"type":"integer","description":"The number of room nights"},"total_room_tax_amount":{"type":"integer","description":"The total tax amount associating with the room reservation."},"total_tax_amount":{"type":"integer","description":"The total tax amount"}},"description":"Lodging reservation details for this PaymentIntent","x-stripeMostCommon":["address","adults","affiliate","booking_number","category","checkin_at","checkout_at","customer_service_phone_number","daily_room_rate_amount","delivery","extra_charges","fire_safety_act_compliance","name","no_show","number_of_rooms","passengers","property_phone_number","room_class","room_nights","total_room_tax_amount","total_tax_amount"]},"lodging_data":{"description":"Lodging data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"lodging_data","required":["checkin_at","checkout_at","total"],"type":"object","properties":{"accommodation":{"title":"accommodation","type":"object","properties":{"accommodation_type":{"type":"string","description":"Type of accommodation.","enum":["apartment","cabana","house","penthouse","room","standard","suite","villa"],"x-stripeEnum":{"kind":"open","values":[{"description":"A self-contained apartment unit.","value":"apartment"},{"description":"A cabana or small cabin.","value":"cabana"},{"description":"A standalone house.","value":"house"},{"description":"A penthouse or top-floor luxury accommodation.","value":"penthouse"},{"description":"A standard room.","value":"room"},{"description":"A standard accommodation type.","value":"standard"},{"description":"A suite with multiple rooms or enhanced amenities.","value":"suite"},{"description":"A villa or luxury residence.","value":"villa"}]}},"bed_type":{"maxLength":20,"type":"string","description":"Bed type."},"daily_rate_amount":{"type":"integer","description":"Daily accommodation rate in cents."},"nights":{"type":"integer","description":"Number of nights."},"number_of_rooms":{"type":"integer","description":"Number of rooms, cabanas, apartments, and so on."},"rate_type":{"maxLength":20,"type":"string","description":"Rate type."},"smoking_indicator":{"type":"boolean","description":"Whether smoking is allowed."}},"description":"Accommodation details for the lodging.","x-stripeMostCommon":["accommodation_type","bed_type","daily_rate_amount","nights","number_of_rooms","rate_type","smoking_indicator"]},"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Affiliate partner name."}},"description":"Affiliate details if applicable.","x-stripeMostCommon":["code","name"]},"booking_number":{"maxLength":255,"type":"string","description":"Booking confirmation number for the lodging."},"checkin_at":{"type":"integer","description":"Check-in date.","format":"unix-time"},"checkout_at":{"type":"integer","description":"Check-out date.","format":"unix-time"},"customer_service_phone_number":{"type":"string","description":"Customer service phone number for the lodging company."},"fire_safety_act_compliance_indicator":{"type":"boolean","description":"Whether the lodging is compliant with any hotel fire safety regulations."},"guests":{"type":"array","description":"List of guests for the lodging.","items":{"title":"guest","required":["name"],"type":"object","properties":{"name":{"maxLength":198,"type":"string","description":"Guest's full name."}},"x-stripeMostCommon":["name"]}},"host":{"title":"host","type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the host.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"country_of_domicile":{"maxLength":5000,"type":"string","description":"Host's country of domicile."},"host_reference":{"maxLength":255,"type":"string","description":"Reference number for the host."},"host_type":{"type":"string","description":"Type of host.","enum":["hostel","hotel","owner","rental_agency"],"x-stripeEnum":{"kind":"open","values":[{"description":"A hostel or shared accommodation facility.","value":"hostel"},{"description":"A hotel or hotel chain.","value":"hotel"},{"description":"The property owner directly managing the rental.","value":"owner"},{"description":"A rental agency managing the property.","value":"rental_agency"}]}},"name":{"maxLength":255,"type":"string","description":"Name of the lodging property or host."},"number_of_reservations":{"type":"integer","description":"Total number of reservations for the host."},"property_phone_number":{"type":"string","description":"Property phone number."},"registered_at":{"type":"integer","description":"Host's registration date.","format":"unix-time"}},"description":"Host details for the lodging.","x-stripeMostCommon":["address","country_of_domicile","host_reference","host_type","name","number_of_reservations","property_phone_number","registered_at"]},"insurances":{"type":"array","description":"List of insurances for the lodging.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Price of the insurance coverage in cents."},"currency":{"type":"string","description":"Currency of the insurance amount.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the insurance company."},"insurance_type":{"type":"string","description":"Type of insurance coverage.","enum":["bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance covering losses due to provider bankruptcy.","value":"bankruptcy"},{"description":"Insurance covering cancellation.","value":"cancelation"},{"description":"Insurance covering general emergency situations.","value":"emergency"},{"description":"Insurance covering medical emergencies during the stay.","value":"medical"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"no_show_indicator":{"type":"boolean","description":"Whether the renter is a no-show."},"renter_id_number":{"maxLength":25,"type":"string","description":"Renter ID number for the lodging."},"renter_name":{"maxLength":198,"type":"string","description":"Renter name for the lodging."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total price of the lodging reservation in cents."},"cash_advances":{"type":"integer","description":"Cash advances in cents."},"currency":{"type":"string","description":"Currency of the total amount.","format":"currency"},"discounts":{"title":"discount","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."},"coupon":{"maxLength":25,"type":"string","description":"Coupon code."}},"description":"Discount details for the lodging.","x-stripeMostCommon":["corporate_client_code","coupon"]},"extra_charges":{"type":"array","description":"Additional charges for the lodging.","items":{"title":"extra_charge","type":"object","properties":{"amount":{"type":"integer","description":"Amount of the extra charge in cents."},"type":{"type":"string","description":"Type of extra charge.","enum":["gift_shop","laundry","mini_bar","other","phone","restaurant"],"x-stripeEnum":{"kind":"open","values":[{"description":"Charges for gift shop purchases.","value":"gift_shop"},{"description":"Charges for laundry or cleaning services.","value":"laundry"},{"description":"Charges for mini bar consumption.","value":"mini_bar"},{"description":"Other miscellaneous charges.","value":"other"},{"description":"Charges for telephone services.","value":"phone"},{"description":"Charges for dining or food services.","value":"restaurant"}]}}},"x-stripeMostCommon":["amount","type"]}},"prepaid_amount":{"type":"integer","description":"Prepaid amount in cents."},"tax":{"title":"tax","type":"object","properties":{"tax_exempt_indicator":{"type":"boolean","description":"Indicates whether the transaction is tax exempt."},"tax_items":{"type":"array","description":"Tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount in cents."},"rate":{"type":"integer","description":"Tax rate."},"type":{"maxLength":40,"type":"string","description":"Type of tax applied."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown for the lodging reservation.","x-stripeMostCommon":["tax_exempt_indicator","tax_items"]}},"description":"Total details for the lodging.","x-stripeMostCommon":["amount","cash_advances","currency","discounts","extra_charges","prepaid_amount","tax"]}},"x-stripeMostCommon":["accommodation","affiliate","booking_number","checkin_at","checkout_at","customer_service_phone_number","fire_safety_act_compliance_indicator","guests","host","insurances","no_show_indicator","renter_id_number","renter_name","total"]}},{"type":"string","enum":[""]}]},"order_reference":{"description":"A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.\n\nFor Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"subscription":{"title":"subscription","required":["name"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"auto_renewal":{"type":"boolean","description":"Info whether the subscription will be auto renewed upon expiry."},"billing_interval":{"title":"subscription_billing_interval","required":["count","interval"],"type":"object","properties":{"count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."},"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]}},"description":"Subscription billing details for this purchase.","x-stripeMostCommon":["count","interval"]},"ends_at":{"type":"integer","description":"Subscription end time. Measured in seconds since the Unix epoch.","format":"unix-time"},"name":{"maxLength":5000,"type":"string","description":"Name of the product on subscription. e.g. Apple Music Subscription"},"starts_at":{"type":"integer","description":"Subscription start time. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Subscription details for this PaymentIntent","x-stripeMostCommon":["affiliate","auto_renewal","billing_interval","ends_at","name","starts_at"]}},"description":"Provides industry-specific information about the charge.","x-stripeMostCommon":["car_rental","car_rental_data","event_details","fleet_data","flight","flight_data","healthcare","lodging","lodging_data","subscription"]},"receipt_email":{"maxLength":5000,"type":"string","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."},"shipping":{"title":"optional_fields_shipping","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"carrier":{"maxLength":5000,"type":"string","description":"The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."},"name":{"maxLength":5000,"type":"string","description":"Recipient name."},"phone":{"maxLength":5000,"type":"string","description":"Recipient phone (including extension)."},"tracking_number":{"maxLength":5000,"type":"string","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."}},"description":"Shipping information for the charge. Helps prevent fraud on charges for physical goods.","x-stripeMostCommon":["address","carrier","name","phone","tracking_number"]},"transfer_group":{"type":"string","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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details."}},"additionalProperties":false,"x-stripeMostCommon":["customer","description","metadata","receipt_email","shipping"]},"encoding":{"expand":{"style":"deepObject","explode":true},"fraud_details":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true},"shipping":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/charge"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_charge"}},"/v1/charges/{charge}/capture":{"post":{"summary":"Capture a charge","description":"This method is deprecated and will be removed soon. If your integration uses it, you need to update it to use a different payment flow, such as the Payment Intents API.
","operationId":"PostChargesChargeCapture","parameters":[{"name":"charge","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"The amount to capture, which must be less than or equal to the original amount."},"application_fee":{"type":"integer","description":"An application fee to add on to this charge."},"application_fee_amount":{"type":"integer","description":"An application fee amount to add on to this charge, which must be less than or equal to the original amount."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_details":{"title":"payment_details_charge_params","type":"object","properties":{"car_rental":{"title":"car_rental","required":["booking_number","days_rented","pickup_at","return_at"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"booking_number":{"maxLength":100,"type":"string","description":"The booking number associated with the car rental."},"car_class_code":{"maxLength":4,"type":"string","description":"Class code of the car."},"car_make":{"maxLength":10,"type":"string","description":"Make of the car."},"car_model":{"maxLength":10,"type":"string","description":"Model of the car."},"company":{"maxLength":26,"type":"string","description":"The name of the rental car company."},"customer_service_phone_number":{"maxLength":16,"type":"string","description":"The customer service phone number of the car rental company."},"days_rented":{"type":"integer","description":"Number of days the car is being rented."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"distance":{"title":"car_rental_distance","type":"object","properties":{"amount":{"type":"integer","description":"Distance traveled."},"unit":{"type":"string","description":"Unit of measurement for the distance traveled. One of `miles` or `kilometers`.","enum":["kilometers","miles"]}},"description":"The details of the distance traveled during the rental period.","x-stripeMostCommon":["amount","unit"]},"drivers":{"type":"array","description":"The details of the passengers in the travel reservation","items":{"title":"car_rental_driver","required":["name"],"type":"object","properties":{"driver_identification_number":{"maxLength":20,"type":"string","description":"Driver's identification number."},"driver_tax_number":{"maxLength":20,"type":"string","description":"Driver's tax number."},"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the car reservation."}},"x-stripeMostCommon":["driver_identification_number","driver_tax_number","name"]}},"extra_charges":{"type":"array","description":"List of additional charges being billed.","items":{"type":"string","enum":["extra_mileage","gas","late_return","one_way_service","parking_violation"]}},"no_show":{"type":"boolean","description":"Indicates if the customer did not keep nor cancel their booking."},"pickup_address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Car pick-up address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"pickup_at":{"type":"integer","description":"Car pick-up time. Measured in seconds since the Unix epoch.","format":"unix-time"},"pickup_location_name":{"maxLength":38,"type":"string","description":"Name of the pickup location."},"rate_amount":{"type":"integer","description":"Rental rate."},"rate_interval":{"type":"string","description":"The frequency at which the rate amount is applied. One of `day`, `week` or `month`","enum":["day","month","week"]},"renter_name":{"maxLength":100,"type":"string","description":"The name of the person or entity renting the car."},"return_address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Car return address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"return_at":{"type":"integer","description":"Car return time. Measured in seconds since the Unix epoch.","format":"unix-time"},"return_location_name":{"maxLength":38,"type":"string","description":"Name of the return location."},"tax_exempt":{"type":"boolean","description":"Indicates whether the goods or services are tax-exempt or tax is not collected."},"vehicle_identification_number":{"maxLength":20,"type":"string","description":"The vehicle identification number."}},"description":"Car rental details for this PaymentIntent.","x-stripeMostCommon":["affiliate","booking_number","car_class_code","car_make","car_model","company","customer_service_phone_number","days_rented","delivery","distance","drivers","extra_charges","no_show","pickup_address","pickup_at","pickup_location_name","rate_amount","rate_interval","renter_name","return_address","return_at","return_location_name","tax_exempt","vehicle_identification_number"]},"car_rental_data":{"description":"Car rental data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"car_rental_data","required":["drop_off","pickup","total"],"type":"object","properties":{"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Name of affiliate partner."}},"description":"Affiliate (such as travel agency) details for the rental.","x-stripeMostCommon":["code","name"]},"booking_number":{"maxLength":255,"type":"string","description":"Booking confirmation number for the car rental."},"carrier_name":{"maxLength":255,"type":"string","description":"Name of the car rental company."},"customer_service_phone_number":{"type":"string","description":"Customer service phone number for the car rental company."},"days_rented":{"type":"integer","description":"Number of days the car is being rented."},"distance":{"title":"distance","required":["amount","unit"],"type":"object","properties":{"amount":{"type":"integer","description":"Distance traveled."},"unit":{"type":"string","description":"Unit of measurement for the distance traveled. One of `miles` or `kilometers`.","enum":["kilometers","miles"]}},"description":"Distance details for the rental.","x-stripeMostCommon":["amount","unit"]},"drivers":{"type":"array","description":"List of drivers for the rental.","items":{"title":"driver","required":["name"],"type":"object","properties":{"date_of_birth":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"Day of birth (1-31)."},"month":{"type":"integer","description":"Month of birth (1-12)."},"year":{"type":"integer","description":"Year of birth (must be greater than 1900)."}},"description":"Driver's date of birth.","x-stripeMostCommon":["day","month","year"]},"driver_identification_number":{"maxLength":20,"type":"string","description":"Driver's identification number."},"driver_tax_number":{"maxLength":20,"type":"string","description":"Driver's tax number."},"name":{"maxLength":198,"type":"string","description":"Driver's full name."}},"x-stripeMostCommon":["date_of_birth","driver_identification_number","driver_tax_number","name"]}},"drop_off":{"title":"location","required":["address","time"],"type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the rental location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"location_name":{"maxLength":38,"type":"string","description":"Location name."},"time":{"type":"integer","description":"Timestamp for the location.","format":"unix-time"}},"description":"Drop-off location details.","x-stripeMostCommon":["address","location_name","time"]},"insurances":{"type":"array","description":"Insurance details for the rental.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount of the insurance coverage in cents."},"currency":{"type":"string","description":"Currency of the insurance amount.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the insurance company."},"insurance_type":{"type":"string","description":"Type of insurance coverage.","enum":["liability_supplement","loss_damage_waiver","other","partial_damage_waiver","personal_accident","personal_effects"],"x-stripeEnum":{"kind":"open","values":[{"description":"Supplemental liability insurance coverage.","value":"liability_supplement"},{"description":"Agreement waiving responsibility for loss or damage to the vehicle.","value":"loss_damage_waiver"},{"description":"Other types of insurance coverage.","value":"other"},{"description":"Agreement limiting responsibility for loss or damage to the vehicle.","value":"partial_damage_waiver"},{"description":"Insurance covering personal accidents during the rental period.","value":"personal_accident"},{"description":"Insurance covering personal belongings during the rental period.","value":"personal_effects"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"no_show_indicator":{"type":"boolean","description":"Indicates if the customer was a no-show."},"pickup":{"title":"location","required":["address","time"],"type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the rental location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"location_name":{"maxLength":38,"type":"string","description":"Location name."},"time":{"type":"integer","description":"Timestamp for the location.","format":"unix-time"}},"description":"Pickup location details.","x-stripeMostCommon":["address","location_name","time"]},"renter_name":{"maxLength":198,"type":"string","description":"Name of the person renting the vehicle."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total amount in cents."},"currency":{"type":"string","description":"Currency of the amount.","format":"currency"},"discounts":{"title":"discounts","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."},"coupon":{"maxLength":25,"type":"string","description":"Coupon code applied to the rental."},"maximum_free_miles_or_kilometers":{"type":"integer","description":"Maximum number of free miles or kilometers included."}},"description":"Discount details for the rental.","x-stripeMostCommon":["corporate_client_code","coupon","maximum_free_miles_or_kilometers"]},"extra_charges":{"type":"array","description":"Additional charges for the rental.","items":{"title":"extra_charge","required":["amount","type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount of the extra charge in cents."},"type":{"type":"string","description":"Type of extra charge.","enum":["extra_mileage","gas","gps","late_charge","one_way_drop_off","other","parking","phone","regular_mileage","towing"]}},"x-stripeMostCommon":["amount","type"]}},"rate_per_unit":{"type":"integer","description":"Rate per unit for the rental."},"rate_unit":{"type":"string","description":"Unit of measurement for the rate.","enum":["days","kilometers","miles","months","weeks"],"x-stripeEnum":{"kind":"open","values":[{"description":"Rental rate charged per day.","value":"days"},{"description":"Rental rate charged per kilometer.","value":"kilometers"},{"description":"Rental rate charged per mile.","value":"miles"},{"description":"Rental rate charged per month.","value":"months"},{"description":"Rental rate charged per week.","value":"weeks"}]}},"tax":{"title":"tax","type":"object","properties":{"tax_exempt_indicator":{"type":"boolean","description":"Indicates if the transaction is tax exempt."},"tax_items":{"type":"array","description":"Array of tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount."},"rate":{"type":"integer","description":"Tax rate applied."},"type":{"maxLength":40,"type":"string","description":"Type of tax applied."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown for the rental.","x-stripeMostCommon":["tax_exempt_indicator","tax_items"]}},"description":"Total cost breakdown for the rental.","x-stripeMostCommon":["amount","currency","discounts","extra_charges","rate_per_unit","rate_unit","tax"]},"vehicle":{"title":"vehicle","type":"object","properties":{"make":{"maxLength":40,"type":"string","description":"Make of the rental vehicle."},"model":{"maxLength":40,"type":"string","description":"Model of the rental vehicle."},"odometer":{"type":"integer","description":"Odometer reading at the time of rental."},"type":{"type":"string","description":"Type of the rental vehicle.","enum":["cargo_van","compact","economy","exotic","exotic_suv","fifteen_passenger_van","four_wheel_drive","full_size","intermediate","large_suv","large_truck","luxury","medium_suv","midsize","mini","minivan","miscellaneous","moped","moving_van","premium","regular","small_medium_truck","small_suv","special","standard","stretch","subcompact","taxi","twelve_foot_truck","twelve_passenger_van","twenty_foot_truck","twenty_four_foot_truck","twenty_six_foot_truck","unique"],"x-stripeEnum":{"kind":"open","values":[{"description":"Van designed for cargo transport.","value":"cargo_van"},{"description":"Compact car.","value":"compact"},{"description":"Economy-class car.","value":"economy"},{"description":"Exotic or high-performance vehicle.","value":"exotic"},{"description":"Exotic or luxury sport utility vehicle.","value":"exotic_suv"},{"description":"Van with capacity for fifteen passengers.","value":"fifteen_passenger_van"},{"description":"Four-wheel-drive vehicle.","value":"four_wheel_drive"},{"description":"Full-sized car.","value":"full_size"},{"description":"Intermediate-sized car.","value":"intermediate"},{"description":"Large sport utility vehicle.","value":"large_suv"},{"description":"Large truck.","value":"large_truck"},{"description":"Luxury car.","value":"luxury"},{"description":"Medium sport utility vehicle.","value":"medium_suv"},{"description":"Midsize car.","value":"midsize"},{"description":"Mini-sized car.","value":"mini"},{"description":"Minivan.","value":"minivan"},{"description":"Other miscellaneous vehicle types.","value":"miscellaneous"},{"description":"Moped or motorized scooter.","value":"moped"},{"description":"Van designed for moving goods.","value":"moving_van"},{"description":"Premium car.","value":"premium"},{"description":"Regular vehicle type.","value":"regular"},{"description":"Small to medium truck.","value":"small_medium_truck"},{"description":"Small sport utility vehicle.","value":"small_suv"},{"description":"Special vehicle type.","value":"special"},{"description":"Standard-sized car.","value":"standard"},{"description":"Stretch limousine.","value":"stretch"},{"description":"Subcompact car.","value":"subcompact"},{"description":"Taxi or for-hire vehicle.","value":"taxi"},{"description":"Truck with twelve-foot cargo space.","value":"twelve_foot_truck"},{"description":"Van with capacity for twelve passengers.","value":"twelve_passenger_van"},{"description":"Truck with twenty-foot cargo space.","value":"twenty_foot_truck"},{"description":"Truck with twenty-four-foot cargo space.","value":"twenty_four_foot_truck"},{"description":"Truck with twenty-six-foot cargo space.","value":"twenty_six_foot_truck"},{"description":"Unique or specialty vehicle.","value":"unique"}]}},"vehicle_class":{"type":"string","description":"Class of the rental vehicle.","enum":["business","economy","first_class","premium_economy"]},"vehicle_identification_number":{"maxLength":20,"type":"string","description":"Vehicle identification number (VIN)."}},"description":"Vehicle details for the rental.","x-stripeMostCommon":["make","model","odometer","type","vehicle_class","vehicle_identification_number"]}},"x-stripeMostCommon":["affiliate","booking_number","carrier_name","customer_service_phone_number","days_rented","distance","drivers","drop_off","insurances","no_show_indicator","pickup","renter_name","total","vehicle"]}},{"type":"string","enum":[""]}]},"customer_reference":{"description":"A unique value to identify the customer. This field is available only for card payments.\n\nThis field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"event_details":{"title":"event","required":["name"],"type":"object","properties":{"access_controlled_venue":{"type":"boolean","description":"Indicates if the tickets are digitally checked when entering the venue."},"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The event location's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"company":{"maxLength":5000,"type":"string","description":"The name of the company"},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"ends_at":{"type":"integer","description":"Event end time. Measured in seconds since the Unix epoch.","format":"unix-time"},"genre":{"maxLength":5000,"type":"string","description":"Type of the event entertainment (concert, sports event etc)"},"name":{"maxLength":5000,"type":"string","description":"The name of the event."},"starts_at":{"type":"integer","description":"Event start time. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Event details for this PaymentIntent","x-stripeMostCommon":["access_controlled_venue","address","affiliate","company","delivery","ends_at","genre","name","starts_at"]},"flight":{"title":"flight","required":["segments"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"agency_number":{"maxLength":8,"type":"string","description":"The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking."},"carrier":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"passenger_name":{"maxLength":26,"type":"string","description":"The name of the person or entity on the reservation."},"passengers":{"type":"array","description":"The details of the passengers in the travel reservation.","items":{"title":"flight_passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the flight reservation."}},"x-stripeMostCommon":["name"]}},"segments":{"type":"array","description":"The individual flight segments associated with the trip.","items":{"title":"flight_segment","required":["departs_at"],"type":"object","properties":{"amount":{"type":"integer","description":"The flight segment amount."},"arrival_airport":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) airport code for the arrival airport."},"arrives_at":{"type":"integer","description":"The arrival time for the flight segment. Measured in seconds since the Unix epoch.","format":"unix-time"},"carrier":{"maxLength":2,"type":"string","description":"The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment."},"departs_at":{"type":"integer","description":"The departure time for the flight segment. Measured in seconds since the Unix epoch.","format":"unix-time"},"departure_airport":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) airport code for the departure airport."},"flight_number":{"maxLength":4,"type":"string","description":"The flight number associated with the segment"},"service_class":{"type":"string","description":"The fare class for the segment.","enum":["business","economy","first","premium_economy"]}},"x-stripeMostCommon":["amount","arrival_airport","arrives_at","carrier","departs_at","departure_airport","flight_number","service_class"]}},"ticket_number":{"maxLength":14,"type":"string","description":"The ticket number associated with the travel reservation."}},"description":"Flight reservation details for this PaymentIntent","x-stripeMostCommon":["affiliate","agency_number","carrier","delivery","passenger_name","passengers","segments","ticket_number"]},"flight_data":{"description":"Flight data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"flight_data","required":["segments","total"],"type":"object","properties":{"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Name of affiliate partner."},"travel_authorization_code":{"maxLength":64,"type":"string","description":"Code provided by the company to a travel agent authorizing ticket issuance."}},"description":"Affiliate details if applicable.","x-stripeMostCommon":["code","name","travel_authorization_code"]},"booking_number":{"maxLength":255,"type":"string","description":"Reservation reference."},"computerized_reservation_system":{"maxLength":4,"type":"string","description":"Computerized reservation system used to make the reservation and purchase the ticket."},"endorsements_and_restrictions":{"maxLength":20,"type":"string","description":"Ticket restrictions."},"insurances":{"type":"array","description":"List of insurances.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Insurance cost."},"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Insurance company name."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance covering lost, damaged, or delayed baggage.","value":"baggage"},{"description":"Insurance covering losses due to airline bankruptcy.","value":"bankruptcy"},{"description":"Insurance covering flight cancellation.","value":"cancelation"},{"description":"Insurance covering general emergency situations.","value":"emergency"},{"description":"Insurance covering medical emergencies during travel.","value":"medical"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"passengers":{"type":"array","description":"List of passengers.","items":{"title":"passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":198,"type":"string","description":"Passenger's full name."}},"x-stripeMostCommon":["name"]}},"segments":{"type":"array","description":"List of flight segments.","items":{"title":"segment","required":["arrival","carrier_code","departure","service_class"],"type":"object","properties":{"amount":{"type":"integer","description":"Segment fare amount."},"arrival":{"title":"arrival","required":["airport"],"type":"object","properties":{"airport":{"maxLength":5000,"type":"string","description":"Arrival airport IATA code."},"arrives_at":{"type":"integer","description":"Arrival date/time.","format":"unix-time"},"city":{"maxLength":99,"type":"string","description":"Arrival city."},"country":{"maxLength":5000,"type":"string","description":"Arrival country."}},"description":"Arrival details.","x-stripeMostCommon":["airport","arrives_at","city","country"]},"carrier_code":{"maxLength":5000,"type":"string","description":"Airline carrier code."},"carrier_name":{"maxLength":25,"type":"string","description":"Carrier name."},"currency":{"type":"string","description":"Segment currency.","format":"currency"},"departure":{"title":"departure","required":["airport","departs_at"],"type":"object","properties":{"airport":{"maxLength":5000,"type":"string","description":"Departure airport IATA code."},"city":{"maxLength":99,"type":"string","description":"Departure city."},"country":{"maxLength":5000,"type":"string","description":"Departure country."},"departs_at":{"type":"integer","description":"Departure date/time.","format":"unix-time"}},"description":"Departure details.","x-stripeMostCommon":["airport","city","country","departs_at"]},"exchange_ticket_number":{"maxLength":20,"type":"string","description":"Exchange ticket number."},"fare_basis_code":{"maxLength":20,"type":"string","description":"Fare basis code."},"fees":{"type":"integer","description":"Additional fees."},"flight_number":{"maxLength":20,"type":"string","description":"Flight number."},"is_stop_over_indicator":{"type":"boolean","description":"Stopover indicator."},"refundable":{"type":"boolean","description":"Refundable ticket indicator."},"service_class":{"type":"string","description":"Class of service.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating.","value":"business"},{"description":"Economy class seating.","value":"economy"},{"description":"First class seating with premium amenities.","value":"first_class"},{"description":"Premium economy class with enhanced seating and services.","value":"premium_economy"}]}},"tax_amount":{"type":"integer","description":"Tax amount for segment."},"ticket_number":{"maxLength":20,"type":"string","description":"Ticket number."}},"x-stripeMostCommon":["amount","arrival","carrier_code","carrier_name","currency","departure","exchange_ticket_number","fare_basis_code","fees","flight_number","is_stop_over_indicator","refundable","service_class","tax_amount","ticket_number"]}},"ticket_electronically_issued_indicator":{"type":"boolean","description":"Electronic ticket indicator."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total flight amount."},"credit_reason":{"type":"string","description":"Reason for credit.","enum":["other","partial_ticket_refund","passenger_transport_ancillary_cancellation","ticket_and_ancillary_cancellation","ticket_cancellation"],"x-stripeEnum":{"kind":"open","values":[{"description":"Other credit reasons.","value":"other"},{"description":"Partial refund of the ticket cost.","value":"partial_ticket_refund"},{"description":"Cancellation of passenger transport and ancillary services.","value":"passenger_transport_ancillary_cancellation"},{"description":"Cancellation of both ticket and ancillary services.","value":"ticket_and_ancillary_cancellation"},{"description":"Cancellation of the ticket only.","value":"ticket_cancellation"}]}},"currency":{"type":"string","description":"Total currency.","format":"currency"},"discounts":{"title":"discounts","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."}},"description":"Discount details.","x-stripeMostCommon":["corporate_client_code"]},"extra_charges":{"type":"array","description":"Additional charges.","items":{"title":"extra_charge","type":"object","properties":{"amount":{"type":"integer","description":"Amount of additional charges."},"type":{"type":"string","description":"Type of additional charges.","enum":["additional_fees","ancillary_service_charges","exchange_fee"],"x-stripeEnum":{"kind":"open","values":[{"description":"Additional fees charged for the flight.","value":"additional_fees"},{"description":"Charges for ancillary services such as baggage, seat selection, or meals.","value":"ancillary_service_charges"},{"description":"Fee charged for exchanging or changing the ticket.","value":"exchange_fee"}]}}},"x-stripeMostCommon":["amount","type"]}},"tax":{"title":"tax","type":"object","properties":{"tax_items":{"type":"array","description":"Array of tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount."},"rate":{"type":"integer","description":"Tax rate."},"type":{"maxLength":40,"type":"string","description":"Type of tax."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown.","x-stripeMostCommon":["tax_items"]}},"description":"Total cost breakdown.","x-stripeMostCommon":["amount","credit_reason","currency","discounts","extra_charges","tax"]},"transaction_type":{"type":"string","description":"Type of flight transaction.","enum":["exchange_ticket","miscellaneous","refund","ticket_purchase"],"x-stripeEnum":{"kind":"open","values":[{"description":"Exchange or modification of an existing ticket.","value":"exchange_ticket"},{"description":"Other miscellaneous flight-related transactions.","value":"miscellaneous"},{"description":"Refund for a canceled or unused ticket.","value":"refund"},{"description":"Purchase of a new flight ticket.","value":"ticket_purchase"}]}}},"x-stripeMostCommon":["affiliate","booking_number","computerized_reservation_system","endorsements_and_restrictions","insurances","passengers","segments","ticket_electronically_issued_indicator","total","transaction_type"]}},{"type":"string","enum":[""]}]},"lodging":{"title":"lodging","required":["checkin_at","checkout_at"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The lodging location's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"adults":{"type":"integer","description":"The number of adults on the booking"},"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"booking_number":{"maxLength":100,"type":"string","description":"The booking number associated with the lodging reservation."},"category":{"type":"string","description":"The lodging category","enum":["hotel","vacation_rental"]},"checkin_at":{"type":"integer","description":"Lodging check-in time. Measured in seconds since the Unix epoch.","format":"unix-time"},"checkout_at":{"type":"integer","description":"Lodging check-out time. Measured in seconds since the Unix epoch.","format":"unix-time"},"customer_service_phone_number":{"type":"string","description":"The customer service phone number of the lodging company."},"daily_room_rate_amount":{"type":"integer","description":"The daily lodging room rate."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"extra_charges":{"type":"array","description":"List of additional charges being billed.","items":{"type":"string","enum":["gift_shop","laundry","mini_bar","other","restaurant","telephone"]}},"fire_safety_act_compliance":{"type":"boolean","description":"Indicates whether the lodging location is compliant with the Fire Safety Act."},"name":{"maxLength":100,"type":"string","description":"The name of the lodging location."},"no_show":{"type":"boolean","description":"Indicates if the customer did not keep their booking while failing to cancel the reservation."},"number_of_rooms":{"type":"integer","description":"The number of rooms on the booking"},"passengers":{"type":"array","description":"The details of the passengers in the travel reservation","items":{"title":"lodging_passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the lodging reservation."}},"x-stripeMostCommon":["name"]}},"property_phone_number":{"type":"string","description":"The phone number of the lodging location."},"room_class":{"maxLength":5000,"type":"string","description":"The room class for this purchase."},"room_nights":{"type":"integer","description":"The number of room nights"},"total_room_tax_amount":{"type":"integer","description":"The total tax amount associating with the room reservation."},"total_tax_amount":{"type":"integer","description":"The total tax amount"}},"description":"Lodging reservation details for this PaymentIntent","x-stripeMostCommon":["address","adults","affiliate","booking_number","category","checkin_at","checkout_at","customer_service_phone_number","daily_room_rate_amount","delivery","extra_charges","fire_safety_act_compliance","name","no_show","number_of_rooms","passengers","property_phone_number","room_class","room_nights","total_room_tax_amount","total_tax_amount"]},"lodging_data":{"description":"Lodging data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"lodging_data","required":["checkin_at","checkout_at","total"],"type":"object","properties":{"accommodation":{"title":"accommodation","type":"object","properties":{"accommodation_type":{"type":"string","description":"Type of accommodation.","enum":["apartment","cabana","house","penthouse","room","standard","suite","villa"],"x-stripeEnum":{"kind":"open","values":[{"description":"A self-contained apartment unit.","value":"apartment"},{"description":"A cabana or small cabin.","value":"cabana"},{"description":"A standalone house.","value":"house"},{"description":"A penthouse or top-floor luxury accommodation.","value":"penthouse"},{"description":"A standard room.","value":"room"},{"description":"A standard accommodation type.","value":"standard"},{"description":"A suite with multiple rooms or enhanced amenities.","value":"suite"},{"description":"A villa or luxury residence.","value":"villa"}]}},"bed_type":{"maxLength":20,"type":"string","description":"Bed type."},"daily_rate_amount":{"type":"integer","description":"Daily accommodation rate in cents."},"nights":{"type":"integer","description":"Number of nights."},"number_of_rooms":{"type":"integer","description":"Number of rooms, cabanas, apartments, and so on."},"rate_type":{"maxLength":20,"type":"string","description":"Rate type."},"smoking_indicator":{"type":"boolean","description":"Whether smoking is allowed."}},"description":"Accommodation details for the lodging.","x-stripeMostCommon":["accommodation_type","bed_type","daily_rate_amount","nights","number_of_rooms","rate_type","smoking_indicator"]},"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Affiliate partner name."}},"description":"Affiliate details if applicable.","x-stripeMostCommon":["code","name"]},"booking_number":{"maxLength":255,"type":"string","description":"Booking confirmation number for the lodging."},"checkin_at":{"type":"integer","description":"Check-in date.","format":"unix-time"},"checkout_at":{"type":"integer","description":"Check-out date.","format":"unix-time"},"customer_service_phone_number":{"type":"string","description":"Customer service phone number for the lodging company."},"fire_safety_act_compliance_indicator":{"type":"boolean","description":"Whether the lodging is compliant with any hotel fire safety regulations."},"guests":{"type":"array","description":"List of guests for the lodging.","items":{"title":"guest","required":["name"],"type":"object","properties":{"name":{"maxLength":198,"type":"string","description":"Guest's full name."}},"x-stripeMostCommon":["name"]}},"host":{"title":"host","type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the host.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"country_of_domicile":{"maxLength":5000,"type":"string","description":"Host's country of domicile."},"host_reference":{"maxLength":255,"type":"string","description":"Reference number for the host."},"host_type":{"type":"string","description":"Type of host.","enum":["hostel","hotel","owner","rental_agency"],"x-stripeEnum":{"kind":"open","values":[{"description":"A hostel or shared accommodation facility.","value":"hostel"},{"description":"A hotel or hotel chain.","value":"hotel"},{"description":"The property owner directly managing the rental.","value":"owner"},{"description":"A rental agency managing the property.","value":"rental_agency"}]}},"name":{"maxLength":255,"type":"string","description":"Name of the lodging property or host."},"number_of_reservations":{"type":"integer","description":"Total number of reservations for the host."},"property_phone_number":{"type":"string","description":"Property phone number."},"registered_at":{"type":"integer","description":"Host's registration date.","format":"unix-time"}},"description":"Host details for the lodging.","x-stripeMostCommon":["address","country_of_domicile","host_reference","host_type","name","number_of_reservations","property_phone_number","registered_at"]},"insurances":{"type":"array","description":"List of insurances for the lodging.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Price of the insurance coverage in cents."},"currency":{"type":"string","description":"Currency of the insurance amount.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the insurance company."},"insurance_type":{"type":"string","description":"Type of insurance coverage.","enum":["bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance covering losses due to provider bankruptcy.","value":"bankruptcy"},{"description":"Insurance covering cancellation.","value":"cancelation"},{"description":"Insurance covering general emergency situations.","value":"emergency"},{"description":"Insurance covering medical emergencies during the stay.","value":"medical"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"no_show_indicator":{"type":"boolean","description":"Whether the renter is a no-show."},"renter_id_number":{"maxLength":25,"type":"string","description":"Renter ID number for the lodging."},"renter_name":{"maxLength":198,"type":"string","description":"Renter name for the lodging."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total price of the lodging reservation in cents."},"cash_advances":{"type":"integer","description":"Cash advances in cents."},"currency":{"type":"string","description":"Currency of the total amount.","format":"currency"},"discounts":{"title":"discount","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."},"coupon":{"maxLength":25,"type":"string","description":"Coupon code."}},"description":"Discount details for the lodging.","x-stripeMostCommon":["corporate_client_code","coupon"]},"extra_charges":{"type":"array","description":"Additional charges for the lodging.","items":{"title":"extra_charge","type":"object","properties":{"amount":{"type":"integer","description":"Amount of the extra charge in cents."},"type":{"type":"string","description":"Type of extra charge.","enum":["gift_shop","laundry","mini_bar","other","phone","restaurant"],"x-stripeEnum":{"kind":"open","values":[{"description":"Charges for gift shop purchases.","value":"gift_shop"},{"description":"Charges for laundry or cleaning services.","value":"laundry"},{"description":"Charges for mini bar consumption.","value":"mini_bar"},{"description":"Other miscellaneous charges.","value":"other"},{"description":"Charges for telephone services.","value":"phone"},{"description":"Charges for dining or food services.","value":"restaurant"}]}}},"x-stripeMostCommon":["amount","type"]}},"prepaid_amount":{"type":"integer","description":"Prepaid amount in cents."},"tax":{"title":"tax","type":"object","properties":{"tax_exempt_indicator":{"type":"boolean","description":"Indicates whether the transaction is tax exempt."},"tax_items":{"type":"array","description":"Tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount in cents."},"rate":{"type":"integer","description":"Tax rate."},"type":{"maxLength":40,"type":"string","description":"Type of tax applied."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown for the lodging reservation.","x-stripeMostCommon":["tax_exempt_indicator","tax_items"]}},"description":"Total details for the lodging.","x-stripeMostCommon":["amount","cash_advances","currency","discounts","extra_charges","prepaid_amount","tax"]}},"x-stripeMostCommon":["accommodation","affiliate","booking_number","checkin_at","checkout_at","customer_service_phone_number","fire_safety_act_compliance_indicator","guests","host","insurances","no_show_indicator","renter_id_number","renter_name","total"]}},{"type":"string","enum":[""]}]},"order_reference":{"description":"A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.\n\nFor Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"subscription":{"title":"subscription","required":["name"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"auto_renewal":{"type":"boolean","description":"Info whether the subscription will be auto renewed upon expiry."},"billing_interval":{"title":"subscription_billing_interval","required":["count","interval"],"type":"object","properties":{"count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."},"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]}},"description":"Subscription billing details for this purchase.","x-stripeMostCommon":["count","interval"]},"ends_at":{"type":"integer","description":"Subscription end time. Measured in seconds since the Unix epoch.","format":"unix-time"},"name":{"maxLength":5000,"type":"string","description":"Name of the product on subscription. e.g. Apple Music Subscription"},"starts_at":{"type":"integer","description":"Subscription start time. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Subscription details for this PaymentIntent","x-stripeMostCommon":["affiliate","auto_renewal","billing_interval","ends_at","name","starts_at"]}},"description":"Provides industry-specific information about the charge.","x-stripeMostCommon":["car_rental","car_rental_data","event_details","fleet_data","flight","flight_data","healthcare","lodging","lodging_data","subscription"]},"receipt_email":{"type":"string","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."},"statement_descriptor":{"maxLength":22,"type":"string","description":"For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix."},"statement_descriptor_suffix":{"maxLength":22,"type":"string","description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor."},"transfer_data":{"title":"transfer_data_specs","type":"object","properties":{"amount":{"type":"integer","description":"The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account."}},"description":"An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.","x-stripeMostCommon":["amount"]},"transfer_group":{"type":"string","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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details."}},"additionalProperties":false,"x-stripeMostCommon":["amount","application_fee","receipt_email","statement_descriptor","statement_descriptor_suffix"]},"encoding":{"expand":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/charge"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"capture_charge"}},"/v1/charges/{charge}/refunds":{"get":{"summary":"List all refunds","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.
Retrieves the details of an existing refund.
","operationId":"GetChargesChargeRefundsRefund","parameters":[{"name":"charge","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"refund","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/refund"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/checkout/sessions":{"get":{"summary":"List all Checkout Sessions","description":"Returns a list of Checkout Sessions.
","operationId":"GetCheckoutSessions","parameters":[{"name":"created","in":"query","description":"Only return Checkout Sessions that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return the Checkout Sessions for the Customer specified.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"customer_account","in":"query","description":"Only return the Checkout Sessions for the Account specified.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"customer_details","in":"query","description":"Only return the Checkout Sessions for the Customer details specified.","required":false,"style":"deepObject","explode":true,"schema":{"title":"customer_details_params","required":["email"],"type":"object","properties":{"email":{"type":"string","description":"Customer's email address."}},"x-stripeMostCommon":["email"]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_intent","in":"query","description":"Only return the Checkout Session for the PaymentIntent specified.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"payment_link","in":"query","description":"Only return the Checkout Sessions for the Payment Link specified.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return the Checkout Sessions matching the given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["complete","expired","open"],"x-stripeEnum":{"kind":"open","values":[{"description":"The checkout session is complete. Payment processing may still be in progress","value":"complete"},{"description":"The checkout session has expired. No further processing will occur","value":"expired"},{"description":"The checkout session is still in progress. Payment processing has not started","value":"open"}]}},"x-stripeLessCommon":true},{"name":"subscription","in":"query","description":"Only return the Checkout Session for the subscription specified.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentPagesCheckoutSessionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/checkout.session"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_checkout_sessions"},"post":{"summary":"Create a Checkout Session","description":"Creates a Checkout Session object.
","operationId":"PostCheckoutSessions","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"adaptive_pricing":{"title":"adaptive_pricing_params","type":"object","properties":{"enabled":{"type":"boolean","description":"If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing)."}},"description":"Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).","x-stripeMostCommon":["enabled"]},"after_expiration":{"title":"after_expiration_params","type":"object","properties":{"recovery":{"title":"recovery_params","required":["enabled"],"type":"object","properties":{"allow_promotion_codes":{"type":"boolean","description":"Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`"},"enabled":{"type":"boolean","description":"If `true`, a recovery URL will be generated to recover this Checkout Session if it\nexpires before a successful transaction is completed. It will be attached to the\nCheckout Session object upon expiration."}},"description":"Configure a Checkout Session that can be used to recover an expired session.","x-stripeMostCommon":["allow_promotion_codes","enabled"]}},"description":"Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `elements`.","x-stripeMostCommon":["recovery"]},"allow_promotion_codes":{"type":"boolean","description":"Enables user redeemable promotion codes."},"allowed_payment_method_types":{"type":"array","description":"A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nUnlike `payment_method_types`, this acts as a filter on the dynamically computed set of\neligible payment methods rather than an explicit static list. Only payment methods that\nare both dynamically eligible and present in this list will be offered to the customer.","items":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}},"automatic_tax":{"title":"automatic_tax_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes Checkout to collect any billing address information necessary for tax calculation."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.","x-stripeMostCommon":["address_collection_precision","enabled","liability"]},"billing_address_collection":{"type":"string","description":"Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.","enum":["auto","required"]},"branding_settings":{"title":"branding_settings_params","type":"object","properties":{"background_color":{"description":"A hex color value starting with `#` representing the background color for the Checkout Session.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"border_style":{"type":"string","description":"The border style for the Checkout Session.","enum":["","pill","rectangular","rounded"]},"button_color":{"description":"A hex color value starting with `#` representing the button color for the Checkout Session.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"display_name":{"maxLength":5000,"type":"string","description":"A string to override the business name shown on the Checkout Session. This only shows at the top of the Checkout page, and your business name still appears in terms, receipts, and other places."},"font_family":{"type":"string","description":"The font family for the Checkout Session corresponding to one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).","enum":["","be_vietnam_pro","bitter","chakra_petch","default","hahmlet","inconsolata","inter","lato","lora","m_plus_1_code","montserrat","noto_sans","noto_sans_jp","noto_serif","nunito","open_sans","pridi","pt_sans","pt_serif","raleway","roboto","roboto_slab","source_sans_pro","titillium_web","ubuntu_mono","zen_maru_gothic"]},"icon":{"title":"icon_params","required":["type"],"type":"object","properties":{"file":{"type":"string","description":"The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise."},"type":{"type":"string","description":"The type of image for the icon. Must be one of `file` or `url`.","enum":["file","url"]},"url":{"type":"string","description":"The URL of the image. Required if `type` is `url` and disallowed otherwise."}},"description":"The icon for the Checkout Session. For best results, use a square image.","x-stripeMostCommon":["file","type","url"]},"logo":{"title":"logo_params","required":["type"],"type":"object","properties":{"file":{"type":"string","description":"The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise."},"type":{"type":"string","description":"The type of image for the logo. Must be one of `file` or `url`.","enum":["file","url"]},"url":{"type":"string","description":"The URL of the image. Required if `type` is `url` and disallowed otherwise."}},"description":"The logo for the Checkout Session.","x-stripeMostCommon":["file","type","url"]}},"description":"The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `elements`.","x-stripeMostCommon":["background_color","border_style","button_color","display_name","font_family","icon","logo"]},"cancel_url":{"type":"string","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. This parameter is not allowed if ui_mode is `embedded_page` or `elements`."},"client_reference_id":{"maxLength":200,"type":"string","description":"A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nsession with your internal systems."},"consent_collection":{"title":"consent_collection_params","type":"object","properties":{"payment_method_reuse_agreement":{"title":"payment_method_reuse_agreement_params","required":["position"],"type":"object","properties":{"position":{"type":"string","description":"Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.","enum":["auto","hidden"]}},"description":"Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.","x-stripeMostCommon":["position"]},"promotions":{"type":"string","description":"If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants and US customers.","enum":["auto","none"]},"terms_of_service":{"type":"string","description":"If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).","enum":["none","required"]}},"description":"Configure fields for the Checkout Session to gather active consent from customers.","x-stripeMostCommon":["payment_method_reuse_agreement","promotions","terms_of_service"]},"currency":{"type":"string","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.","format":"currency"},"custom_fields":{"type":"array","description":"Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `elements`.","items":{"title":"custom_field_param","required":["key","label","type"],"type":"object","properties":{"dropdown":{"title":"custom_field_dropdown_param","required":["options"],"type":"object","properties":{"default_value":{"maxLength":100,"type":"string","description":"The value that pre-fills the field on the payment page. Must match a `value` in the `options` array."},"options":{"type":"array","description":"The options available for the customer to select. Up to 200 options allowed.","items":{"title":"custom_field_option_param","required":["label","value"],"type":"object","properties":{"label":{"maxLength":100,"type":"string","description":"The label for the option, displayed to the customer. Up to 100 characters."},"value":{"maxLength":100,"type":"string","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."}},"x-stripeMostCommon":["label","value"]}}},"description":"Configuration for `type=dropdown` fields.","x-stripeMostCommon":["default_value","options"]},"key":{"maxLength":200,"type":"string","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."},"label":{"title":"custom_field_label_param","required":["custom","type"],"type":"object","properties":{"custom":{"maxLength":100,"type":"string","description":"Custom text for the label, displayed to the customer. Up to 100 characters."},"type":{"type":"string","description":"The type of the label.","enum":["custom"]}},"description":"The label for the field, displayed to the customer.","x-stripeMostCommon":["custom","type"]},"numeric":{"title":"custom_field_numeric_param","type":"object","properties":{"default_value":{"maxLength":255,"type":"string","description":"The value that pre-fills the field on the payment page."},"maximum_length":{"type":"integer","description":"The maximum character length constraint for the customer's input."},"minimum_length":{"type":"integer","description":"The minimum character length requirement for the customer's input."}},"description":"Configuration for `type=numeric` fields.","x-stripeMostCommon":["default_value","maximum_length","minimum_length"]},"optional":{"type":"boolean","description":"Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."},"text":{"title":"custom_field_text_param","type":"object","properties":{"default_value":{"maxLength":255,"type":"string","description":"The value that pre-fills the field on the payment page."},"maximum_length":{"type":"integer","description":"The maximum character length constraint for the customer's input."},"minimum_length":{"type":"integer","description":"The minimum character length requirement for the customer's input."}},"description":"Configuration for `type=text` fields.","x-stripeMostCommon":["default_value","maximum_length","minimum_length"]},"type":{"type":"string","description":"The type of the field.","enum":["dropdown","numeric","text"]}},"x-stripeMostCommon":["dropdown","key","label","numeric","optional","text","type"]}},"custom_text":{"title":"custom_text_param","type":"object","properties":{"after_submit":{"description":"Custom text that should be displayed after the payment confirmation button.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"shipping_address":{"description":"Custom text that should be displayed alongside shipping address collection.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"submit":{"description":"Custom text that should be displayed alongside the payment confirmation button.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"terms_of_service_acceptance":{"description":"Custom text that should be displayed in place of the default terms of service agreement text.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]}},"description":"Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `elements`.","x-stripeMostCommon":["after_submit","shipping_address","submit","terms_of_service_acceptance"]},"customer":{"maxLength":5000,"type":"string","description":"ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill 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.\n\nIf the Customer already has a valid [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf 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.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/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."},"customer_account":{"maxLength":5000,"type":"string","description":"ID of an existing Account, if one exists. Has the same behavior as `customer`."},"customer_creation":{"type":"string","description":"Configure whether a Checkout Session creates a [Customer](https://docs.stripe.com/api/customers) during Session confirmation.\n\nWhen a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout\nwith [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details).\n\nSessions that don't create Customers instead are grouped by [guest customers](https://docs.stripe.com/payments/checkout/guest-customers)\nin the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.\n\nCan only be set in `payment` and `setup` mode.","enum":["always","if_required"]},"customer_email":{"type":"string","description":"If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once a session is\ncomplete, use the `customer` field."},"customer_update":{"title":"customer_update_params","type":"object","properties":{"address":{"type":"string","description":"Describes whether Checkout saves the billing address onto `customer.address`.\nTo always collect a full billing address, use `billing_address_collection`. Defaults to `never`.","enum":["auto","never"],"x-stripeBypassValidation":true},"name":{"type":"string","description":"Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.","enum":["auto","never"],"x-stripeBypassValidation":true},"shipping":{"type":"string","description":"Describes whether Checkout saves shipping information onto `customer.shipping`.\nTo collect shipping information, use `shipping_address_collection`. Defaults to `never`.","enum":["auto","never"],"x-stripeBypassValidation":true}},"description":"Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.","x-stripeMostCommon":["address","name","shipping"]},"discounts":{"type":"array","description":"The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.","items":{"title":"discount_params","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The ID of the coupon to apply to this Session."},"coupon_data":{"title":"coupon_data","type":"object","properties":{"amount_off":{"type":"integer","description":"A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed)."},"currency":{"type":"string","description":"Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).","format":"currency"},"duration":{"type":"string","description":"Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.","enum":["forever","once","repeating"],"x-stripeBypassValidation":true},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":40,"type":"string","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."},"percent_off":{"type":"number","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)."}},"description":"Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.","x-stripeMostCommon":["amount_off","currency","duration","metadata","name","percent_off"]},"promotion_code":{"maxLength":5000,"type":"string","description":"The ID of a promotion code to apply to this Session."}},"x-stripeMostCommon":["coupon","coupon_data","promotion_code"]}},"excluded_payment_method_types":{"type":"array","description":"A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).","items":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","ideal","kakao_pay","klarna","konbini","kr_card","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","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"},"integration_identifier":{"maxLength":200,"type":"string","description":"The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier."},"invoice_creation":{"title":"invoice_creation_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable invoice creation."},"invoice_data":{"title":"invoice_data_params","type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the invoice.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"description":"Default custom fields to be displayed on invoices for this customer.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"description":{"maxLength":1500,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"footer":{"maxLength":5000,"type":"string","description":"Default footer to be displayed on invoices for this customer."},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"rendering_options":{"description":"Default options for invoice PDF rendering for this customer.","anyOf":[{"title":"checkout_rendering_options_param","type":"object","properties":{"amount_tax_display":{"type":"string","description":"How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.","enum":["","exclude_tax","include_inclusive_tax"]},"template":{"maxLength":5000,"type":"string","description":"ID of the invoice rendering template to use for this invoice."}},"x-stripeMostCommon":["amount_tax_display","currency_display","invoice_title","template"]},{"type":"string","enum":[""]}]}},"description":"Parameters passed when creating invoices for payment-mode Checkout Sessions.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer","metadata","rendering_options"]}},"description":"Generate a post-purchase Invoice for one-time payments.","x-stripeMostCommon":["enabled","invoice_data"]},"line_items":{"type":"array","description":"A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). The parameter is required for `payment` and `subscription` mode.\n\nFor `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.\n\nFor `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":{"title":"line_item_params","type":"object","properties":{"adjustable_quantity":{"title":"adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative integer."},"maximum":{"type":"integer","description":"The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999."},"minimum":{"type":"integer","description":"The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0."}},"description":"When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.","x-stripeMostCommon":["enabled","maximum","minimum"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required."},"price_data":{"title":"price_data_with_product_data","required":["currency"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required."},"product_data":{"title":"product_data","required":["name"],"type":"object","properties":{"description":{"maxLength":40000,"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."},"images":{"type":"array","description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"description":"Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.","x-stripeMostCommon":["description","images","metadata","name","tax_code","tax_details","unit_label"]},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`."},"tax_rates":{"type":"array","description":"The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item.","items":{"maxLength":5000,"type":"string"}}},"x-stripeMostCommon":["adjustable_quantity","dynamic_tax_rates","metadata","price","price_data","quantity","tax_rates"]}},"locale":{"type":"string","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"],"x-stripeBypassValidation":true},"managed_payments":{"title":"managed_payments_params","type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session."}},"description":"Settings for Managed Payments for this Checkout Session and resulting [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object).","x-stripeMostCommon":["enabled"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"mode":{"type":"string","description":"The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.","enum":["payment","setup","subscription"]},"name_collection":{"title":"name_collection_params","type":"object","properties":{"business":{"title":"name_collection_business_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable business name collection on the Checkout Session. Defaults to `false`."},"optional":{"type":"boolean","description":"Whether the customer is required to provide a business name before completing the Checkout Session. Defaults to `false`."}},"description":"Controls settings applied for collecting the customer's business name on the session.","x-stripeMostCommon":["enabled","optional"]},"individual":{"title":"name_collection_individual_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable individual name collection on the Checkout Session. Defaults to `false`."},"optional":{"type":"boolean","description":"Whether the customer is required to provide their name before completing the Checkout Session. Defaults to `false`."}},"description":"Controls settings applied for collecting the customer's individual name on the session.","x-stripeMostCommon":["enabled","optional"]}},"description":"Controls name collection settings for the session.\n\nYou can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.\n\nIf a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.","x-stripeMostCommon":["business","individual"]},"optional_items":{"type":"array","description":"A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).\n\nThere is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.\n\nFor `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.\n\nFor `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.\n\nYou can't set this parameter if `ui_mode` is `elements` or `form`.","items":{"title":"optional_item_params","required":["price","quantity"],"type":"object","properties":{"adjustable_quantity":{"title":"optional_item_adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative integer."},"maximum":{"type":"integer","description":"The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999."},"minimum":{"type":"integer","description":"The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0."}},"description":"When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.","x-stripeMostCommon":["enabled","maximum","minimum"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object."},"quantity":{"type":"integer","description":"The initial quantity of the line item created when a customer chooses to add this optional item to their order."}},"x-stripeMostCommon":["adjustable_quantity","price","quantity"]}},"origin_context":{"type":"string","description":"Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `elements`.","enum":["mobile_app","web"]},"payment_intent_data":{"title":"payment_intent_data_params","type":"object","properties":{"application_fee_amount":{"type":"integer","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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."},"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["automatic","automatic_async","manual"]},"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"The Stripe account ID for which these funds are intended. For details,\nsee the PaymentIntents [use case for connected\naccounts](/docs/payments/connected-accounts)."},"receipt_email":{"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":{"type":"string","description":"Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.","enum":["off_session","on_session"]},"shipping":{"title":"shipping","required":["address","name"],"type":"object","properties":{"address":{"title":"address","required":["line1"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"carrier":{"maxLength":5000,"type":"string","description":"The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."},"name":{"maxLength":5000,"type":"string","description":"Recipient name."},"phone":{"maxLength":5000,"type":"string","description":"Recipient phone (including extension)."},"tracking_number":{"maxLength":5000,"type":"string","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."}},"description":"Shipping information for this payment.","x-stripeMostCommon":["address","carrier","name","phone","tracking_number"]},"statement_descriptor":{"maxLength":22,"type":"string","description":"Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."},"statement_descriptor_suffix":{"maxLength":22,"type":"string","description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."},"transfer_data":{"title":"transfer_data_params","required":["destination"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when a charge succeeds."},"destination":{"type":"string","description":"If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field."}},"description":"The parameters used to automatically create a Transfer when the payment succeeds.\nFor more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).","x-stripeMostCommon":["amount","destination"]},"transfer_group":{"type":"string","description":"A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details."}},"description":"A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.","x-stripeMostCommon":["application_fee_amount","capture_method","cross_border_classification","description","fulfillment_date","metadata","on_behalf_of","receipt_email","setup_future_usage","shipping","statement_descriptor","statement_descriptor_suffix","transfer_data","transfer_group"]},"payment_method_collection":{"type":"string","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.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf 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://docs.stripe.com/payments/checkout/free-trials).","enum":["always","if_required"],"x-stripeBypassValidation":true},"payment_method_configuration":{"maxLength":100,"type":"string","description":"The ID of the payment method configuration to use with this Checkout session."},"payment_method_data":{"title":"payment_method_data_param","type":"object","properties":{"allow_redisplay":{"type":"string","description":"Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.","enum":["always","limited","unspecified"]}},"description":"This parameter allows you to set some attributes on the payment method created during a Checkout session.","x-stripeMostCommon":["allow_redisplay"]},"payment_method_options":{"title":"payment_method_options_param","type":"object","properties":{"acss_debit":{"title":"payment_method_options_param","type":"object","properties":{"currency":{"type":"string","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). This is only accepted for Checkout Sessions in `setup` mode.","enum":["cad","usd"]},"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"custom_mandate_url":{"description":"A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"default_for":{"type":"array","description":"List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.","items":{"type":"string","enum":["invoice","subscription"]}},"interval_description":{"maxLength":500,"type":"string","description":"Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'."},"payment_schedule":{"type":"string","description":"Payment schedule for the mandate.","enum":["combined","interval","sporadic"]},"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["custom_mandate_url","default_for","interval_description","payment_schedule","transaction_type"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session","on_session"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."},"verification_method":{"type":"string","description":"Verification method for the intent","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"description":"contains details about the ACSS Debit payment method options. You can't set this parameter if `ui_mode` is `elements`.","x-stripeMostCommon":["currency","financial_connections","mandate_options","setup_future_usage","target_date","verification_method"]},"affirm":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Affirm payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"afterpay_clearpay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Afterpay Clearpay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"alipay":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","value":"none"}]}}},"description":"contains details about the Alipay payment method options.","x-stripeMostCommon":["currency","setup_future_usage"]},"alma":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]}},"description":"contains details about the Alma payment method options.","x-stripeMostCommon":["capture_method"]},"amazon_pay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the AmazonPay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"au_becs_debit":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."}},"description":"contains details about the AU Becs Debit payment method options.","x-stripeMostCommon":["setup_future_usage","target_date"]},"bacs_debit":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference_prefix"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session","on_session"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."}},"description":"contains details about the Bacs Debit payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage","target_date","verification_method"]},"bancontact":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the Bancontact payment method options.","x-stripeMostCommon":["setup_future_usage"]},"billie":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]}},"description":"contains details about the Billie payment method options.","x-stripeMostCommon":["capture_method"]},"blik":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"subscription_payment_method_options_mandate_options_param","type":"object","properties":{"expires_at":{"type":"integer","description":"Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.","format":"unix-time"}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["expires_at"]},"setup_future_usage":{"type":"string","enum":["","none","off_session"]}},"description":"contains details about the BLIK payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage"]},"boleto":{"title":"payment_method_options_param","type":"object","properties":{"expires_after_days":{"type":"integer","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 invoice will expire on Wednesday at 23:59 America/Sao_Paulo time."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session","on_session"]}},"description":"contains details about the Boleto payment method options.","x-stripeMostCommon":["expires_after_days","setup_future_usage"]},"card":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"installments":{"title":"installments_param","type":"object","properties":{"enabled":{"type":"boolean","description":"Setting to true enables installments for this Checkout Session.\nSetting to false will prevent any installment plan from applying to a payment."}},"description":"Installment options for card payments","x-stripeMostCommon":["enabled"]},"request_decremental_authorization":{"type":"string","description":"Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.","enum":["if_available","never"]},"request_extended_authorization":{"type":"string","description":"Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.","enum":["if_available","never"]},"request_incremental_authorization":{"type":"string","description":"Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.","enum":["if_available","never"]},"request_multicapture":{"type":"string","description":"Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.","enum":["if_available","never"]},"request_overcapture":{"type":"string","description":"Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.","enum":["if_available","never"]},"request_three_d_secure":{"type":"string","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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"],"x-stripeBypassValidation":true},"restrictions":{"title":"restrictions_param","type":"object","properties":{"brands_blocked":{"type":"array","description":"The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.","items":{"type":"string","enum":["american_express","discover_global_network","mastercard","visa"]}},"funding_types_blocked":{"type":"array","description":"Card funding types to block for this Checkout Session. Supported values are `credit`, `debit`, and `prepaid`.","items":{"type":"string","enum":["credit","debit","prepaid"]}}},"description":"Restrictions to apply to the card payment method. For example, you can block specific card brands. You can't set this parameter if `ui_mode` is `elements`.","x-stripeMostCommon":["brands_blocked","funding_types_blocked"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["off_session","on_session"]},"statement_descriptor_suffix_kana":{"maxLength":22,"type":"string","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."},"statement_descriptor_suffix_kanji":{"maxLength":17,"type":"string","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."}},"description":"contains details about the Card payment method options.","x-stripeMostCommon":["capture_method","installments","network_options","recipient_details","request_decremental_authorization","request_extended_authorization","request_incremental_authorization","request_multicapture","request_overcapture","request_three_d_secure","restrictions","sender_details","setup_future_usage","statement_descriptor_suffix_kana","statement_descriptor_suffix_kanji"]},"cashapp":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session","on_session"]}},"description":"contains details about the Cashapp Pay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"crypto":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"],"x-stripeBypassValidation":true}},"description":"contains details about the Crypto payment method options.","x-stripeMostCommon":["setup_future_usage"]},"customer_balance":{"title":"payment_method_options_param","type":"object","properties":{"bank_transfer":{"title":"bank_transfer_param","required":["type"],"type":"object","properties":{"eu_bank_transfer":{"title":"eu_bank_transfer_params","required":["country"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."}},"description":"Configuration for eu_bank_transfer funding type.","x-stripeMostCommon":["country"]},"requested_address_types":{"type":"array","description":"List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.","items":{"type":"string","enum":["aba","iban","sepa","sort_code","spei","swift","zengin"],"x-stripeBypassValidation":true}},"type":{"type":"string","description":"The list of bank transfer types that this PaymentIntent is allowed to use for funding.","enum":["eu_bank_transfer","gb_bank_transfer","jp_bank_transfer","mx_bank_transfer","us_bank_transfer"],"x-stripeBypassValidation":true}},"description":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.","x-stripeMostCommon":["eu_bank_transfer","id_bank_transfer","requested_address_types","type"]},"funding_type":{"type":"string","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"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Customer Balance payment method options.","x-stripeMostCommon":["bank_transfer","funding_type","setup_future_usage"]},"demo_pay":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the DemoPay payment method options.","x-stripeMostCommon":["setup_future_usage"]},"eps":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the EPS payment method options.","x-stripeMostCommon":["setup_future_usage"]},"fpx":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the FPX payment method options.","x-stripeMostCommon":["setup_future_usage"]},"giropay":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Giropay payment method options.","x-stripeMostCommon":["setup_future_usage"]},"grabpay":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Grabpay payment method options.","x-stripeMostCommon":["setup_future_usage"]},"ideal":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Ideal payment method options.","x-stripeMostCommon":["setup_future_usage"]},"kakao_pay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the Kakao Pay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"klarna":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]},"subscriptions":{"description":"Subscription details if the Checkout Session sets up a future subscription.","anyOf":[{"type":"array","items":{"title":"setup_intent_subscription_param","required":["interval","next_billing","reference"],"type":"object","properties":{"interval":{"type":"string","description":"Unit of time between subscription charges.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months."},"name":{"maxLength":255,"type":"string","description":"Name for subscription."},"next_billing":{"title":"subscription_next_billing_param","required":["amount","date"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount of the next charge for the subscription."},"date":{"maxLength":5000,"type":"string","description":"The date of the next charge for the subscription in YYYY-MM-DD format."}},"description":"Describes the upcoming charge for this subscription.","x-stripeMostCommon":["amount","date"]},"reference":{"maxLength":255,"type":"string","description":"A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges."}},"x-stripeMostCommon":["interval","interval_count","name","next_billing","reference"]}},{"type":"string","enum":[""]}]}},"description":"contains details about the Klarna payment method options.","x-stripeMostCommon":["capture_method","interoperability_token","setup_future_usage","subscriptions"]},"konbini":{"title":"payment_method_options_param","type":"object","properties":{"expires_after_days":{"type":"integer","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. Defaults to 3 days."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Konbini payment method options.","x-stripeMostCommon":["expires_after_days","setup_future_usage"]},"kr_card":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the Korean card payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"link":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the Link payment method options (Link is also known as Onelink in the UK).","x-stripeMostCommon":["capture_method","setup_future_usage"]},"mobilepay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Mobilepay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"multibanco":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Multibanco payment method options.","x-stripeMostCommon":["setup_future_usage"]},"naver_pay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the Naver Pay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"oxxo":{"title":"payment_method_options_param","type":"object","properties":{"expires_after_days":{"type":"integer","description":"The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the OXXO payment method options.","x-stripeMostCommon":["expires_after_days","setup_future_usage"]},"p24":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]},"tos_shown_and_accepted":{"type":"boolean","description":"Confirm that the payer has accepted the P24 terms and conditions."}},"description":"contains details about the P24 payment method options.","x-stripeMostCommon":["setup_future_usage","tos_shown_and_accepted"]},"pay_by_bank":{"title":"payment_method_options_param","type":"object","properties":{},"description":"contains details about the Pay By Bank payment method options.","x-stripeMostCommon":["allow_delayed_notification","country","locale","setup_future_usage","statement_descriptor"]},"payco":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the PAYCO payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"paynow":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the PayNow payment method options.","x-stripeMostCommon":["setup_future_usage"]},"paypal":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["","manual"]},"preferred_locale":{"type":"string","description":"[Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.","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"],"x-stripeBypassValidation":true},"reference":{"maxLength":127,"type":"string","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."},"reference_id":{"maxLength":127,"type":"string","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."},"risk_correlation_id":{"maxLength":32,"type":"string","description":"The risk correlation ID for an on-session payment using a saved PayPal payment method."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]},"subsellers":{"type":"array","description":"The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.","items":{"maxLength":32,"type":"string"}}},"description":"contains details about the PayPal payment method options.","x-stripeMostCommon":["capture_method","preferred_locale","reference","reference_id","risk_correlation_id","setup_future_usage","subsellers"]},"payto":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"description":"Amount that will be collected. It is required when `amount_type` is `fixed`.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"amount_type":{"type":"string","description":"The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.","enum":["","fixed","maximum"]},"end_date":{"description":"Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"payment_schedule":{"type":"string","description":"The periodicity at which payments will be collected. Defaults to `adhoc`.","enum":["","adhoc","annual","daily","fortnightly","monthly","quarterly","semi_annual","weekly"]},"payments_per_period":{"description":"The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"purpose":{"type":"string","description":"The purpose for which payments are made. Has a default value based on your merchant category code.","enum":["","dependant_support","government","loan","mortgage","other","pension","personal","retail","salary","tax","utility"]},"start_date":{"description":"Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["amount","amount_type","end_date","payment_schedule","payments_per_period","purpose","start_date"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the PayTo payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage"]},"pix":{"title":"payment_method_options_param","type":"object","properties":{"amount_includes_iof":{"type":"string","description":"Determines if the amount includes the IOF tax. Defaults to `never`.","enum":["always","never"]},"expires_after_seconds":{"type":"integer","description":"The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds."},"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000."},"amount_includes_iof":{"type":"string","description":"Determines if the amount includes the IOF tax. Defaults to `never`.","enum":["always","never"]},"amount_type":{"type":"string","description":"Type of amount. Defaults to `maximum`.","enum":["fixed","maximum"]},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.","format":"currency"},"end_date":{"maxLength":5000,"type":"string","description":"Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."},"payment_schedule":{"type":"string","description":"Schedule at which the future payments will be charged. Defaults to `monthly`.","enum":["halfyearly","monthly","quarterly","weekly","yearly"]},"reference":{"maxLength":35,"type":"string","description":"Subscription name displayed to buyers in their bank app. Defaults to the displayable business name."},"start_date":{"maxLength":5000,"type":"string","description":"Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date."}},"description":"Additional fields for mandate creation.","x-stripeMostCommon":["amount","amount_includes_iof","amount_type","currency","end_date","payment_schedule","reference","start_date"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the Pix payment method options.","x-stripeMostCommon":["amount_includes_iof","expires_after_seconds","mandate_options","setup_future_usage"]},"revolut_pay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"closed","values":[{"description":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","value":"none"},{"description":"Use `off_session` if your customer may or may not be present in your checkout flow.","value":"off_session"}]}}},"description":"contains details about the RevolutPay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"samsung_pay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Samsung Pay payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"satispay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]}},"description":"contains details about the Satispay payment method options.","x-stripeMostCommon":["capture_method"]},"scalapay":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]}},"description":"contains details about the Scalapay payment method options.","x-stripeMostCommon":["capture_method"]},"sepa_debit":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference","reference_prefix"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session","on_session"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."}},"description":"contains details about the Sepa Debit payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage","target_date","verification_method"]},"sequra":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]}},"description":"contains details about the SeQura payment method options.","x-stripeMostCommon":["capture_method"]},"sofort":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Sofort payment method options.","x-stripeMostCommon":["setup_future_usage"]},"sunbit":{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"]}},"description":"contains details about the Sunbit payment method options.","x-stripeMostCommon":["capture_method","setup_future_usage"]},"swish":{"title":"payment_method_options_param","type":"object","properties":{"reference":{"maxLength":5000,"type":"string","description":"The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent."}},"description":"contains details about the Swish payment method options.","x-stripeMostCommon":["authorization_method","reference"]},"twint":{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session"]}},"description":"contains details about the TWINT payment method options.","x-stripeMostCommon":["setup_future_usage"]},"upi":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["amount","amount_type","description","end_date"]},"setup_future_usage":{"type":"string","enum":["","none","off_session","on_session"]}},"description":"contains details about the UPI payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage"]},"us_bank_account":{"title":"payment_method_options_param","type":"object","properties":{"financial_connections":{"title":"linked_account_options_param","type":"object","properties":{"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.","items":{"maxLength":5000,"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeBypassValidation":true}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","inferred_balances","ownership","transactions"],"x-stripeBypassValidation":true}}},"description":"Additional fields for Financial Connections Session creation","x-stripeMostCommon":["permissions","prefetch"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none","off_session","on_session"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."},"verification_method":{"type":"string","description":"Verification method for the intent","enum":["automatic","instant"],"x-stripeBypassValidation":true}},"description":"contains details about the Us Bank Account payment method options.","x-stripeMostCommon":["financial_connections","setup_future_usage","target_date","verification_method"]},"wechat_pay":{"title":"payment_method_options_param","required":["client"],"type":"object","properties":{"app_id":{"maxLength":5000,"type":"string","description":"The app ID registered with WeChat Pay. Only required when client is ios or android."},"client":{"type":"string","description":"The client type that the end customer will pay from","enum":["android","ios","web"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"The end customer will pay from an Android app","value":"android"},{"description":"The end customer will pay from an iOS app","value":"ios"},{"description":"The end customer will pay from web browser","value":"web"}]}},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).","enum":["none"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","value":"none"}]}}},"description":"contains details about the WeChat Pay payment method options.","x-stripeMostCommon":["app_id","client","setup_future_usage"]}},"description":"Payment-method-specific configuration.","x-stripeMostCommon":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","customer_balance","demo_pay","eps","fpx","giropay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","kr_market","link","mobilepay","multibanco","naver_pay","ng_bank","ng_bank_transfer","ng_card","ng_market","ng_ussd","oxxo","p24","pay_by_bank","payco","paynow","paypal","payto","pix","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","sofort","sunbit","swish","twint","upi","us_bank_account","wechat_pay"]},"permissions":{"title":"permissions_param","type":"object","properties":{"update":{"title":"permissions_update_param","type":"object","properties":{"line_items":{"type":"string","description":"Determines which entity is allowed to update the line items.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.\n\nWhen set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.","enum":["client_only","server_only"]},"shipping_details":{"type":"string","description":"Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nThis parameter is only supported when `ui_mode=elements`.","enum":["client_only","server_only"]}},"description":"Permissions for updating the Checkout Session.","x-stripeMostCommon":["line_items","shipping_details"]},"update_discounts":{"type":"string","description":"Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.\n\nDefault is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.","enum":["client_only","server_only"]},"update_line_items":{"type":"string","description":"Determines which entity is allowed to update the line items.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.\n\nWhen set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.","enum":["client_only","server_only"]},"update_shipping_details":{"type":"string","description":"Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nThis parameter is only supported when `ui_mode=elements`.","enum":["client_only","server_only"]}},"description":"This property is used to set up permissions for various actions (for example, update) on the CheckoutSession object. Can only be set when creating `embedded_page` or `elements` sessions.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.","x-stripeMostCommon":["update","update_discounts","update_line_items","update_shipping_details"]},"phone_number_collection":{"title":"phone_number_collection_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable phone number collection.\n\nCan only be set in `payment` and `subscription` mode."}},"description":"Controls phone number collection settings for the session.\n\nWe recommend that you review your privacy policy and check with your legal contacts\nbefore using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers).","x-stripeMostCommon":["enabled"]},"redirect_on_completion":{"type":"string","description":"This parameter applies to `ui_mode: embedded_page`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.","enum":["always","if_required","never"]},"return_url":{"type":"string","description":"The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if `ui_mode` is `embedded_page` or `elements`\nand redirect-based payment methods are enabled on the session."},"saved_payment_method_options":{"title":"saved_payment_method_options_param","type":"object","properties":{"allow_redisplay_filters":{"type":"array","description":"Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.","items":{"type":"string","enum":["always","limited","unspecified"]}},"payment_method_remove":{"type":"string","description":"Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.","enum":["disabled","enabled"]},"payment_method_save":{"type":"string","description":"Enable customers to choose if they wish to save their payment method for future use. Disabled by default.","enum":["disabled","enabled"]}},"description":"Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.","x-stripeMostCommon":["allow_redisplay_filters","payment_method_preselect","payment_method_remove","payment_method_save"]},"setup_intent_data":{"title":"setup_intent_data_param","type":"object","properties":{"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"The Stripe account for which the setup is intended."}},"description":"A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.","x-stripeMostCommon":["description","metadata","on_behalf_of"]},"shipping_address_collection":{"title":"shipping_address_collection_params","required":["allowed_countries"],"type":"object","properties":{"allowed_countries":{"type":"array","description":"An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations.","items":{"type":"string","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","SD","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"]}}},"description":"When set, provides configuration for Checkout to collect a shipping address from a customer.","x-stripeMostCommon":["allowed_countries"]},"shipping_options":{"type":"array","description":"The shipping rate options to apply to this Session. Up to a maximum of 5.","items":{"title":"shipping_option_params","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the Shipping Rate to use for this shipping option."},"shipping_rate_data":{"title":"create_params","required":["display_name"],"type":"object","properties":{"delivery_estimate":{"title":"delivery_estimate","type":"object","properties":{"maximum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.","x-stripeMostCommon":["unit","value"]},"minimum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The lower bound of the estimated range. If empty, represents no lower bound.","x-stripeMostCommon":["unit","value"]}},"description":"The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.","x-stripeMostCommon":["maximum","minimum"]},"display_name":{"maxLength":100,"type":"string","description":"The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."},"fixed_amount":{"title":"fixed_amount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"x-stripeMostCommon":["amount","tax_behavior"]},"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)."}},"description":"Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.","x-stripeMostCommon":["amount","currency","currency_options"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`."},"type":{"type":"string","description":"The type of calculation to use on the shipping rate.","enum":["fixed_amount"]}},"description":"Parameters to be passed to Shipping Rate creation for this shipping option.","x-stripeMostCommon":["display_name","fixed_amount","metadata","tax_behavior","tax_code","type"]}},"x-stripeMostCommon":["shipping_rate","shipping_rate_data"]}},"submit_type":{"type":"string","description":"Describes the type of transaction being performed by Checkout in order\nto customize relevant text on the page, such as the submit button.\n `submit_type` can only be specified on Checkout Sessions in\n`payment` or `subscription` mode. If blank or `auto`, `pay` is used.\nYou can't set this parameter if `ui_mode` is `elements`.","enum":["auto","book","donate","pay","subscribe"]},"subscription_data":{"title":"subscription_data_params","type":"object","properties":{"application_fee_percent":{"type":"number","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. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)."},"billing_cycle_anchor":{"type":"integer","description":"A future timestamp to anchor the subscription's billing cycle for new subscriptions.","format":"unix-time"},"billing_cycle_anchor_config":{"title":"cycle_anchor_config_param","required":["day_of_month"],"type":"object","properties":{"day_of_month":{"type":"integer","description":"The day of the month the anchor should be. Ranges from 1 to 31."},"hour":{"type":"integer","description":"The hour of the day the anchor should be. Ranges from 0 to 23."},"minute":{"type":"integer","description":"The minute of the hour the anchor should be. Ranges from 0 to 59."},"month":{"type":"integer","description":"The month to start full cycle periods. Ranges from 1 to 12."},"second":{"type":"integer","description":"The second of the minute the anchor should be. Ranges from 0 to 59."}},"description":"Configures when the subscription schedule's billing cycle anchors to a specific day of the week or month.","x-stripeMostCommon":["day_of_month","hour","minute","month","second"]},"billing_mode":{"title":"billing_mode","required":["type"],"type":"object","properties":{"flexible":{"title":"flexible_params","type":"object","properties":{"proration_discounts":{"type":"string","description":"Controls how invoices and invoice items display proration amounts and discount amounts.","enum":["included","itemized"],"x-stripeEnum":{"kind":"open","values":[{"description":"Amounts are net of discounts, and discount amounts are zero.","value":"included"},{"description":"Amounts are gross of discounts, and discount amounts are accurate.","value":"itemized"}]}}},"description":"Configure behavior for flexible billing mode.","x-stripeMostCommon":["proration_discounts"]},"type":{"type":"string","description":"Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.","enum":["classic","flexible"]}},"description":"Controls how prorations and invoices for subscriptions are calculated and orchestrated.","x-stripeMostCommon":["flexible","type"]},"default_tax_rates":{"type":"array","description":"The tax rates that will apply to any subscription item that does not have\n`tax_rates` set. Invoices created will have their `default_tax_rates` populated\nfrom the subscription.","items":{"maxLength":5000,"type":"string"}},"description":{"maxLength":500,"type":"string","description":"The subscription's description, meant to be displayable to the customer.\nUse this field to optionally store an explanation of the subscription\nfor rendering in the [customer portal](https://docs.stripe.com/customer-management)."},"invoice_settings":{"title":"invoice_settings_params","type":"object","properties":{"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"The account on behalf of which to charge, for each of the subscription's invoices."},"pending_invoice_item_interval":{"title":"pending_invoice_item_interval_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.","x-stripeMostCommon":["interval","interval_count"]},"proration_behavior":{"type":"string","description":"Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.","enum":["create_prorations","none"]},"transfer_data":{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"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.","x-stripeMostCommon":["amount_percent","destination"]},"trial_end":{"type":"integer","description":"Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.","format":"unix-time"},"trial_period_days":{"type":"integer","description":"Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1."},"trial_settings":{"title":"trial_settings_config","required":["end_behavior"],"type":"object","properties":{"end_behavior":{"title":"end_behavior","required":["missing_payment_method"],"type":"object","properties":{"missing_payment_method":{"type":"string","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"]}},"description":"Defines how the subscription should behave when the user's free trial ends.","x-stripeMostCommon":["billing_cycle_anchor","missing_payment_method"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"description":"A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.","x-stripeMostCommon":["application_fee_percent","billing_cycle_anchor","billing_cycle_anchor_config","billing_mode","default_tax_rates","description","invoice_settings","metadata","on_behalf_of","pending_invoice_item_interval","proration_behavior","tax_filing_currency","transfer_data","trial_end","trial_period_days"]},"success_url":{"type":"string","description":"The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded_page` or `elements`. If you'd like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page)."},"tax_id_collection":{"title":"tax_id_collection_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable tax ID collection during checkout. Defaults to `false`."},"required":{"type":"string","description":"Describes whether a tax ID is required during checkout. Defaults to `never`. You can't set this parameter if `ui_mode` is `elements`.","enum":["if_supported","never"]}},"description":"Controls tax ID collection during checkout.","x-stripeMostCommon":["enabled","required"]},"ui_mode":{"type":"string","description":"The UI mode of the Session. Defaults to `hosted_page`.","enum":["elements","embedded_page","form","hosted_page"],"x-stripeBypassValidation":true},"wallet_options":{"title":"wallet_options_param","type":"object","properties":{"link":{"title":"wallet_options_param","type":"object","properties":{"display":{"type":"string","description":"Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.","enum":["auto","never"]}},"description":"contains details about the Link wallet options (Link is also known as Onelink in the UK).","x-stripeMostCommon":["display"]}},"description":"Wallet-specific configuration.","x-stripeMostCommon":["link"]}},"additionalProperties":false,"x-stripeMostCommon":["automatic_tax","client_reference_id","customer","customer_email","line_items","metadata","mode","return_url","success_url","ui_mode"]},"encoding":{"adaptive_pricing":{"style":"deepObject","explode":true},"after_expiration":{"style":"deepObject","explode":true},"allowed_payment_method_types":{"style":"deepObject","explode":true},"automatic_tax":{"style":"deepObject","explode":true},"branding_settings":{"style":"deepObject","explode":true},"consent_collection":{"style":"deepObject","explode":true},"custom_fields":{"style":"deepObject","explode":true},"custom_text":{"style":"deepObject","explode":true},"customer_update":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"excluded_payment_method_types":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"invoice_creation":{"style":"deepObject","explode":true},"line_items":{"style":"deepObject","explode":true},"managed_payments":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"name_collection":{"style":"deepObject","explode":true},"optional_items":{"style":"deepObject","explode":true},"payment_intent_data":{"style":"deepObject","explode":true},"payment_method_data":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true},"permissions":{"style":"deepObject","explode":true},"phone_number_collection":{"style":"deepObject","explode":true},"saved_payment_method_options":{"style":"deepObject","explode":true},"setup_intent_data":{"style":"deepObject","explode":true},"shipping_address_collection":{"style":"deepObject","explode":true},"shipping_options":{"style":"deepObject","explode":true},"subscription_data":{"style":"deepObject","explode":true},"tax_id_collection":{"style":"deepObject","explode":true},"wallet_options":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkout.session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_checkout_session"}},"/v1/checkout/sessions/{session}":{"get":{"summary":"Retrieve a Checkout Session","description":"Retrieves a Checkout Session object.
","operationId":"GetCheckoutSessionsSession","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"session","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":66,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkout.session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_checkout_session"},"post":{"summary":"Update a Checkout Session","description":"Updates a Checkout Session object.
\n\nRelated guide: Dynamically update a Checkout Session
","operationId":"PostCheckoutSessionsSession","parameters":[{"name":"session","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"automatic_tax":{"title":"automatic_tax_params","type":"object","properties":{"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.","x-stripeMostCommon":["liability"]},"collected_information":{"title":"collected_information_params","type":"object","properties":{"shipping_details":{"title":"shipping_details_params","required":["address","name"],"type":"object","properties":{"address":{"title":"shipping_address","required":["country","line1"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The address of the customer","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":255,"type":"string","description":"The name of customer"}},"description":"The shipping details to apply to this Session.","x-stripeMostCommon":["address","name"]}},"description":"Information about the customer collected within the Checkout Session. Can only be set when updating `embedded_page` or `elements` sessions.","x-stripeMostCommon":["billing_details","shipping_details"]},"discounts":{"description":"List of coupons and promotion codes attached to the Checkout Session.","anyOf":[{"type":"array","items":{"title":"discount_params","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The ID of the [Coupon](https://docs.stripe.com/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts."},"coupon_data":{"title":"coupon_data","type":"object","properties":{"amount_off":{"type":"integer","description":"A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed)."},"currency":{"type":"string","description":"Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).","format":"currency"},"duration":{"type":"string","description":"Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.","enum":["forever","once","repeating"],"x-stripeBypassValidation":true},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":40,"type":"string","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."},"percent_off":{"type":"number","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)."}},"description":"Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.","x-stripeMostCommon":["amount_off","currency","duration","metadata","name","percent_off"]}},"x-stripeMostCommon":["coupon","coupon_data"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_creation":{"title":"invoice_creation_params","type":"object","properties":{"invoice_data":{"title":"invoice_data_params","type":"object","properties":{"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"Parameters passed when creating invoices for payment-mode Checkout Sessions.","x-stripeMostCommon":["issuer"]}},"description":"Generate a post-purchase Invoice for one-time payments.","x-stripeMostCommon":["invoice_data"]},"line_items":{"type":"array","description":"A list of items the customer is purchasing.\n\nWhen updating line items, you must retransmit the entire array of line items.\n\nTo retain an existing line item, specify its `id`.\n\nTo update an existing line item, specify its `id` along with the new values of the fields to update.\n\nTo add a new line item, specify one of `price` or `price_data` and `quantity`.\n\nTo remove an existing line item, omit the line item's ID from the retransmitted array.\n\nTo reorder a line item, specify it at the desired position in the retransmitted array.","items":{"title":"line_item_params","type":"object","properties":{"adjustable_quantity":{"title":"adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity."},"maximum":{"type":"integer","description":"The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999."},"minimum":{"type":"integer","description":"The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0."}},"description":"When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.","x-stripeMostCommon":["enabled","maximum","minimum"]},"id":{"maxLength":5000,"type":"string","description":"ID of an existing line item."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices). One of `price` or `price_data` is required when creating a new line item."},"price_data":{"title":"price_data_with_product_data","required":["currency"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required."},"product_data":{"title":"product_data","required":["name"],"type":"object","properties":{"description":{"maxLength":40000,"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."},"images":{"type":"array","description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"description":"Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.","x-stripeMostCommon":["description","images","metadata","name","tax_code","tax_details","unit_label"]},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`."},"tax_rates":{"description":"The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["adjustable_quantity","id","metadata","price","price_data","quantity","tax_rates"]}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment_intent_data":{"title":"payment_intent_data_params","type":"object","properties":{"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users. Pass an empty string to clear a previously configured value.","anyOf":[{"maxLength":1000,"type":"string"},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.\n\nPass an empty string to remove a previously supplied configuration.","enum":["","off_session","on_session"]},"statement_descriptor":{"description":"Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.\n Pass an empty string to clear a previously configured value.","anyOf":[{"maxLength":22,"type":"string"},{"type":"string","enum":[""]}]},"statement_descriptor_suffix":{"description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.\n Pass an empty string to clear a previously configured value.","anyOf":[{"maxLength":22,"type":"string"},{"type":"string","enum":[""]}]}},"description":"A subset of parameters to apply to the PaymentIntent for Checkout Sessions in `payment` mode.\n\nYou can only update these parameters when `ui_mode` is `elements` and while the session is active. If the PaymentIntent requires customer action or confirmation, updating these parameters abandons the current payment attempt and returns the PaymentIntent to `requires_payment_method`. You can't update these parameters after the PaymentIntent begins processing, requires capture, succeeds, or is canceled.","x-stripeMostCommon":["description","metadata","receipt_email","setup_future_usage","statement_descriptor","statement_descriptor_suffix"]},"shipping_options":{"description":"The shipping rate options to apply to this Session. Up to a maximum of 5.","anyOf":[{"type":"array","items":{"title":"shipping_option_params","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the Shipping Rate to use for this shipping option."},"shipping_rate_data":{"title":"create_params","required":["display_name"],"type":"object","properties":{"delivery_estimate":{"title":"delivery_estimate","type":"object","properties":{"maximum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.","x-stripeMostCommon":["unit","value"]},"minimum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The lower bound of the estimated range. If empty, represents no lower bound.","x-stripeMostCommon":["unit","value"]}},"description":"The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.","x-stripeMostCommon":["maximum","minimum"]},"display_name":{"maxLength":100,"type":"string","description":"The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."},"fixed_amount":{"title":"fixed_amount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"x-stripeMostCommon":["amount","tax_behavior"]},"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)."}},"description":"Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.","x-stripeMostCommon":["amount","currency","currency_options"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`."},"type":{"type":"string","description":"The type of calculation to use on the shipping rate.","enum":["fixed_amount"]}},"description":"Parameters to be passed to Shipping Rate creation for this shipping option.","x-stripeMostCommon":["display_name","fixed_amount","metadata","tax_behavior","tax_code","type"]}},"x-stripeMostCommon":["shipping_rate","shipping_rate_data"]}},{"type":"string","enum":[""]}]},"subscription_data":{"title":"subscription_data_params","type":"object","properties":{"invoice_settings":{"title":"invoice_settings_params","type":"object","properties":{"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["issuer"]},"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://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.","anyOf":[{"title":"pending_invoice_item_interval_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"x-stripeMostCommon":["interval","interval_count"]},{"type":"string","enum":[""]}]},"trial_end":{"type":"integer","description":"Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.","format":"unix-time"},"trial_period_days":{"description":"Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]}},"description":"A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.","x-stripeMostCommon":["invoice_settings","pending_invoice_item_interval","trial_end","trial_period_days"]}},"additionalProperties":false,"x-stripeMostCommon":["line_items","metadata"]},"encoding":{"automatic_tax":{"style":"deepObject","explode":true},"collected_information":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"invoice_creation":{"style":"deepObject","explode":true},"line_items":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_intent_data":{"style":"deepObject","explode":true},"shipping_options":{"style":"deepObject","explode":true},"subscription_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkout.session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_checkout_session"}},"/v1/checkout/sessions/{session}/expire":{"post":{"summary":"Expire a Checkout Session","description":"A Checkout Session can be expired when it is in one of these statuses: open
After it expires, a customer can’t complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.
","operationId":"PostCheckoutSessionsSessionExpire","parameters":[{"name":"session","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkout.session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"expire_checkout_session"}},"/v1/checkout/sessions/{session}/line_items":{"get":{"summary":"Retrieve a Checkout Session's line items","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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"session","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentPagesCheckoutSessionListLineItems","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_checkout_session_line_items"}},"/v1/climate/orders":{"get":{"summary":"List orders","description":"Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.
","operationId":"GetClimateOrders","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ClimateRemovalsOrdersList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/climate.order"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/climate/orders","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_climate_orders"},"post":{"summary":"Create an order","description":"Creates a Climate order object for a given Climate product. The order will be processed immediately\nafter creation and payment will be deducted your Stripe balance.
","operationId":"PostClimateOrders","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["product"],"type":"object","properties":{"amount":{"type":"integer","description":"Requested amount of carbon removal units. Either this or `metric_tons` must be specified."},"beneficiary":{"title":"beneficiary_params","required":["public_name"],"type":"object","properties":{"public_name":{"maxLength":5000,"type":"string","description":"Publicly displayable name for the end beneficiary of carbon removal."}},"description":"Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.","x-stripeMostCommon":["domain","email","public_name"]},"currency":{"maxLength":5000,"type":"string","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"metric_tons":{"type":"string","description":"Requested number of tons for the order. Either this or `amount` must be specified.","format":"decimal"},"product":{"maxLength":5000,"type":"string","description":"Unique identifier of the Climate product."}},"additionalProperties":false,"x-stripeMostCommon":["amount","beneficiary","currency","metadata","metric_tons","product"]},"encoding":{"beneficiary":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/climate.order"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_climate_order"}},"/v1/climate/orders/{order}":{"get":{"summary":"Retrieve an order","description":"Retrieves the details of a Climate order object with the given ID.
","operationId":"GetClimateOrdersOrder","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"order","in":"path","description":"Unique identifier of the order.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/climate.order"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_climate_order"},"post":{"summary":"Update an order","description":"Updates the specified order by setting the values of the parameters passed.
","operationId":"PostClimateOrdersOrder","parameters":[{"name":"order","in":"path","description":"Unique identifier of the order.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"beneficiary":{"description":"Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.","anyOf":[{"title":"beneficiary_params","required":["public_name"],"type":"object","properties":{"public_name":{"description":"Publicly displayable name for the end beneficiary of carbon removal.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["domain","email","public_name"]},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."}},"additionalProperties":false,"x-stripeMostCommon":["beneficiary","metadata"]},"encoding":{"beneficiary":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/climate.order"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_climate_order"}},"/v1/climate/orders/{order}/cancel":{"post":{"summary":"Cancel an order","description":"Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\nreservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total.
Lists all available Climate product objects.
","operationId":"GetClimateProducts","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ClimateRemovalsProductsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/climate.product"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/climate/products","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_climate_products"}},"/v1/climate/products/{product}":{"get":{"summary":"Retrieve a product","description":"Retrieves the details of a Climate product with the given ID.
","operationId":"GetClimateProductsProduct","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"product","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/climate.product"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_climate_product"}},"/v1/climate/suppliers":{"get":{"summary":"List suppliers","description":"Lists all available Climate supplier objects.
","operationId":"GetClimateSuppliers","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ClimateRemovalsSuppliersList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/climate.supplier"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/climate/suppliers","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_climate_suppliers"}},"/v1/climate/suppliers/{supplier}":{"get":{"summary":"Retrieve a supplier","description":"Retrieves a Climate supplier object.
","operationId":"GetClimateSuppliersSupplier","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"supplier","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/climate.supplier"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_climate_supplier"}},"/v1/confirmation_tokens/{confirmation_token}":{"get":{"summary":"Retrieve a ConfirmationToken","description":"Retrieves an existing ConfirmationToken object
","operationId":"GetConfirmationTokensConfirmationToken","parameters":[{"name":"confirmation_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmation_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_confirmation_token"}},"/v1/country_specs":{"get":{"summary":"List Country Specs","description":"Lists all Country Spec objects available in the API.
","operationId":"GetCountrySpecs","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CountrySpecList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/country_spec"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/country_specs","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_country_specs"}},"/v1/country_specs/{country}":{"get":{"summary":"Retrieve a Country Spec","description":"Returns a Country Spec for a given Country code.
","operationId":"GetCountrySpecsCountry","parameters":[{"name":"country","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/country_spec"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_country_spec"}},"/v1/coupons":{"get":{"summary":"List all coupons","description":"Returns a list of your coupons.
","operationId":"GetCoupons","parameters":[{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CouponsResourceCouponList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/coupon"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/coupons","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_coupons"},"post":{"summary":"Create a coupon","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.
\n\nA 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 amount_off of amount_off of
Retrieves the coupon with the given ID.
","operationId":"GetCouponsCoupon","parameters":[{"name":"coupon","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/coupon"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_coupon"},"post":{"summary":"Update a coupon","description":"Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
","operationId":"PostCouponsCoupon","parameters":[{"name":"coupon","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","required":["amount_off"],"type":"object","properties":{"amount_off":{"type":"integer","description":"A positive integer representing the amount to subtract from an invoice total."}},"x-stripeMostCommon":["amount_off"]},"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)."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":40,"type":"string","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."}},"additionalProperties":false,"x-stripeMostCommon":["metadata","name"]},"encoding":{"currency_options":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/coupon"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_coupon"},"delete":{"summary":"Delete a coupon","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":[{"name":"coupon","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_coupon"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_coupon"}},"/v1/credit_notes":{"get":{"summary":"List all credit notes","description":"Returns a list of credit notes.
","operationId":"GetCreditNotes","parameters":[{"name":"created","in":"query","description":"Only return credit notes that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return credit notes for the customer specified by this customer ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"customer_account","in":"query","description":"Only return credit notes for the account representing the customer specified by this account ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"query","description":"Only return credit notes for the invoice specified by this invoice ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CreditNotesList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/credit_note"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_credit_notes"},"post":{"summary":"Create a credit note","description":"Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero.\nThis amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
refund_amount) or link existing refunds (using refunds).credit_amount) which will be automatically applied to their next invoice when it’s finalized.out_of_band_amount).The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount,\npost_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.
For invoices that also have refunds created through the Refund API, the credit note API subtracts those refund amounts from the maximum creditable amount. This prevents the combined credit notes and refunds from exceeding the invoice amount. If you use both, ensure the combined total does not exceed the invoice’s paid amount.
","operationId":"PostCreditNotes","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["invoice"],"type":"object","properties":{"amount":{"type":"integer","description":"The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided."},"credit_amount":{"type":"integer","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."},"effective_at":{"type":"integer","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"},"email_type":{"type":"string","description":"Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.","enum":["credit_note","none"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice":{"maxLength":5000,"type":"string","description":"ID of the invoice."},"lines":{"type":"array","description":"Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","items":{"title":"credit_note_line_item_params","required":["type"],"type":"object","properties":{"amount":{"type":"integer","description":"The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive"},"description":{"maxLength":5000,"type":"string","description":"The description of the credit note line item. Only valid when the `type` is `custom_line_item`."},"invoice_line_item":{"maxLength":5000,"type":"string","description":"The invoice line item to credit. Only valid when the `type` is `invoice_line_item`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"quantity":{"type":"integer","description":"The line item quantity to credit."},"tax_amounts":{"description":"A list of up to 20 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`.","anyOf":[{"type":"array","items":{"title":"tax_amount_with_tax_rate_param","required":["amount","tax_rate","taxable_amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount, in cents (or local equivalent), of the tax."},"tax_rate":{"maxLength":5000,"type":"string","description":"The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe."},"taxable_amount":{"type":"integer","description":"The amount on which tax is calculated, in cents (or local equivalent)."}},"x-stripeMostCommon":["amount","tax_rate","taxable_amount"]}},{"type":"string","enum":[""]}]},"tax_rates":{"description":"The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"type":{"type":"string","description":"Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`.","enum":["custom_line_item","invoice_line_item"]},"unit_amount":{"type":"integer","description":"The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["amount","description","invoice_line_item","metadata","quantity","tax_amounts","tax_rates","type","unit_amount","unit_amount_decimal"]}},"memo":{"maxLength":5000,"type":"string","description":"The credit note's memo appears on the credit note PDF."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"out_of_band_amount":{"type":"integer","description":"The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe."},"reason":{"type":"string","description":"Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`","enum":["duplicate","fraudulent","order_change","product_unsatisfactory"],"x-stripeBypassValidation":true},"refund_amount":{"type":"integer","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."},"refunds":{"type":"array","description":"Refunds to link to this credit note.","items":{"title":"credit_note_refund_params","type":"object","properties":{"amount_refunded":{"type":"integer","description":"Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount."},"payment_record_refund":{"title":"payment_record_refund_params","required":["payment_record","refund_group"],"type":"object","properties":{"payment_record":{"maxLength":5000,"type":"string","description":"The ID of the PaymentRecord with the refund to link to this credit note."},"refund_group":{"maxLength":5000,"type":"string","description":"The PaymentRecord refund group to link to this credit note. For refunds processed off-Stripe, this will correspond to the `processor_details.custom.refund_reference` field provided when reporting the refund on the PaymentRecord."}},"description":"The PaymentRecord refund details to link to this credit note. Required when `type` is `payment_record_refund`.","x-stripeMostCommon":["payment_record","refund_group"]},"refund":{"type":"string","description":"ID of an existing refund to link this credit note to. Required when `type` is `refund`."},"type":{"type":"string","description":"Type of the refund, one of `refund` or `payment_record_refund`. Defaults to `refund`.","enum":["payment_record_refund","refund"]}},"x-stripeMostCommon":["amount_refunded","payment_record_refund","refund","type"]}},"shipping_cost":{"title":"credit_note_shipping_cost","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the shipping rate to use for this order."}},"description":"When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","x-stripeMostCommon":["shipping_rate"]}},"additionalProperties":false,"x-stripeMostCommon":["invoice","lines","memo","metadata","reason"]},"encoding":{"expand":{"style":"deepObject","explode":true},"lines":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"refunds":{"style":"deepObject","explode":true},"shipping_cost":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_note"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_credit_note"}},"/v1/credit_notes/preview":{"get":{"summary":"Preview a credit note","description":"Get a preview of a credit note without creating it.
","operationId":"GetCreditNotesPreview","parameters":[{"name":"amount","in":"query","description":"The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"credit_amount","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"effective_at","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"},"x-stripeLessCommon":true},{"name":"email_type","in":"query","description":"Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["credit_note","none"]},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"query","description":"ID of the invoice.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"lines","in":"query","description":"Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"title":"credit_note_line_item_params","required":["type"],"type":"object","properties":{"amount":{"type":"integer","description":"The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive"},"description":{"maxLength":5000,"type":"string","description":"The description of the credit note line item. Only valid when the `type` is `custom_line_item`."},"invoice_line_item":{"maxLength":5000,"type":"string","description":"The invoice line item to credit. Only valid when the `type` is `invoice_line_item`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"quantity":{"type":"integer","description":"The line item quantity to credit."},"tax_amounts":{"description":"A list of up to 20 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`.","anyOf":[{"type":"array","items":{"title":"tax_amount_with_tax_rate_param","required":["amount","tax_rate","taxable_amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount, in cents (or local equivalent), of the tax."},"tax_rate":{"maxLength":5000,"type":"string","description":"The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe."},"taxable_amount":{"type":"integer","description":"The amount on which tax is calculated, in cents (or local equivalent)."}},"x-stripeMostCommon":["amount","tax_rate","taxable_amount"]}},{"type":"string","enum":[""]}]},"tax_rates":{"description":"The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"type":{"type":"string","description":"Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`.","enum":["custom_line_item","invoice_line_item"]},"unit_amount":{"type":"integer","description":"The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["amount","description","invoice_line_item","metadata","quantity","tax_amounts","tax_rates","type","unit_amount","unit_amount_decimal"]}}},{"name":"memo","in":"query","description":"The credit note's memo appears on the credit note PDF.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"metadata","in":"query","description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}},{"name":"out_of_band_amount","in":"query","description":"The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"reason","in":"query","description":"Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["duplicate","fraudulent","order_change","product_unsatisfactory"],"x-stripeBypassValidation":true}},{"name":"refund_amount","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"refunds","in":"query","description":"Refunds to link to this credit note.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"title":"credit_note_refund_params","type":"object","properties":{"amount_refunded":{"type":"integer","description":"Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount."},"payment_record_refund":{"title":"payment_record_refund_params","required":["payment_record","refund_group"],"type":"object","properties":{"payment_record":{"maxLength":5000,"type":"string","description":"The ID of the PaymentRecord with the refund to link to this credit note."},"refund_group":{"maxLength":5000,"type":"string","description":"The PaymentRecord refund group to link to this credit note. For refunds processed off-Stripe, this will correspond to the `processor_details.custom.refund_reference` field provided when reporting the refund on the PaymentRecord."}},"description":"The PaymentRecord refund details to link to this credit note. Required when `type` is `payment_record_refund`.","x-stripeMostCommon":["payment_record","refund_group"]},"refund":{"type":"string","description":"ID of an existing refund to link this credit note to. Required when `type` is `refund`."},"type":{"type":"string","description":"Type of the refund, one of `refund` or `payment_record_refund`. Defaults to `refund`.","enum":["payment_record_refund","refund"]}},"x-stripeMostCommon":["amount_refunded","payment_record_refund","refund","type"]}},"x-stripeLessCommon":true},{"name":"shipping_cost","in":"query","description":"When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","required":false,"style":"deepObject","explode":true,"schema":{"title":"credit_note_shipping_cost","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the shipping rate to use for this order."}},"x-stripeMostCommon":["shipping_rate"]},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_note"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"preview_credit_note"}},"/v1/credit_notes/preview/lines":{"get":{"summary":"Retrieve a credit note preview's line items","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":[{"name":"amount","in":"query","description":"The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"credit_amount","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"effective_at","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"},"x-stripeLessCommon":true},{"name":"email_type","in":"query","description":"Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["credit_note","none"]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"query","description":"ID of the invoice.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"lines","in":"query","description":"Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"title":"credit_note_line_item_params","required":["type"],"type":"object","properties":{"amount":{"type":"integer","description":"The line item amount to credit. Only valid when `type` is `invoice_line_item`. If invoice is set up with `automatic_tax[enabled]=true`, this amount is tax exclusive"},"description":{"maxLength":5000,"type":"string","description":"The description of the credit note line item. Only valid when the `type` is `custom_line_item`."},"invoice_line_item":{"maxLength":5000,"type":"string","description":"The invoice line item to credit. Only valid when the `type` is `invoice_line_item`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"quantity":{"type":"integer","description":"The line item quantity to credit."},"tax_amounts":{"description":"A list of up to 20 tax amounts for the credit note line item. Not valid when `tax_rates` is used or if invoice is set up with `automatic_tax[enabled]=true`.","anyOf":[{"type":"array","items":{"title":"tax_amount_with_tax_rate_param","required":["amount","tax_rate","taxable_amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount, in cents (or local equivalent), of the tax."},"tax_rate":{"maxLength":5000,"type":"string","description":"The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe."},"taxable_amount":{"type":"integer","description":"The amount on which tax is calculated, in cents (or local equivalent)."}},"x-stripeMostCommon":["amount","tax_rate","taxable_amount"]}},{"type":"string","enum":[""]}]},"tax_rates":{"description":"The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and `tax_amounts` is not used.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"type":{"type":"string","description":"Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. `custom_line_item` is not valid when the invoice is set up with `automatic_tax[enabled]=true`.","enum":["custom_line_item","invoice_line_item"]},"unit_amount":{"type":"integer","description":"The integer unit amount in cents (or local equivalent) of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["amount","description","invoice_line_item","metadata","quantity","tax_amounts","tax_rates","type","unit_amount","unit_amount_decimal"]}}},{"name":"memo","in":"query","description":"The credit note's memo appears on the credit note PDF.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"metadata","in":"query","description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}},{"name":"out_of_band_amount","in":"query","description":"The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"reason","in":"query","description":"Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["duplicate","fraudulent","order_change","product_unsatisfactory"],"x-stripeBypassValidation":true}},{"name":"refund_amount","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"refunds","in":"query","description":"Refunds to link to this credit note.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"title":"credit_note_refund_params","type":"object","properties":{"amount_refunded":{"type":"integer","description":"Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount."},"payment_record_refund":{"title":"payment_record_refund_params","required":["payment_record","refund_group"],"type":"object","properties":{"payment_record":{"maxLength":5000,"type":"string","description":"The ID of the PaymentRecord with the refund to link to this credit note."},"refund_group":{"maxLength":5000,"type":"string","description":"The PaymentRecord refund group to link to this credit note. For refunds processed off-Stripe, this will correspond to the `processor_details.custom.refund_reference` field provided when reporting the refund on the PaymentRecord."}},"description":"The PaymentRecord refund details to link to this credit note. Required when `type` is `payment_record_refund`.","x-stripeMostCommon":["payment_record","refund_group"]},"refund":{"type":"string","description":"ID of an existing refund to link this credit note to. Required when `type` is `refund`."},"type":{"type":"string","description":"Type of the refund, one of `refund` or `payment_record_refund`. Defaults to `refund`.","enum":["payment_record_refund","refund"]}},"x-stripeMostCommon":["amount_refunded","payment_record_refund","refund","type"]}},"x-stripeLessCommon":true},{"name":"shipping_cost","in":"query","description":"When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.","required":false,"style":"deepObject","explode":true,"schema":{"title":"credit_note_shipping_cost","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the shipping rate to use for this order."}},"x-stripeMostCommon":["shipping_rate"]},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CreditNoteLinesList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/credit_note_line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_credit_note_preview_line_items"}},"/v1/credit_notes/{credit_note}/lines":{"get":{"summary":"Retrieve a credit note's line items","description":"When retrieving a credit note, you’ll get a lines 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":"GetCreditNotesCreditNoteLines","parameters":[{"name":"credit_note","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CreditNoteLinesList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/credit_note_line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_credit_note_line_items"}},"/v1/credit_notes/{id}":{"get":{"summary":"Retrieve a credit note","description":"Retrieves the credit note object with the given identifier.
","operationId":"GetCreditNotesId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_note"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_credit_note"},"post":{"summary":"Update a credit note","description":"Updates an existing credit note.
","operationId":"PostCreditNotesId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"memo":{"maxLength":5000,"type":"string","description":"Credit note memo."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."}},"additionalProperties":false,"x-stripeMostCommon":["memo","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_note"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_credit_note"}},"/v1/credit_notes/{id}/void":{"post":{"summary":"Void a credit note","description":"Marks a credit note as void. Learn more about voiding credit notes.
","operationId":"PostCreditNotesIdVoid","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/credit_note"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"void_credit_note"}},"/v1/customer_sessions":{"post":{"summary":"Create a Customer Session","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":{"schema":{"required":["components"],"type":"object","properties":{"components":{"title":"components","type":"object","properties":{"active_entitlements":{"title":"active_entitlements_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the active entitlements is enabled."}},"description":"Configuration for active entitlements.","x-stripeMostCommon":["enabled"]},"buy_button":{"title":"buy_button_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the buy button is enabled."}},"description":"Configuration for buy button.","x-stripeMostCommon":["enabled"]},"customer_portal":{"title":"customer_portal_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the customer portal is enabled."}},"description":"Configuration for customer portal.","x-stripeMostCommon":["enabled"]},"customer_sheet":{"title":"customer_sheet_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the customer sheet is enabled."},"features":{"title":"features_param","type":"object","properties":{"payment_method_allow_redisplay_filters":{"type":"array","description":"A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].","items":{"type":"string","enum":["always","limited","unspecified"]}},"payment_method_remove":{"type":"string","description":"Controls whether the customer sheet displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).","enum":["disabled","enabled"],"x-stripeBypassValidation":true}},"description":"This hash defines whether the customer sheet supports certain features.","x-stripeMostCommon":["payment_method_allow_redisplay_filters","payment_method_remove","payment_method_remove_last","payment_method_sync_default"]}},"description":"Configuration for the customer sheet.","x-stripeMostCommon":["enabled","features"]},"mobile_payment_element":{"title":"mobile_payment_element_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the mobile payment element is enabled."},"features":{"title":"features_param","type":"object","properties":{"payment_method_allow_redisplay_filters":{"type":"array","description":"A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].","items":{"type":"string","enum":["always","limited","unspecified"]}},"payment_method_redisplay":{"type":"string","description":"Controls whether or not the mobile payment element shows saved payment methods.","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"payment_method_remove":{"type":"string","description":"Controls whether the mobile payment element displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"payment_method_save":{"type":"string","description":"Controls whether the mobile payment element displays a checkbox offering to save a new payment method.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"payment_method_save_allow_redisplay_override":{"type":"string","description":"Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: \"always\", \"limited\", or \"unspecified\".\n\nIf not specified, defaults to `nil` (no override value).","enum":["always","limited","unspecified"]}},"description":"This hash defines whether the mobile payment element supports certain features.","x-stripeMostCommon":["payment_method_allow_redisplay_filters","payment_method_redisplay","payment_method_remove","payment_method_remove_last","payment_method_save","payment_method_save_allow_redisplay_override","payment_method_set_as_default"]}},"description":"Configuration for the mobile payment element.","x-stripeMostCommon":["enabled","features"]},"payment_element":{"title":"payment_element_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the Payment Element is enabled."},"features":{"title":"features_param","type":"object","properties":{"payment_method_allow_redisplay_filters":{"type":"array","description":"A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"].","items":{"type":"string","enum":["always","limited","unspecified"]}},"payment_method_redisplay":{"type":"string","description":"Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"payment_method_redisplay_limit":{"type":"integer","description":"Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`."},"payment_method_remove":{"type":"string","description":"Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"payment_method_save":{"type":"string","description":"Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"payment_method_save_usage":{"type":"string","description":"When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.","enum":["off_session","on_session"]}},"description":"This hash defines whether the Payment Element supports certain features.","x-stripeMostCommon":["payment_method_allow_redisplay_filters","payment_method_preselect","payment_method_redisplay","payment_method_redisplay_limit","payment_method_remove","payment_method_remove_last","payment_method_save","payment_method_save_usage","payment_method_set_as_default","payment_method_update"]}},"description":"Configuration for the Payment Element.","x-stripeMostCommon":["enabled","features"]},"pricing_table":{"title":"pricing_table_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the pricing table is enabled."}},"description":"Configuration for the pricing table.","x-stripeMostCommon":["enabled"]},"tax_id_element":{"title":"tax_id_element_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the Tax ID Element is enabled."},"features":{"title":"features_param","type":"object","properties":{"tax_id_redisplay":{"type":"string","description":"Controls whether the Tax ID Element displays saved tax IDs for the customer. This parameter defaults to `disabled`.\n\nWhen enabled, the Tax ID Element will show existing tax IDs associated with the customer, allowing them to select from previously saved tax identification numbers.","enum":["disabled","enabled"],"x-stripeBypassValidation":true},"tax_id_save":{"type":"string","description":"Controls whether the Tax ID Element allows merchants to save new tax IDs for their customer. This parameter defaults to `disabled`.\n\nWhen enabled, customers can enter and save new tax identification numbers during the payment flow, which will be stored securely and associated with their customer object for future use.","enum":["disabled","enabled"],"x-stripeBypassValidation":true}},"description":"This hash defines whether the Tax ID Element supports certain features.","x-stripeMostCommon":["tax_id_redisplay","tax_id_save"]}},"description":"Configuration for the Tax ID Element.","x-stripeMostCommon":["enabled","features"]}},"description":"Configuration for each component. At least 1 component must be enabled.","x-stripeMostCommon":["active_entitlements","buy_button","customer_portal","customer_sheet","mobile_payment_element","payment_element","pricing_table","tax_id_element"]},"customer":{"maxLength":5000,"type":"string","description":"The ID of an existing customer for which to create the Customer Session."},"customer_account":{"maxLength":5000,"type":"string","description":"The ID of an existing Account for which to create the Customer Session."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["components","customer"]},"encoding":{"components":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_customer_session"}},"/v1/customers":{"get":{"summary":"List all customers","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":[{"name":"created","in":"query","description":"Only return customers that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"email","in":"query","description":"A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.","required":false,"style":"form","explode":true,"schema":{"maxLength":512,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"test_clock","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CustomerResourceCustomerList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/customer"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/customers","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_customers"},"post":{"summary":"Create a customer","description":"Creates a new customer object.
","operationId":"PostCustomers","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"address":{"description":"The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).","anyOf":[{"title":"optional_fields_customer_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"balance":{"type":"integer","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."},"business_name":{"description":"The customer's business name. This may be up to *150 characters*.","anyOf":[{"maxLength":150,"type":"string"},{"type":"string","enum":[""]}]},"cash_balance":{"title":"cash_balance_param","type":"object","properties":{"settings":{"title":"balance_settings_param","type":"object","properties":{"reconciliation_mode":{"type":"string","description":"Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://docs.stripe.com/payments/customer-balance/reconciliation).","enum":["automatic","manual","merchant_default"]}},"description":"Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.","x-stripeMostCommon":["reconciliation_mode"]}},"description":"Balance information and default balance settings for this customer.","x-stripeMostCommon":["settings"]},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard."},"email":{"maxLength":512,"type":"string","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*."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"individual_name":{"description":"The customer's full name. This may be up to *150 characters*.","anyOf":[{"maxLength":150,"type":"string"},{"type":"string","enum":[""]}]},"invoice_prefix":{"maxLength":5000,"type":"string","description":"The prefix for the customer used to generate unique invoice numbers. Must be 1–12 uppercase letters or numbers."},"invoice_settings":{"title":"customer_param","type":"object","properties":{"custom_fields":{"description":"The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"default_payment_method":{"maxLength":5000,"type":"string","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."},"footer":{"maxLength":5000,"type":"string","description":"Default footer to be displayed on invoices for this customer."},"rendering_options":{"description":"Default options for invoice PDF rendering for this customer.","anyOf":[{"title":"customer_rendering_options_param","type":"object","properties":{"amount_tax_display":{"type":"string","description":"How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.","enum":["","exclude_tax","include_inclusive_tax"]},"template":{"maxLength":5000,"type":"string","description":"ID of the invoice rendering template to use for future invoices."}},"x-stripeMostCommon":["amount_tax_display","currency_display","invoice_title","template"]},{"type":"string","enum":[""]}]}},"description":"Default invoice settings for this customer.","x-stripeMostCommon":["amount_to_forgive","amount_to_forgive_currency","custom_fields","days_until_due","default_payment_method","default_shared_payment_token","footer","rendering_options","send_hosted_payment_email","supported_payment_methods"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":256,"type":"string","description":"The customer's full name or business name."},"next_invoice_sequence":{"type":"integer","description":"The sequence to be used on the customer's next invoice. Defaults to 1."},"payment_method":{"maxLength":5000,"type":"string"},"phone":{"maxLength":20,"type":"string","description":"The customer's phone number."},"preferred_locales":{"type":"array","description":"Customer's preferred languages, ordered by preference.","items":{"maxLength":5000,"type":"string"}},"shipping":{"description":"The customer's shipping information. Appears on invoices emailed to this customer.","anyOf":[{"title":"customer_shipping","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_customer_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Customer shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Customer name."},"phone":{"maxLength":5000,"type":"string","description":"Customer phone (including extension)."}},"x-stripeMostCommon":["address","name","phone"]},{"type":"string","enum":[""]}]},"source":{"maxLength":5000,"type":"string","x-stripeBypassValidation":true},"tax":{"title":"shared_tax_create_param","type":"object","properties":{"ip_address":{"description":"A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"validate_location":{"type":"string","description":"A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.","enum":["deferred","immediately"]}},"description":"Tax details about the customer.","x-stripeMostCommon":["ip_address","validate_location"]},"tax_exempt":{"type":"string","description":"The customer's tax exemption. One of `none`, `exempt`, or `reverse`.","enum":["","exempt","none","reverse"]},"tax_id_data":{"type":"array","description":"The customer's tax IDs.","items":{"title":"data_params","required":["type","value"],"type":"object","properties":{"type":{"maxLength":5000,"type":"string","description":"Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `fo_vat`, `gb_vat`, `ge_vat`, `gi_tin`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `ic_nif`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `it_cf`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `py_ruc`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`","enum":["ad_nrt","ae_trn","al_tin","am_tin","ao_tin","ar_cuit","au_abn","au_arn","aw_tin","az_tin","ba_tin","bb_tin","bd_bin","bf_ifu","bg_uic","bh_vat","bj_ifu","bo_tin","br_cnpj","br_cpf","bs_tin","by_tin","ca_bn","ca_gst_hst","ca_pst_bc","ca_pst_mb","ca_pst_sk","ca_qst","cd_nif","ch_uid","ch_vat","cl_tin","cm_niu","cn_tin","co_nit","cr_tin","cv_nif","de_stn","do_rcn","ec_ruc","eg_tin","es_cif","et_tin","eu_oss_vat","eu_vat","fo_vat","gb_vat","ge_vat","gi_tin","gn_nif","hk_br","hr_oib","hu_tin","ic_nif","id_npwp","il_vat","in_gst","is_vat","it_cf","jp_cn","jp_rn","jp_trn","ke_pin","kg_tin","kh_tin","kr_brn","kz_bin","la_tin","li_uid","li_vat","lk_vat","ma_vat","md_vat","me_pib","mk_vat","mr_nif","mx_rfc","my_frp","my_itn","my_sst","ng_tin","no_vat","no_voec","np_pan","nz_gst","om_vat","pe_ruc","ph_tin","pl_nip","py_ruc","ro_tin","rs_pib","ru_inn","ru_kpp","sa_vat","sg_gst","sg_uen","si_tin","sn_ninea","sr_fin","sv_nit","th_vat","tj_tin","tr_tin","tw_vat","tz_vat","ua_vat","ug_tin","us_ein","uy_ruc","uz_tin","uz_vat","ve_rif","vn_tin","za_vat","zm_tin","zw_tin"],"x-stripeBypassValidation":true},"value":{"type":"string","description":"Value of the tax ID."}},"x-stripeMostCommon":["type","value"]}},"test_clock":{"maxLength":5000,"type":"string","description":"ID of the test clock to attach to the customer."},"validate":{"type":"boolean"}},"additionalProperties":false,"x-stripeMostCommon":["address","description","email","metadata","name","payment_method","phone","shipping","tax"]},"encoding":{"address":{"style":"deepObject","explode":true},"business_name":{"style":"deepObject","explode":true},"cash_balance":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"individual_name":{"style":"deepObject","explode":true},"invoice_settings":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"preferred_locales":{"style":"deepObject","explode":true},"shipping":{"style":"deepObject","explode":true},"tax":{"style":"deepObject","explode":true},"tax_id_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_customer"}},"/v1/customers/search":{"get":{"summary":"Search customers","description":"Search for customers you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetCustomersSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for customers](https://docs.stripe.com/search#query-fields-for-customers).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/customer"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_customers"}},"/v1/customers/{customer}":{"get":{"summary":"Retrieve a customer","description":"Retrieves a Customer object.
","operationId":"GetCustomersCustomer","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/customer"},{"$ref":"#/components/schemas/deleted_customer"}]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_customer"},"post":{"summary":"Update a customer","description":"Updates the specified customer by setting the values of the parameters passed. Any parameters not provided are left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (such as 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 is retried. This retry doesn’t count as an automatic retry, and doesn’t affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer doesn’t trigger this behavior.
This request accepts mostly the same arguments as the customer creation call.
","operationId":"PostCustomersCustomer","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"address":{"description":"The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).","anyOf":[{"title":"optional_fields_customer_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"balance":{"type":"integer","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."},"business_name":{"description":"The customer's business name. This may be up to *150 characters*.","anyOf":[{"maxLength":150,"type":"string"},{"type":"string","enum":[""]}]},"cash_balance":{"title":"cash_balance_param","type":"object","properties":{"settings":{"title":"balance_settings_param","type":"object","properties":{"reconciliation_mode":{"type":"string","description":"Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://docs.stripe.com/payments/customer-balance/reconciliation).","enum":["automatic","manual","merchant_default"]}},"description":"Settings controlling the behavior of the customer's cash balance,\nsuch as reconciliation of funds received.","x-stripeMostCommon":["reconciliation_mode"]}},"description":"Balance information and default balance settings for this customer.","x-stripeMostCommon":["settings"]},"default_source":{"maxLength":500,"type":"string","description":"If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.\n\nProvide the ID of a payment source already attached to this customer to make it this customer's default payment source.\n\nIf you want to add a new payment source and make it the default, see the [source](https://docs.stripe.com/api/customers/update#update_customer-source) property."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard."},"email":{"maxLength":512,"type":"string","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*."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"individual_name":{"description":"The customer's full name. This may be up to *150 characters*.","anyOf":[{"maxLength":150,"type":"string"},{"type":"string","enum":[""]}]},"invoice_prefix":{"maxLength":5000,"type":"string","description":"The prefix for the customer used to generate unique invoice numbers. Must be 1–12 uppercase letters or numbers."},"invoice_settings":{"title":"customer_param","type":"object","properties":{"custom_fields":{"description":"The list of up to 4 default custom fields to be displayed on invoices for this customer. When updating, pass an empty string to remove previously-defined fields.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"default_payment_method":{"maxLength":5000,"type":"string","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."},"footer":{"maxLength":5000,"type":"string","description":"Default footer to be displayed on invoices for this customer."},"rendering_options":{"description":"Default options for invoice PDF rendering for this customer.","anyOf":[{"title":"customer_rendering_options_param","type":"object","properties":{"amount_tax_display":{"type":"string","description":"How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.","enum":["","exclude_tax","include_inclusive_tax"]},"template":{"maxLength":5000,"type":"string","description":"ID of the invoice rendering template to use for future invoices."}},"x-stripeMostCommon":["amount_tax_display","currency_display","invoice_title","template"]},{"type":"string","enum":[""]}]}},"description":"Default invoice settings for this customer.","x-stripeMostCommon":["amount_to_forgive","amount_to_forgive_currency","custom_fields","days_until_due","default_payment_method","default_shared_payment_token","footer","rendering_options","send_hosted_payment_email","supported_payment_methods"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":256,"type":"string","description":"The customer's full name or business name."},"next_invoice_sequence":{"type":"integer","description":"The sequence to be used on the customer's next invoice. Defaults to 1."},"phone":{"maxLength":20,"type":"string","description":"The customer's phone number."},"preferred_locales":{"type":"array","description":"Customer's preferred languages, ordered by preference.","items":{"maxLength":5000,"type":"string"}},"shipping":{"description":"The customer's shipping information. Appears on invoices emailed to this customer.","anyOf":[{"title":"customer_shipping","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_customer_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Customer shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Customer name."},"phone":{"maxLength":5000,"type":"string","description":"Customer phone (including extension)."}},"x-stripeMostCommon":["address","name","phone"]},{"type":"string","enum":[""]}]},"source":{"maxLength":5000,"type":"string","x-stripeBypassValidation":true},"tax":{"title":"shared_tax_update_param","type":"object","properties":{"ip_address":{"description":"A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"validate_location":{"type":"string","description":"A flag that indicates when Stripe should validate the customer tax location. Defaults to `auto`.","enum":["auto","deferred","immediately"]}},"description":"Tax details about the customer.","x-stripeMostCommon":["ip_address","validate_location"]},"tax_exempt":{"type":"string","description":"The customer's tax exemption. One of `none`, `exempt`, or `reverse`.","enum":["","exempt","none","reverse"]},"validate":{"type":"boolean"}},"additionalProperties":false,"x-stripeMostCommon":["address","description","email","metadata","name","phone","shipping","tax"]},"encoding":{"address":{"style":"deepObject","explode":true},"business_name":{"style":"deepObject","explode":true},"cash_balance":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"individual_name":{"style":"deepObject","explode":true},"invoice_settings":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"preferred_locales":{"style":"deepObject","explode":true},"shipping":{"style":"deepObject","explode":true},"tax":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_customer"},"delete":{"summary":"Delete a customer","description":"Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
","operationId":"DeleteCustomersCustomer","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_customer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_customer"}},"/v1/customers/{customer}/balance_transactions":{"get":{"summary":"List customer balance transactions","description":"Returns a list of transactions that updated the customer’s balances.
","operationId":"GetCustomersCustomerBalanceTransactions","parameters":[{"name":"created","in":"query","description":"Only return customer balance transactions that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"query","description":"Only return transactions that are related to the specified invoice.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CustomerBalanceTransactionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/customer_balance_transaction"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_customer_balance_transactions"},"post":{"summary":"Create a customer balance transaction","description":"Creates an immutable transaction that updates the customer’s credit balance.
","operationId":"PostCustomersCustomerBalanceTransactions","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance."},"currency":{"type":"string","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://docs.stripe.com/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.","format":"currency"},"description":{"maxLength":350,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_balance_transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_customer_balance_transaction"}},"/v1/customers/{customer}/balance_transactions/{transaction}":{"get":{"summary":"Retrieve a customer balance transaction","description":"Retrieves a specific customer balance transaction that updated the customer’s balances.
","operationId":"GetCustomersCustomerBalanceTransactionsTransaction","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"transaction","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_balance_transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_customer_balance_transaction"},"post":{"summary":"Update a customer credit balance transaction","description":"Most credit balance transaction fields are immutable, but you may update its description and metadata.
Retrieves a customer’s cash balance.
","operationId":"GetCustomersCustomerCashBalance","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cash_balance"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_cash_balance"},"post":{"summary":"Update a cash balance's settings","description":"Changes the settings on a customer’s cash balance.
","operationId":"PostCustomersCustomerCashBalance","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"settings":{"title":"balance_settings_param","type":"object","properties":{"reconciliation_mode":{"type":"string","description":"Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://docs.stripe.com/payments/customer-balance/reconciliation).","enum":["automatic","manual","merchant_default"]}},"description":"A hash of settings for this cash balance.","x-stripeMostCommon":["reconciliation_mode"]}},"additionalProperties":false,"x-stripeMostCommon":["settings"]},"encoding":{"expand":{"style":"deepObject","explode":true},"settings":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cash_balance"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_cash_balance"}},"/v1/customers/{customer}/cash_balance_transactions":{"get":{"summary":"List cash balance transactions","description":"Returns a list of transactions that modified the customer’s cash balance.
","operationId":"GetCustomersCustomerCashBalanceTransactions","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"Cash Balance Transaction List","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/customer_cash_balance_transaction"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_customer_cash_balance_transactions"}},"/v1/customers/{customer}/cash_balance_transactions/{transaction}":{"get":{"summary":"Retrieve a cash balance transaction","description":"Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
","operationId":"GetCustomersCustomerCashBalanceTransactionsTransaction","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"transaction","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_cash_balance_transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_cash_balance_transaction"}},"/v1/customers/{customer}/discount":{"delete":{"summary":"Delete a customer discount","description":"Removes the currently applied discount on a customer.
","operationId":"DeleteCustomersCustomerDiscount","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_discount"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_customer_discount"}},"/v1/customers/{customer}/funding_instructions":{"post":{"summary":"Create or retrieve funding instructions for a customer cash balance","description":"Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new\nfunding instructions will be created. If funding instructions have already been created for a given customer, the same\nfunding instructions will be retrieved. In other words, we will return the same funding instructions each time.
","operationId":"PostCustomersCustomerFundingInstructions","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["bank_transfer","currency","funding_type"],"type":"object","properties":{"bank_transfer":{"title":"bank_transfer_params","required":["type"],"type":"object","properties":{"eu_bank_transfer":{"title":"eu_bank_account_params","required":["country"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."}},"description":"Configuration for eu_bank_transfer funding type.","x-stripeMostCommon":["country"]},"requested_address_types":{"type":"array","description":"List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.","items":{"type":"string","enum":["iban","sort_code","spei","zengin"],"x-stripeBypassValidation":true}},"type":{"type":"string","description":"The type of the `bank_transfer`","enum":["eu_bank_transfer","gb_bank_transfer","jp_bank_transfer","mx_bank_transfer","us_bank_transfer"],"x-stripeBypassValidation":true}},"description":"Additional parameters for `bank_transfer` funding types","x-stripeMostCommon":["eu_bank_transfer","requested_address_types","type"]},"currency":{"type":"string","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).","format":"currency"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"funding_type":{"type":"string","description":"The `funding_type` to get the instructions for.","enum":["bank_transfer"]}},"additionalProperties":false,"x-stripeMostCommon":["bank_transfer","currency","funding_type"]},"encoding":{"bank_transfer":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/funding_instructions"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_or_retrieve_funding_instructions_for_customer_balance"}},"/v1/customers/{customer}/payment_methods":{"get":{"summary":"List a Customer's PaymentMethods","description":"Returns a list of PaymentMethods for a given Customer
","operationId":"GetCustomersCustomerPaymentMethods","parameters":[{"name":"allow_redisplay","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["always","limited","unspecified"]},"x-stripeLessCommon":true},{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"type","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","custom","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"CustomerPaymentMethodResourceList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_method"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_customer_payment_methods"}},"/v1/customers/{customer}/payment_methods/{payment_method}":{"get":{"summary":"Retrieve a Customer's PaymentMethod","description":"Retrieves a PaymentMethod object for a given Customer.
","operationId":"GetCustomersCustomerPaymentMethodsPaymentMethod","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"payment_method","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_customer_payment_method"}},"/v1/customers/{customer}/sources":{"get":{"description":"List sources for a specified customer.
","operationId":"GetCustomersCustomerSources","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"object","in":"query","description":"Filter sources according to a particular object type.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ApmsSourcesSourceList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/payment_source"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"post":{"summary":"Create a card","description":"When you create a new credit card, you must specify a customer or recipient on which to create it.
\n\nIf the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.
Retrieve a specified source for a given customer.
","operationId":"GetCustomersCustomerSourcesId","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":500,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_source"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"post":{"summary":"Update a card","description":"Update a specified source for a given customer.
","operationId":"PostCustomersCustomerSourcesId","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name of the person or business that owns the bank account."},"account_holder_type":{"maxLength":5000,"type":"string","description":"The type of entity that holds the account. This can be either `individual` or `company`.","enum":["company","individual"]},"address_city":{"maxLength":5000,"type":"string","description":"City/District/Suburb/Town/Village."},"address_country":{"maxLength":5000,"type":"string","description":"Billing address country, if provided when creating card."},"address_line1":{"maxLength":5000,"type":"string","description":"Address line 1 (Street address/PO Box/Company name)."},"address_line2":{"maxLength":5000,"type":"string","description":"Address line 2 (Apartment/Suite/Unit/Building)."},"address_state":{"maxLength":5000,"type":"string","description":"State/County/Province/Region."},"address_zip":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"exp_month":{"maxLength":5000,"type":"string","description":"Two digit number representing the card’s expiration month."},"exp_year":{"maxLength":5000,"type":"string","description":"Four digit number representing the card’s expiration year."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":5000,"type":"string","description":"Cardholder name."},"owner":{"title":"owner","type":"object","properties":{"address":{"title":"source_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Owner's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"Owner's email address."},"name":{"maxLength":5000,"type":"string","description":"Owner's full name."},"phone":{"maxLength":5000,"type":"string","description":"Owner's phone number."}},"x-stripeMostCommon":["address","email","name","phone"]}},"additionalProperties":false,"x-stripeMostCommon":["account_holder_name","account_holder_type","address_city","address_country","address_line1","address_line2","address_state","address_zip","exp_month","exp_year","metadata","name","owner"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"owner":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/card"},{"$ref":"#/components/schemas/bank_account"},{"$ref":"#/components/schemas/source"}]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_customer_card,update_customer_bank_account"},"delete":{"summary":"Delete a customer source","description":"Delete a specified source for a given customer.
","operationId":"DeleteCustomersCustomerSourcesId","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/payment_source"},{"$ref":"#/components/schemas/deleted_payment_source"}]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_customer_source"}},"/v1/customers/{customer}/sources/{id}/verify":{"post":{"summary":"Verify a bank account","description":"Verify a specified bank account for a given customer.
","operationId":"PostCustomersCustomerSourcesIdVerify","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amounts":{"type":"array","description":"Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.","items":{"type":"integer"}},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["amounts"]},"encoding":{"amounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bank_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"verify_customer_source"}},"/v1/customers/{customer}/tax_ids":{"get":{"summary":"List all Customer tax IDs","description":"Returns a list of tax IDs for a customer.
","operationId":"GetCustomersCustomerTaxIds","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxIDsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/tax_id"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_tax_ids"},"post":{"summary":"Create a Customer tax ID","description":"Creates a new tax_id object for a customer.
Retrieves the tax_id object with the given identifier.
Deletes an existing tax_id object.
Returns a list of your disputes.
","operationId":"GetDisputes","parameters":[{"name":"charge","in":"query","description":"Only return disputes associated to the charge specified by this charge ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"created","in":"query","description":"Only return disputes that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_intent","in":"query","description":"Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"DisputeList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/dispute"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/disputes","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_disputes"}},"/v1/disputes/{dispute}":{"get":{"summary":"Retrieve a dispute","description":"Retrieves the dispute with the given ID.
","operationId":"GetDisputesDispute","parameters":[{"name":"dispute","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dispute"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_dispute"},"post":{"summary":"Update a dispute","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.
\n\nDepending 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":[{"name":"dispute","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"evidence":{"title":"dispute_evidence_params","type":"object","properties":{"access_activity_log":{"maxLength":20000,"type":"string","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. Has a maximum character count of 20,000."},"appeal":{"description":"Evidence to submit when appealing a dispute.","anyOf":[{"title":"appeal_evidence_params","type":"object","properties":{"card":{"description":"Evidence for a card dispute appeal.","anyOf":[{"title":"appeal_evidence_card_params","type":"object","properties":{"reason_for_filing":{"description":"An explanation of the reason for filing the appeal.","anyOf":[{"maxLength":20000,"type":"string"},{"type":"string","enum":[""]}]},"supporting_files":{"description":"One or more document IDs returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `dispute_evidence` to support the appeal.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["reason_for_filing","supporting_files"]},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["card"]},{"type":"string","enum":[""]}]},"billing_address":{"maxLength":5000,"type":"string","description":"The billing address provided by the customer."},"cancellation_policy":{"type":"string","description":"(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer."},"cancellation_policy_disclosure":{"maxLength":20000,"type":"string","description":"An explanation of how and when the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000."},"cancellation_rebuttal":{"maxLength":20000,"type":"string","description":"A justification for why the customer's subscription was not canceled. Has a maximum character count of 20,000."},"customer_communication":{"type":"string","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."},"customer_email_address":{"maxLength":5000,"type":"string","description":"The email address of the customer."},"customer_name":{"maxLength":5000,"type":"string","description":"The name of the customer."},"customer_purchase_ip":{"maxLength":5000,"type":"string","description":"The IP address that the customer used when making the purchase."},"customer_signature":{"type":"string","description":"(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature."},"duplicate_charge_documentation":{"type":"string","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."},"duplicate_charge_explanation":{"maxLength":20000,"type":"string","description":"An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Has a maximum character count of 20,000."},"duplicate_charge_id":{"maxLength":5000,"type":"string","description":"The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge."},"enhanced_evidence":{"description":"Additional evidence for qualifying evidence programs.","anyOf":[{"title":"enhanced_evidence","type":"object","properties":{"mastercard_compliance":{"title":"mastercard_compliance","type":"object","properties":{"fee_acknowledged":{"type":"boolean","description":"A field acknowledging the fee incurred when countering a Mastercard compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute."}},"description":"Evidence provided for Mastercard compliance evidence submission.","x-stripeMostCommon":["fee_acknowledged"]},"visa_compelling_evidence_3":{"title":"visa_compelling_evidence3","type":"object","properties":{"disputed_transaction":{"title":"visa_compelling_evidence3_disputed_transaction","type":"object","properties":{"customer_account_id":{"description":"User Account ID used to log into business platform. Must be recognizable by the user.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_device_fingerprint":{"description":"Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_device_id":{"description":"Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_email_address":{"description":"The email address of the customer.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_purchase_ip":{"description":"The IP address that the customer used when making the purchase.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"merchandise_or_services":{"type":"string","description":"Categorization of disputed payment.","enum":["merchandise","services"]},"product_description":{"description":"A description of the product or service that was sold.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"shipping_address":{"title":"shipping_address","type":"object","properties":{"city":{"description":"City, district, suburb, town, or village.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"country":{"description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"line1":{"description":"Address line 1, such as the street, PO Box, or company name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"line2":{"description":"Address line 2, such as the apartment, suite, unit, or building.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"postal_code":{"description":"ZIP or postal code.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"state":{"description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]}},"description":"Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.","x-stripeMostCommon":["customer_account_id","customer_device_fingerprint","customer_device_id","customer_email_address","customer_purchase_ip","merchandise_or_services","product_description","shipping_address"]},"prior_undisputed_transactions":{"type":"array","description":"List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.","items":{"title":"visa_compelling_evidence3_prior_undisputed_transaction","required":["charge"],"type":"object","properties":{"charge":{"maxLength":5000,"type":"string","description":"Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge."},"customer_account_id":{"description":"User Account ID used to log into business platform. Must be recognizable by the user.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_device_fingerprint":{"description":"Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_device_id":{"description":"Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_email_address":{"description":"The email address of the customer.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"customer_purchase_ip":{"description":"The IP address that the customer used when making the purchase.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"product_description":{"description":"A description of the product or service that was sold.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"shipping_address":{"title":"shipping_address","type":"object","properties":{"city":{"description":"City, district, suburb, town, or village.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"country":{"description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"line1":{"description":"Address line 1, such as the street, PO Box, or company name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"line2":{"description":"Address line 2, such as the apartment, suite, unit, or building.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"postal_code":{"description":"ZIP or postal code.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"state":{"description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]}},"x-stripeMostCommon":["charge","customer_account_id","customer_device_fingerprint","customer_device_id","customer_email_address","customer_purchase_ip","product_description","shipping_address"]}}},"description":"Evidence provided for Visa Compelling Evidence 3.0 evidence submission.","x-stripeMostCommon":["disputed_transaction","prior_undisputed_transactions"]},"visa_compliance":{"title":"visa_compliance","type":"object","properties":{"fee_acknowledged":{"type":"boolean","description":"A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute."}},"description":"Evidence provided for Visa compliance evidence submission.","x-stripeMostCommon":["fee_acknowledged"]}},"x-stripeMostCommon":["mastercard_compliance","visa_compelling_evidence_3","visa_compliance"]},{"type":"string","enum":[""]}]},"product_description":{"maxLength":20000,"type":"string","description":"A description of the product or service that was sold. Has a maximum character count of 20,000."},"receipt":{"type":"string","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."},"refund_policy":{"type":"string","description":"(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer."},"refund_policy_disclosure":{"maxLength":20000,"type":"string","description":"Documentation demonstrating that the customer was shown your refund policy prior to purchase. Has a maximum character count of 20,000."},"refund_refusal_explanation":{"maxLength":20000,"type":"string","description":"A justification for why the customer is not entitled to a refund. Has a maximum character count of 20,000."},"service_date":{"maxLength":5000,"type":"string","description":"The date on which the customer received or began receiving the purchased service, in a clear human-readable format."},"service_documentation":{"type":"string","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."},"shipping_address":{"maxLength":5000,"type":"string","description":"The address to which a physical product was shipped. You should try to include as complete address information as possible."},"shipping_carrier":{"maxLength":5000,"type":"string","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."},"shipping_date":{"maxLength":5000,"type":"string","description":"The date on which a physical product began its route to the shipping address, in a clear human-readable format."},"shipping_documentation":{"type":"string","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."},"shipping_tracking_number":{"maxLength":5000,"type":"string","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."},"uncategorized_file":{"type":"string","description":"(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements."},"uncategorized_text":{"maxLength":20000,"type":"string","description":"Any additional evidence or statements. Has a maximum character count of 20,000."}},"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.","x-stripeMostCommon":["access_activity_log","appeal","billing_address","booking","cancellation_policy","cancellation_policy_disclosure","cancellation_rebuttal","credit_voucher","customer_communication","customer_email_address","customer_name","customer_purchase_ip","customer_signature","duplicate_charge_documentation","duplicate_charge_explanation","duplicate_charge_id","enhanced_evidence","event_details","government_order","narrative","prior_undisputed_payments","product_description","product_service_ad","proof_of_customer_acceptance","receipt","refund_policy","refund_policy_disclosure","refund_refusal_explanation","service_date","service_documentation","shipping_address","shipping_carrier","shipping_date","shipping_documentation","shipping_tracking_number","terms_disclosure","uncategorized_data","uncategorized_file","uncategorized_text"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"intended_submission_method":{"type":"string","description":"Intended submission method for the dispute.","enum":["manual","prefer_manual","prefer_smart_disputes","smart_disputes"],"x-stripeEnum":{"kind":"closed","values":[{"description":"You'll submit the manual packet if you upload evidence and won't ever use Smart Disputes to respond to the dispute.","value":"manual"},{"description":"You'll submit the manual packet if you upload evidence, but use Smart Disputes if you have no evidence to add to the dispute response.","value":"prefer_manual"},{"description":"You'll let Smart Disputes submit the dispute response if it detects Stripe evidence, but use the manual packet otherwise.","value":"prefer_smart_disputes"},{"description":"You'll let Smart Disputes submit the dispute response if it detects Stripe evidence, and won't use the manual packet.","value":"smart_disputes"}]}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"submit":{"type":"boolean","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)."}},"additionalProperties":false,"x-stripeMostCommon":["evidence","intended_submission_method","metadata","submit"]},"encoding":{"evidence":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dispute"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_dispute"}},"/v1/disputes/{dispute}/close":{"post":{"summary":"Close a dispute","description":"Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost.
\n\nThe status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
Retrieve a list of active entitlements for a customer
","operationId":"GetEntitlementsActiveEntitlements","parameters":[{"name":"customer","in":"query","description":"The ID of the customer.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"EntitlementsResourceCustomerEntitlementList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/entitlements.active_entitlement"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_active_entitlements"}},"/v1/entitlements/active_entitlements/{id}":{"get":{"summary":"Retrieve an active entitlement","description":"Retrieve an active entitlement
","operationId":"GetEntitlementsActiveEntitlementsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The ID of the entitlement.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/entitlements.active_entitlement"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"get_active_entitlement"}},"/v1/entitlements/features":{"get":{"summary":"List all features","description":"Retrieve a list of features
","operationId":"GetEntitlementsFeatures","parameters":[{"name":"archived","in":"query","description":"If set, filter results to only include features with the given archive status.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"lookup_key","in":"query","description":"If set, filter results to only include features with the given lookup_key.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"EntitlementsResourceFeatureList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/entitlements.feature"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/entitlements/features","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_list_features"},"post":{"summary":"Create a feature","description":"Creates a feature
","operationId":"PostEntitlementsFeatures","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["lookup_key","name"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"lookup_key":{"maxLength":80,"type":"string","description":"A unique key you provide as your own system identifier. This may be up to 80 characters."},"metadata":{"type":"object","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."},"name":{"maxLength":80,"type":"string","description":"The feature's name, for your own purpose, not meant to be displayable to the customer."}},"additionalProperties":false,"x-stripeMostCommon":["lookup_key","metadata","name"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/entitlements.feature"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_create_feature"}},"/v1/entitlements/features/{id}":{"get":{"summary":"Retrieve a feature","description":"Retrieves a feature
","operationId":"GetEntitlementsFeaturesId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The ID of the feature.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/entitlements.feature"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_get_feature"},"post":{"summary":"Updates a feature","description":"Update a feature’s metadata or permanently deactivate it.
","operationId":"PostEntitlementsFeaturesId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Inactive features cannot be attached to new products and will not be returned from the features list endpoint."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"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.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":80,"type":"string","description":"The feature's name, for your own purpose, not meant to be displayable to the customer."}},"additionalProperties":false,"x-stripeMostCommon":["metadata","name"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/entitlements.feature"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_update_feature"}},"/v1/ephemeral_keys":{"post":{"summary":"Create an ephemeral key","description":"Creates a short-lived API key for a given resource.
","operationId":"PostEphemeralKeys","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"The ID of the Customer you'd like to modify using the resulting ephemeral key."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"issuing_card":{"maxLength":5000,"type":"string","description":"The ID of the Issuing Card you'd like to access using the resulting ephemeral key."},"nonce":{"maxLength":5000,"type":"string","description":"A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information."},"verification_session":{"maxLength":5000,"type":"string","description":"The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key"}},"additionalProperties":false,"x-stripeMostCommon":["customer","issuing_card","nonce","verification_session"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ephemeral_key"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_ephemeral_key"}},"/v1/ephemeral_keys/{key}":{"delete":{"summary":"Immediately invalidate an ephemeral key","description":"Invalidates a short-lived API key for a given resource.
","operationId":"DeleteEphemeralKeysKey","parameters":[{"name":"key","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ephemeral_key"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_ephemeral_key"}},"/v1/events":{"get":{"summary":"List all events","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).
Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
","operationId":"GetEventsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/event"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_event"}},"/v1/exchange_rates":{"get":{"summary":"List all exchange rates","description":"[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API instead.
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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ExchangeRateList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/exchange_rate"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/exchange_rates","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_exchange_rates_v1"}},"/v1/exchange_rates/{rate_id}":{"get":{"summary":"Retrieve an exchange rate","description":"[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API instead.
Retrieves the exchange rates from the given currency to every supported currency.
","operationId":"GetExchangeRatesRateId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"rate_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/exchange_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_exchange_rate_v1"}},"/v1/external_accounts":{"get":{"summary":"List all external accounts","description":"List external accounts for an account.
","operationId":"GetExternalAccounts","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"object","in":"query","description":"Filter external accounts according to a particular object type.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string","enum":["bank_account","card"],"x-stripeBypassValidation":true,"x-stripeParam":{"class_name":"object_type"}},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ExternalAccountList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.","items":{"$ref":"#/components/schemas/external_account"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_external_accounts"},"post":{"summary":"Create an external account","description":"Create an external account for a given connected account.
","operationId":"PostExternalAccounts","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["external_account"],"type":"object","properties":{"default_for_currency":{"type":"boolean","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"external_account":{"maxLength":5000,"type":"string","description":"Either a token, like the ones returned by [Stripe.js](https://docs.stripe.com/js), or a dictionary containing a user’s external account details (with the options shown below).","x-stripeBypassValidation":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."}},"additionalProperties":false,"x-stripeMostCommon":["external_account","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_v2_connect_external_account"}},"/v1/external_accounts/{id}":{"get":{"summary":"Retrieve an external account","description":"Retrieve a specified external account for a given account.
","operationId":"GetExternalAccountsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"Unique identifier for the external account to be retrieved.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_v2_connect_external_account"},"post":{"summary":"Update a bank account","description":"Updates the metadata, account holder name, account holder type of a bank account belonging to\na connected account and optionally sets it as the default for its currency. Other bank account\ndetails are not editable by design.
\n\nYou can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.
You can re-enable a disabled bank account by performing an update call without providing any\narguments or changes.
","operationId":"PostExternalAccountsId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name of the person or business that owns the bank account."},"account_holder_type":{"maxLength":5000,"type":"string","description":"The type of entity that holds the account. This can be either `individual` or `company`.","enum":["","company","individual"]},"account_type":{"maxLength":5000,"type":"string","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"]},"address_city":{"maxLength":5000,"type":"string","description":"City/District/Suburb/Town/Village."},"address_country":{"maxLength":5000,"type":"string","description":"Billing address country, if provided when creating card."},"address_line1":{"maxLength":5000,"type":"string","description":"Address line 1 (Street address/PO Box/Company name)."},"address_line2":{"maxLength":5000,"type":"string","description":"Address line 2 (Apartment/Suite/Unit/Building)."},"address_state":{"maxLength":5000,"type":"string","description":"State/County/Province/Region."},"address_zip":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"default_for_currency":{"type":"boolean","description":"When set to true, this becomes the default external account for its currency."},"documents":{"title":"external_account_documents_param","type":"object","properties":{"bank_account_ownership_verification":{"title":"documents_param","type":"object","properties":{"files":{"type":"array","description":"One or more document ids returned by a [file upload](https://docs.stripe.com/api#create_file) with a `purpose` value of `account_requirement`.","items":{"maxLength":500,"type":"string"}}},"description":"One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.","x-stripeMostCommon":["files"]}},"description":"Documents that may be submitted to satisfy various informational requests.","x-stripeMostCommon":["bank_account_ownership_verification"]},"exp_month":{"maxLength":5000,"type":"string","description":"Two digit number representing the card’s expiration month."},"exp_year":{"maxLength":5000,"type":"string","description":"Four digit number representing the card’s expiration year."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":5000,"type":"string","description":"Cardholder name."}},"additionalProperties":false,"x-stripeMostCommon":["default_for_currency","metadata"]},"encoding":{"documents":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_external_account,update_connect_external_account_card"},"delete":{"summary":"Delete an external account","description":"Delete a specified external account for a given account.
","operationId":"DeleteExternalAccountsId","parameters":[{"name":"id","in":"path","description":"Unique identifier for the external account to be deleted.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_external_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_v2_connect_external_account"}},"/v1/file_links":{"get":{"summary":"List all file links","description":"Returns a list of file links.
","operationId":"GetFileLinks","parameters":[{"name":"created","in":"query","description":"Only return links that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"expired","in":"query","description":"Filter links by their expiration status. By default, Stripe returns all links.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"file","in":"query","description":"Only return links for the given file.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"FileResourceFileLinkList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/file_link"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/file_links","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_file_links"},"post":{"summary":"Create a file link","description":"Creates a new file link object.
","operationId":"PostFileLinks","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["file"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","description":"The link isn't usable after this future timestamp.","format":"unix-time"},"file":{"maxLength":5000,"type":"string","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`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["expires_at","file","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_file_link"}},"/v1/file_links/{link}":{"get":{"summary":"Retrieve a file link","description":"Retrieves the file link with the given ID.
","operationId":"GetFileLinksLink","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"link","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_file_link"},"post":{"summary":"Update a file link","description":"Updates an existing file link object. Expired links can no longer be updated.
","operationId":"PostFileLinksLink","parameters":[{"name":"link","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"description":"A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.","anyOf":[{"maxLength":5000,"type":"string","enum":["now"]},{"type":"integer","format":"unix-time"},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["expires_at","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"expires_at":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_file_link"}},"/v1/files":{"get":{"summary":"List all files","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":[{"name":"created","in":"query","description":"Only return files that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"purpose","in":"query","description":"Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string","enum":["account_requirement","additional_verification","business_icon","business_logo","customer_signature","dispute_evidence","document_provider_identity_document","finance_report_run","financial_account_statement","identity_document","identity_document_downloadable","issuing_regulatory_reporting","pci_document","platform_terms_of_service","selfie","sigma_scheduled_query","tax_document_user_upload","terminal_android_apk","terminal_reader_splashscreen","terminal_wifi_certificate","terminal_wifi_private_key"],"x-stripeBypassValidation":true}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"FileResourceFileList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/file"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/files","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_files"},"post":{"summary":"Create a file","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.
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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"file","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_file"}},"/v1/financial_connections/accounts":{"get":{"summary":"List Accounts","description":"Returns a list of Financial Connections Account objects.
Retrieves the details of a Financial Connections Account.
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).
Lists the recorded inferred balances for a Financial Connections Account.
Lists all owners for a given Account
Refreshes the data associated with a Financial Connections Account.
Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.
Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
Retrieves the details of a Financial Connections Authorization.
Returns a list of Financial Connections Institution objects.
Retrieves the details of a Financial Connections Institution.
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.
Retrieves the details of a Financial Connections Session
Returns a list of Financial Connections Transaction objects.
Retrieves the details of a Financial Connections Transaction
Lists all ForwardingRequest objects.
","operationId":"GetForwardingRequests","parameters":[{"name":"created","in":"query","description":"Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.","required":false,"style":"deepObject","explode":true,"schema":{"title":"created_param","type":"object","properties":{"gt":{"type":"integer","description":"Return results where the `created` field is greater than this value."},"gte":{"type":"integer","description":"Return results where the `created` field is greater than or equal to this value."},"lt":{"type":"integer","description":"Return results where the `created` field is less than this value."},"lte":{"type":"integer","description":"Return results where the `created` field is less than or equal to this value."}},"x-stripeMostCommon":["gt","gte","lt","lte"]}},{"name":"ending_before","in":"query","description":"A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"starting_after","in":"query","description":"A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ForwardingRequestList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/forwarding.request"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"List of ForwardingRequest data.","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_forwarding_requests"},"post":{"summary":"Create a ForwardingRequest","description":"Creates a ForwardingRequest object.
","operationId":"PostForwardingRequests","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["payment_method","replacements","url"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed."},"replacements":{"type":"array","description":"The field kinds to be replaced in the forwarded request.","items":{"type":"string","enum":["card_cvc","card_expiry","card_number","cardholder_name","request_signature"],"x-stripeBypassValidation":true}},"request":{"title":"request_param","type":"object","properties":{"body":{"maxLength":5000,"type":"string","description":"The body payload to send to the destination endpoint."},"headers":{"type":"array","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":{"title":"header_param","required":["name","value"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The header name."},"value":{"maxLength":5000,"type":"string","description":"The header value."}},"x-stripeMostCommon":["name","value"]}}},"description":"The request body and headers to be sent to the destination endpoint.","x-stripeMostCommon":["body","headers"]},"url":{"maxLength":5000,"type":"string","description":"The destination URL for the forwarded request. Must be supported by the config."}},"additionalProperties":false,"x-stripeMostCommon":["metadata","payment_method","replacements","request","url"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"replacements":{"style":"deepObject","explode":true},"request":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forwarding.request"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_forwarding_request"}},"/v1/forwarding/requests/{id}":{"get":{"summary":"Retrieve a ForwardingRequest","description":"Retrieves a ForwardingRequest object.
","operationId":"GetForwardingRequestsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forwarding.request"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_forwarding_request"}},"/v1/fx_quotes":{"get":{"summary":"List active FX Quotes","description":"Returns a list of active FX quotes. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
","operationId":"GetFxQuotes","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"FXFXQuoteResourceMerchantFXQuoteList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/fx_quote"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/fx_quotes","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_fx_quotes"},"post":{"summary":"Create an FX Quote","description":"Creates an FX Quote object
","operationId":"PostFxQuotes","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["from_currencies","lock_duration","to_currency"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"from_currencies":{"type":"array","description":"A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).","items":{"type":"string","format":"currency"}},"lock_duration":{"type":"string","description":"The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.","enum":["day","five_minutes","hour","none"]},"to_currency":{"type":"string","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).","format":"currency"},"usage":{"title":"usage_param","required":["type"],"type":"object","properties":{"payment":{"title":"payment_param","type":"object","properties":{"destination":{"type":"string","description":"The Stripe account ID that the funds will be transferred to.\n\nThis field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field."},"on_behalf_of":{"type":"string","description":"The Stripe account ID that these funds are intended for.\n\nThis field should match the account ID that would be used in the PaymentIntent’s on_behalf_of field."}},"description":"The payment transaction details that are intended for the FX Quote.","x-stripeMostCommon":["destination","on_behalf_of"]},"transfer":{"title":"transfer_param","required":["destination"],"type":"object","properties":{"destination":{"type":"string","description":"The Stripe account ID that the funds will be transferred to.\n\nThis field should match the account ID that would be used in the Transfer’s destination field."}},"description":"The transfer transaction details that are intended for the FX Quote.","x-stripeMostCommon":["destination"]},"type":{"type":"string","description":"Which transaction the FX Quote will be used for\n\nCan be “payment” | “transfer”","enum":["payment","transfer"],"x-stripeBypassValidation":true}},"description":"The usage specific information for the quote.","x-stripeMostCommon":["payment","transfer","type"]}},"additionalProperties":false,"x-stripeMostCommon":["from_currencies","lock_duration","to_currency"]},"encoding":{"expand":{"style":"deepObject","explode":true},"from_currencies":{"style":"deepObject","explode":true},"usage":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fx_quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_fx_quote"}},"/v1/fx_quotes/{id}":{"get":{"summary":"Retrieve an FX Quote","description":"Retrieve an FX Quote object
","operationId":"GetFxQuotesId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fx_quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_fx_quote"}},"/v1/identity/verification_reports":{"get":{"summary":"List VerificationReports","description":"List all verification reports.
","operationId":"GetIdentityVerificationReports","parameters":[{"name":"client_reference_id","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"created","in":"query","description":"Only return VerificationReports that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"type","in":"query","description":"Only return VerificationReports of this type","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["document","id_number"],"x-stripeBypassValidation":true}},{"name":"verification_session","in":"query","description":"Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"GelatoVerificationReportList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/identity.verification_report"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/identity/verification_reports","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_identity_verification_reports"}},"/v1/identity/verification_reports/{report}":{"get":{"summary":"Retrieve a VerificationReport","description":"Retrieves an existing VerificationReport
","operationId":"GetIdentityVerificationReportsReport","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"report","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity.verification_report"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_identity_verification_report"}},"/v1/identity/verification_sessions":{"get":{"summary":"List VerificationSessions","description":"Returns a list of VerificationSessions
","operationId":"GetIdentityVerificationSessions","parameters":[{"name":"client_reference_id","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"created","in":"query","description":"Only return VerificationSessions that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"related_customer","in":"query","description":"Customer ID","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"related_customer_account","in":"query","description":"The ID of the Account representing a customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","processing","requires_input","verified"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"GelatoVerificationSessionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/identity.verification_session"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/identity/verification_sessions","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_identity_verification_sessions"},"post":{"summary":"Create a VerificationSession","description":"Creates a VerificationSession object.
\n\nAfter 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.
\n\nRelated guide: Verify your users’ identity documents
","operationId":"PostIdentityVerificationSessions","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_reference_id":{"maxLength":5000,"type":"string","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"options":{"title":"session_options_param","type":"object","properties":{"document":{"description":"Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).","anyOf":[{"title":"document_options","type":"object","properties":{"allowed_types":{"type":"array","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":{"type":"string","enum":["driving_license","id_card","passport"]}},"require_id_number":{"type":"boolean","description":"Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."},"require_live_capture":{"type":"boolean","description":"Disable image uploads, identity document images have to be captured using the device’s camera."},"require_matching_selfie":{"type":"boolean","description":"Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."}},"x-stripeMostCommon":["allowed_types","require_id_number","require_live_capture","require_matching_selfie"]},{"type":"string","enum":[""]}]}},"description":"A set of options for the session’s verification checks.","x-stripeMostCommon":["document","duplicate","email","matching","phone","phone_otp","phone_records"]},"provided_details":{"title":"provided_details_param","type":"object","properties":{"email":{"type":"string","description":"Email of user being verified"},"phone":{"type":"string","description":"Phone number of user being verified"}},"description":"Details provided about the user being verified. These details might be shown to the user.","x-stripeMostCommon":["address","dob","email","name","phone"]},"related_customer":{"maxLength":5000,"type":"string","description":"Customer ID"},"related_customer_account":{"maxLength":5000,"type":"string","description":"The ID of the Account representing a customer."},"related_person":{"title":"related_person_param","required":["account","person"],"type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"A token representing a connected account. If provided, the person parameter is also required and must be associated with the account."},"person":{"maxLength":5000,"type":"string","description":"A token referencing a Person resource that this verification is being used to verify."}},"description":"Tokens referencing a Person resource and its associated account.","x-stripeMostCommon":["account","person"]},"return_url":{"type":"string","description":"The URL that the user will be redirected to upon completing the verification flow."},"type":{"type":"string","description":"The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.","enum":["document","id_number"],"x-stripeBypassValidation":true},"verification_flow":{"maxLength":5000,"type":"string","description":"The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows."}},"additionalProperties":false,"x-stripeMostCommon":["client_reference_id","metadata","options","provided_details","related_customer","related_customer_account","related_person","return_url","type","verification_flow"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"options":{"style":"deepObject","explode":true},"provided_details":{"style":"deepObject","explode":true},"related_person":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity.verification_session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_identity_verification_session"}},"/v1/identity/verification_sessions/{session}":{"get":{"summary":"Retrieve a VerificationSession","description":"Retrieves the details of a VerificationSession that was previously created.
\n\nWhen the session status is requires_input, you can use this method to retrieve a valid\nclient_secret or url to allow re-submission.
Updates a VerificationSession object.
\n\nWhen the session status is requires_input, you can use this method to update the\nverification check and options.
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":[{"name":"session","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity.verification_session"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_identity_verification_session"}},"/v1/identity/verification_sessions/{session}/redact":{"post":{"summary":"Redact a VerificationSession","description":"Redact a VerificationSession to remove all collected information from Stripe. This will redact\nthe VerificationSession and all objects related to it, including VerificationReports, Events,\nrequest logs, etc.
\n\nA VerificationSession object can be redacted when it is in requires_input or verified\nstatus. Redacting a VerificationSession in requires_action\nstate will automatically cancel it.
The redaction process may take up to four days. When the redaction process is in progress, the\nVerificationSession’s redaction.status field will be set to processing; when the process is\nfinished, it will change to redacted and an identity.verification_session.redacted event\nwill be emitted.
Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the\nfields that contain personal data will be replaced by the string [redacted] or a similar\nplaceholder. The metadata field will also be erased. Redacted objects cannot be updated or\nused for any purpose.
When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
","operationId":"GetInvoicePayments","parameters":[{"name":"created","in":"query","description":"Only return invoice payments that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"query","description":"The identifier of the invoice whose payments to return.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment","in":"query","description":"The payment details of the invoice payments to return.","required":false,"style":"deepObject","explode":true,"schema":{"title":"payment_param","required":["type"],"type":"object","properties":{"payment_intent":{"maxLength":5000,"type":"string","description":"Only return invoice payments associated by this payment intent ID."},"payment_record":{"maxLength":5000,"type":"string","description":"Only return invoice payments associated by this payment record ID."},"type":{"type":"string","description":"Only return invoice payments associated by this payment type.","enum":["payment_intent","payment_record"]}},"x-stripeMostCommon":["payment_intent","payment_record","type"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"The status of the invoice payments to return.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","open","paid"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"InvoicesPaymentsListInvoicePayments","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/invoice_payment"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"top_level_list_invoice_payments"}},"/v1/invoice_payments/{invoice_payment}":{"get":{"summary":"Retrieve an InvoicePayment","description":"Retrieves the invoice payment with the given ID.
","operationId":"GetInvoicePaymentsInvoicePayment","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice_payment","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice_payment"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"top_level_retrieve_invoice_payment"}},"/v1/invoice_rendering_templates":{"get":{"summary":"List all invoice rendering templates","description":"List all templates, ordered by creation date, with the most recently created template appearing first.
","operationId":"GetInvoiceRenderingTemplates","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["active","archived"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"InvoiceRenderingTemplatesList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/invoice_rendering_template"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_invoice_rendering_templates"}},"/v1/invoice_rendering_templates/{template}":{"get":{"summary":"Retrieve an invoice rendering template","description":"Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
","operationId":"GetInvoiceRenderingTemplatesTemplate","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"template","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"version","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice_rendering_template"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_invoice_rendering_template"}},"/v1/invoice_rendering_templates/{template}/archive":{"post":{"summary":"Archive an invoice rendering template","description":"Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
","operationId":"PostInvoiceRenderingTemplatesTemplateArchive","parameters":[{"name":"template","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice_rendering_template"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"archive_invoice_rendering_template"}},"/v1/invoice_rendering_templates/{template}/unarchive":{"post":{"summary":"Unarchive an invoice rendering template","description":"Unarchive an invoice rendering template so it can be used on new Stripe objects again.
","operationId":"PostInvoiceRenderingTemplatesTemplateUnarchive","parameters":[{"name":"template","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice_rendering_template"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"unarchive_invoice_rendering_template"}},"/v1/invoiceitems":{"get":{"summary":"List all invoice items","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":[{"name":"created","in":"query","description":"Only return invoice items that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"pending","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"InvoicesItemsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/invoiceitem"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/invoiceitems","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_invoice_items"},"post":{"summary":"Create an invoice item","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":{"schema":{"type":"object","properties":{"amount":{"type":"integer","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."},"currency":{"type":"string","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).","format":"currency"},"customer":{"maxLength":5000,"type":"string","description":"The ID of the customer to bill for this invoice item."},"customer_account":{"maxLength":5000,"type":"string","description":"The ID of the account representing the customer to bill for this invoice item."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking."},"discountable":{"type":"boolean","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."},"discounts":{"description":"The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice":{"maxLength":5000,"type":"string","description":"The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the 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."},"margins":{"type":"array","description":"The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"period":{"title":"period","required":["end","start"],"type":"object","properties":{"end":{"type":"integer","description":"The end of the period, which must be greater than or equal to the start. This value is inclusive.","format":"unix-time"},"start":{"type":"integer","description":"The start of the period. This value is inclusive.","format":"unix-time"}},"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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.","x-stripeMostCommon":["end","start"]},"price_data":{"title":"one_time_price_data","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","unit_amount"]},"pricing":{"title":"pricing_param","type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."}},"description":"The pricing information for the invoice item.","x-stripeMostCommon":["price"]},"quantity":{"type":"integer","description":"Non-negative integer. The quantity of units for the invoice item. Use `quantity_decimal` instead to provide decimal precision. This field will be deprecated in favor of `quantity_decimal` in a future version."},"quantity_decimal":{"type":"string","description":"Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.","format":"decimal"},"subscription":{"maxLength":5000,"type":"string","description":"The ID of a subscription to add this invoice item to. When left blank, the invoice item is 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."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"tax_rates":{"type":"array","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"}},"unit_amount_decimal":{"type":"string","description":"The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.","format":"decimal"}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","customer","customer_account","description","metadata","period","pricing"]},"encoding":{"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"margins":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"period":{"style":"deepObject","explode":true},"price_data":{"style":"deepObject","explode":true},"pricing":{"style":"deepObject","explode":true},"tax_code":{"style":"deepObject","explode":true},"tax_rates":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceitem"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_invoice_item"}},"/v1/invoiceitems/{invoiceitem}":{"get":{"summary":"Retrieve an invoice item","description":"Retrieves the invoice item with the given ID.
","operationId":"GetInvoiceitemsInvoiceitem","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoiceitem","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceitem"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_invoice_item"},"post":{"summary":"Update an invoice item","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":[{"name":"invoiceitem","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","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."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking."},"discountable":{"type":"boolean","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."},"discounts":{"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.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoicing_rules":{"type":"string","description":"Pass an empty string to remove previously-defined invoicing rules. Setting invoicing rules is not supported.","enum":[""]},"margins":{"description":"The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"period":{"title":"period","required":["end","start"],"type":"object","properties":{"end":{"type":"integer","description":"The end of the period, which must be greater than or equal to the start. This value is inclusive.","format":"unix-time"},"start":{"type":"integer","description":"The start of the period. This value is inclusive.","format":"unix-time"}},"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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.","x-stripeMostCommon":["end","start"]},"price_data":{"title":"one_time_price_data","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","unit_amount"]},"pricing":{"title":"pricing_param","type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."}},"description":"The pricing information for the invoice item.","x-stripeMostCommon":["price"]},"quantity":{"type":"integer","description":"Non-negative integer. The quantity of units for the invoice item. Use `quantity_decimal` instead to provide decimal precision. This field will be deprecated in favor of `quantity_decimal` in a future version."},"quantity_decimal":{"type":"string","description":"Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.","format":"decimal"},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"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. Pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"unit_amount_decimal":{"type":"string","description":"The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.","format":"decimal"}},"additionalProperties":false,"x-stripeMostCommon":["amount","description","metadata","period","pricing"]},"encoding":{"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"margins":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"period":{"style":"deepObject","explode":true},"price_data":{"style":"deepObject","explode":true},"pricing":{"style":"deepObject","explode":true},"tax_code":{"style":"deepObject","explode":true},"tax_rates":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceitem"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_invoice_item"},"delete":{"summary":"Delete an invoice item","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":[{"name":"invoiceitem","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_invoiceitem"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_invoice_item"}},"/v1/invoices":{"get":{"summary":"List all invoices","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":[{"name":"collection_method","in":"query","description":"The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["charge_automatically","send_invoice"]},"x-stripeLessCommon":true},{"name":"created","in":"query","description":"Only return invoices that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return invoices for the customer specified by this customer ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"Only return invoices for the account representing the customer specified by this account ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"due_date","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["draft","open","paid","uncollectible","void"]}},{"name":"subscription","in":"query","description":"Only return invoices for the subscription specified by this subscription ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"InvoicesResourceList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/invoice"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/invoices","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_invoices"},"post":{"summary":"Create an invoice","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":{"schema":{"type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the invoice. Only editable when the invoice is a draft.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"amounts_due":{"description":"List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.","anyOf":[{"type":"array","items":{"title":"payment_plan_amount_param","required":["amount","description"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount in cents (or local equivalent)."},"days_until_due":{"type":"integer","description":"Number of days from when invoice is finalized until the payment is due."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"due_date":{"type":"integer","description":"Date on which a payment plan’s payment is due.","format":"unix-time"}},"x-stripeMostCommon":["amount","days_until_due","description","due_date"]}},{"type":"string","enum":[""]}]},"application_fee_amount":{"type":"integer","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://docs.stripe.com/billing/invoices/connect#collecting-fees)."},"auto_advance":{"type":"boolean","description":"Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false."},"automatic_tax":{"title":"automatic_tax_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Settings for automatic tax lookup for this invoice.","x-stripeMostCommon":["enabled","liability","withhold_tax"]},"automatically_finalizes_at":{"type":"integer","description":"The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.","format":"unix-time"},"collection_method":{"type":"string","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"]},"currency":{"type":"string","description":"The currency to create this invoice in. Defaults to that of `customer` if not specified.","format":"currency"},"custom_fields":{"description":"A list of up to 4 custom fields to be displayed on the invoice.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"customer":{"maxLength":5000,"type":"string","description":"The ID of the customer to bill."},"customer_account":{"maxLength":5000,"type":"string","description":"The ID of the account to bill."},"days_until_due":{"type":"integer","description":"The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`."},"default_margins":{"type":"array","description":"The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.","items":{"maxLength":5000,"type":"string"}},"default_payment_method":{"maxLength":5000,"type":"string","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."},"default_source":{"maxLength":5000,"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":{"type":"array","description":"The tax rates that will apply to any line item that does not have `tax_rates` set.","items":{"maxLength":5000,"type":"string"}},"description":{"maxLength":1500,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard."},"discounts":{"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.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"due_date":{"type":"integer","description":"The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.","format":"unix-time"},"effective_at":{"type":"integer","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"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"footer":{"maxLength":5000,"type":"string","description":"Footer to be displayed on the invoice."},"from_invoice":{"title":"from_invoice","required":["action","invoice"],"type":"object","properties":{"action":{"maxLength":5000,"type":"string","description":"The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted","enum":["revision"]},"invoice":{"maxLength":5000,"type":"string","description":"The `id` of the invoice that will be cloned."}},"description":"Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details.","x-stripeMostCommon":["action","invoice"]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"number":{"maxLength":26,"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":{"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://docs.stripe.com/billing/invoices/connect) documentation for details."},"payment_settings":{"title":"payment_settings","type":"object","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.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"payment_method_options":{"title":"payment_method_options","type":"object","properties":{"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.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["transaction_type"]},"verification_method":{"type":"string","description":"Verification method for the intent","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["mandate_options","verification_method"]},{"type":"string","enum":[""]}]},"bancontact":{"description":"If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"preferred_language":{"type":"string","description":"Preferred language of the Bancontact authorization page that the customer is redirected to.","enum":["de","en","fr","nl"]}},"x-stripeMostCommon":["preferred_language"]},{"type":"string","enum":[""]}]},"billie":{"description":"If paying by `billie`, this sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"company_details":{"description":"Registration details about the buyer's organization.","anyOf":[{"title":"company_details_param","type":"object","properties":{"registered_address":{"description":"The address the company or entity is registered with.","anyOf":[{"title":"registered_address_param","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1 (for example, street, PO Box, or company name)."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2 (for example, apartment, suite, unit, or building)."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"registered_name":{"maxLength":5000,"type":"string","description":"Company or entity name."},"registration_number":{"maxLength":5000,"type":"string","description":"The official registration number for the given registration type."},"registration_type":{"type":"string","description":"Type of registration the company or entity holds in their registered country.","enum":["","ch_ein","de_hrb","dk_cvr","es_cif","fi_tunnus","fr_siren","fr_siret","it_rea","nl_kvk","no_org_number","no_pno","se_org_number","se_pno","uk_crn"]},"vat":{"maxLength":5000,"type":"string","description":"VAT ID number."}},"x-stripeMostCommon":["registered_address","registered_name","registration_number","registration_type","vat"]},{"type":"string","enum":[""]}]},"reference":{"maxLength":5000,"type":"string","description":"An identifier or reference that this payment corresponds to."}},"x-stripeMostCommon":["company_details","extra_merchant_data_blob","reference"]},{"type":"string","enum":[""]}]},"blik":{"description":"If paying by `blik`, this sub-hash contains details about the Blik payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{}},{"type":"string","enum":[""]}]},"card":{"description":"If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"installments":{"title":"installments_param","type":"object","properties":{"enabled":{"type":"boolean","description":"Setting to true enables installments for this invoice.\nSetting to false will prevent any selected plan from applying to a payment."},"plan":{"description":"The selected installment plan to use for this invoice.","anyOf":[{"title":"installment_plan","required":["type"],"type":"object","properties":{"count":{"type":"integer","description":"For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card."},"interval":{"type":"string","description":"For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.","enum":["month"]},"type":{"type":"string","description":"Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.","enum":["bonus","fixed_count","revolving"]}},"x-stripeMostCommon":["count","interval","type"]},{"type":"string","enum":[""]}]}},"description":"Installment configuration for payments attempted on this invoice.\n\nFor more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).","x-stripeMostCommon":["enabled","plan"]},"request_three_d_secure":{"type":"string","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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"]}},"x-stripeMostCommon":["installments","mcc","request_three_d_secure"]},{"type":"string","enum":[""]}]},"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.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"bank_transfer":{"title":"bank_transfer_param","type":"object","properties":{"eu_bank_transfer":{"title":"eu_bank_transfer_param","required":["country"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."}},"description":"Configuration for eu_bank_transfer funding type.","x-stripeMostCommon":["country"]},"type":{"type":"string","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`."}},"description":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.","x-stripeMostCommon":["eu_bank_transfer","id_bank_transfer","type"]},"funding_type":{"type":"string","description":"The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."}},"x-stripeMostCommon":["bank_transfer","funding_type"]},{"type":"string","enum":[""]}]},"id_bank_transfer":{"description":"If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{}},{"type":"string","enum":[""]}]},"konbini":{"description":"If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{}},{"type":"string","enum":[""]}]},"payto":{"description":"If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit."},"purpose":{"type":"string","description":"The purpose for which payments are made. Has a default value based on your merchant category code.","enum":["dependant_support","government","loan","mortgage","other","pension","personal","retail","salary","tax","utility"]}},"description":"Additional fields for Mandate creation.","x-stripeMostCommon":["amount","purpose"]}},"x-stripeMostCommon":["mandate_options"]},{"type":"string","enum":[""]}]},"pix":{"description":"If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"amount_includes_iof":{"type":"string","description":"Determines if the amount includes the IOF tax. Defaults to `never`.","enum":["always","never"]},"expires_after_seconds":{"type":"integer","description":"The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds."}},"x-stripeMostCommon":["amount_includes_iof","expires_after_seconds"]},{"type":"string","enum":[""]}]},"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.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{},"x-stripeMostCommon":["verification_method"]},{"type":"string","enum":[""]}]},"upi":{"description":"If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"invoice_payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]}},"x-stripeMostCommon":["mandate_options"]},{"type":"string","enum":[""]}]},"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.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"financial_connections":{"title":"invoice_linked_account_options_param","type":"object","properties":{"filters":{"title":"invoice_linked_account_options_filters_param","type":"object","properties":{"account_subcategories":{"type":"array","description":"The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.","items":{"type":"string","enum":["checking","savings"]}},"institution":{"maxLength":5000,"type":"string","description":"ID of the institution to use to filter for selectable accounts."}},"description":"Provide filters for the linked accounts that the customer can select for the payment method.","x-stripeMostCommon":["account_subcategories","institution"]},"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.","items":{"maxLength":5000,"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeBypassValidation":true}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","inferred_balances","ownership","transactions"],"x-stripeBypassValidation":true}}},"description":"Additional fields for Financial Connections Session creation","x-stripeMostCommon":["filters","permissions","prefetch"]},"verification_method":{"type":"string","description":"Verification method for the intent","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["financial_connections","verification_method"]},{"type":"string","enum":[""]}]}},"description":"Payment-method-specific configuration to provide to the invoice’s PaymentIntent.","x-stripeMostCommon":["acss_debit","bacs_debit","bancontact","billie","bizum","blik","card","check_scan","customer_balance","id_bank_transfer","konbini","payto","pix","sepa_debit","upi","us_bank_account","wechat_pay"]},"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).","anyOf":[{"type":"array","items":{"type":"string","enum":["ach_credit_transfer","ach_debit","acss_debit","affirm","alipay","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","blik","boleto","card","cashapp","crypto","custom","customer_balance","eps","fpx","giropay","grabpay","id_bank_transfer","ideal","jp_credit_transfer","kakao_pay","klarna","konbini","kr_card","link","mb_way","multibanco","naver_pay","nz_bank_account","p24","pay_by_bank","payco","paynow","paypal","payto","pix","promptpay","revolut_pay","satispay","sepa_credit_transfer","sepa_debit","sofort","stripe_balance","swish","twint","upi","us_bank_account","wechat_pay"],"x-stripeBypassValidation":true}},{"type":"string","enum":[""]}]}},"description":"Configuration settings for the PaymentIntent that is generated when the invoice is finalized.","x-stripeMostCommon":["default_mandate","payment_method_configuration","payment_method_options","payment_method_types"]},"pending_invoice_items_behavior":{"type":"string","description":"How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.","enum":["exclude","include"],"x-stripeBypassValidation":true},"rendering":{"title":"rendering_param","type":"object","properties":{"amount_tax_display":{"type":"string","description":"How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.","enum":["","exclude_tax","include_inclusive_tax"]},"pdf":{"title":"rendering_pdf_param","type":"object","properties":{"page_size":{"type":"string","description":"Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.\n If set to `auto`, invoice PDF page size defaults to `a4` for customers with\n Japanese locale and `letter` for customers with other locales.","enum":["a4","auto","letter"]}},"description":"Invoice pdf rendering options","x-stripeMostCommon":["page_size"]},"template":{"maxLength":5000,"type":"string","description":"ID of the invoice rendering template to use for this invoice."},"template_version":{"description":"The specific version of invoice rendering template to use for this invoice.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]}},"description":"The rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.","x-stripeMostCommon":["amount_tax_display","currency_display","custom_text","invoice_title","pdf","summary_items_data","template","template_version"]},"shipping_cost":{"title":"shipping_cost","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the shipping rate to use for this order."},"shipping_rate_data":{"title":"create_params","required":["display_name"],"type":"object","properties":{"delivery_estimate":{"title":"delivery_estimate","type":"object","properties":{"maximum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.","x-stripeMostCommon":["unit","value"]},"minimum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The lower bound of the estimated range. If empty, represents no lower bound.","x-stripeMostCommon":["unit","value"]}},"description":"The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.","x-stripeMostCommon":["maximum","minimum"]},"display_name":{"maxLength":100,"type":"string","description":"The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."},"fixed_amount":{"title":"fixed_amount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"x-stripeMostCommon":["amount","tax_behavior"]},"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)."}},"description":"Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.","x-stripeMostCommon":["amount","currency","currency_options"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`."},"type":{"type":"string","description":"The type of calculation to use on the shipping rate.","enum":["fixed_amount"]}},"description":"Parameters to create a new ad-hoc shipping rate for this order.","x-stripeMostCommon":["display_name","fixed_amount","metadata","tax_behavior","tax_code","type"]}},"description":"Settings for the cost of shipping for this invoice.","x-stripeMostCommon":["shipping_rate","shipping_rate_data"]},"shipping_details":{"title":"recipient_shipping_with_optional_fields_address","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Recipient name."},"phone":{"description":"Recipient phone (including extension)","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"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.","x-stripeMostCommon":["address","name","phone"]},"statement_descriptor":{"maxLength":22,"type":"string","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`."},"subscription":{"maxLength":5000,"type":"string","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."},"transfer_data":{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"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.","x-stripeMostCommon":["amount","destination"]}},"additionalProperties":false,"x-stripeMostCommon":["auto_advance","automatic_tax","collection_method","customer","customer_account","description","metadata","subscription"]},"encoding":{"account_tax_ids":{"style":"deepObject","explode":true},"amounts_due":{"style":"deepObject","explode":true},"automatic_tax":{"style":"deepObject","explode":true},"custom_fields":{"style":"deepObject","explode":true},"default_margins":{"style":"deepObject","explode":true},"default_tax_rates":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"from_invoice":{"style":"deepObject","explode":true},"issuer":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_settings":{"style":"deepObject","explode":true},"rendering":{"style":"deepObject","explode":true},"shipping_cost":{"style":"deepObject","explode":true},"shipping_details":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_invoice"}},"/v1/invoices/create_preview":{"post":{"summary":"Create a preview invoice","description":"At any time, you can preview the upcoming invoice for a subscription or subscription schedule. 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.
\n\nYou can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that 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 on the invoice is to consider line items where parent.subscription_item_details.proration is true.
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.
\n\nNote: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more
","operationId":"PostInvoicesCreatePreview","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"automatic_tax":{"title":"automatic_tax_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Settings for automatic tax lookup for this invoice preview.","x-stripeMostCommon":["enabled","liability","withhold_tax"]},"currency":{"type":"string","description":"The currency to preview this invoice in. Defaults to that of `customer` if not specified.","format":"currency"},"customer":{"maxLength":5000,"type":"string","description":"The identifier of the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set."},"customer_account":{"maxLength":5000,"type":"string","description":"The identifier of the account representing the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set."},"customer_details":{"title":"customer_details_param","type":"object","properties":{"address":{"description":"The customer's address. Learn about [country-specific requirements for calculating tax](/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).","anyOf":[{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"shipping":{"description":"The customer's shipping information. Appears on invoices emailed to this customer.","anyOf":[{"title":"customer_shipping","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_customer_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Customer shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Customer name."},"phone":{"maxLength":5000,"type":"string","description":"Customer phone (including extension)."}},"x-stripeMostCommon":["address","name","phone"]},{"type":"string","enum":[""]}]},"tax":{"title":"tax_param","type":"object","properties":{"ip_address":{"description":"A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details about the customer.","x-stripeMostCommon":["ip_address"]},"tax_exempt":{"type":"string","description":"The customer's tax exemption. One of `none`, `exempt`, or `reverse`.","enum":["","exempt","none","reverse"]},"tax_ids":{"type":"array","description":"The customer's tax IDs.","items":{"title":"data_params","required":["type","value"],"type":"object","properties":{"type":{"maxLength":5000,"type":"string","description":"Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `fo_vat`, `gb_vat`, `ge_vat`, `gi_tin`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `ic_nif`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `it_cf`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `py_ruc`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`","enum":["ad_nrt","ae_trn","al_tin","am_tin","ao_tin","ar_cuit","au_abn","au_arn","aw_tin","az_tin","ba_tin","bb_tin","bd_bin","bf_ifu","bg_uic","bh_vat","bj_ifu","bo_tin","br_cnpj","br_cpf","bs_tin","by_tin","ca_bn","ca_gst_hst","ca_pst_bc","ca_pst_mb","ca_pst_sk","ca_qst","cd_nif","ch_uid","ch_vat","cl_tin","cm_niu","cn_tin","co_nit","cr_tin","cv_nif","de_stn","do_rcn","ec_ruc","eg_tin","es_cif","et_tin","eu_oss_vat","eu_vat","fo_vat","gb_vat","ge_vat","gi_tin","gn_nif","hk_br","hr_oib","hu_tin","ic_nif","id_npwp","il_vat","in_gst","is_vat","it_cf","jp_cn","jp_rn","jp_trn","ke_pin","kg_tin","kh_tin","kr_brn","kz_bin","la_tin","li_uid","li_vat","lk_vat","ma_vat","md_vat","me_pib","mk_vat","mr_nif","mx_rfc","my_frp","my_itn","my_sst","ng_tin","no_vat","no_voec","np_pan","nz_gst","om_vat","pe_ruc","ph_tin","pl_nip","py_ruc","ro_tin","rs_pib","ru_inn","ru_kpp","sa_vat","sg_gst","sg_uen","si_tin","sn_ninea","sr_fin","sv_nit","th_vat","tj_tin","tr_tin","tw_vat","tz_vat","ua_vat","ug_tin","us_ein","uy_ruc","uz_tin","uz_vat","ve_rif","vn_tin","za_vat","zm_tin","zw_tin"],"x-stripeBypassValidation":true},"value":{"type":"string","description":"Value of the tax ID."}},"x-stripeMostCommon":["type","value"]}}},"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.","x-stripeMostCommon":["address","shipping","tax","tax_exempt","tax_ids"]},"discounts":{"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.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_items":{"type":"array","description":"List of invoice items to add or update in the upcoming invoice preview (up to 250).","items":{"title":"invoice_item_preview_params","type":"object","properties":{"amount":{"type":"integer","description":"The integer amount in cents (or local equivalent) of previewed invoice item."},"currency":{"type":"string","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). Only applicable to new invoice items.","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking."},"discountable":{"type":"boolean","description":"Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items."},"discounts":{"description":"The coupons to redeem into discounts for the invoice item in the preview.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"invoiceitem":{"maxLength":5000,"type":"string","description":"The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"period":{"title":"period","required":["end","start"],"type":"object","properties":{"end":{"type":"integer","description":"The end of the period, which must be greater than or equal to the start. This value is inclusive.","format":"unix-time"},"start":{"type":"integer","description":"The start of the period. This value is inclusive.","format":"unix-time"}},"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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.","x-stripeMostCommon":["end","start"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. One of `price` or `price_data` is required."},"price_data":{"title":"one_time_price_data","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"Non-negative integer. The quantity of units for the invoice item. Use `quantity_decimal` instead to provide decimal precision. This field will be deprecated in favor of `quantity_decimal` in a future version."},"quantity_decimal":{"type":"string","description":"Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.","format":"decimal"},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"tax_rates":{"description":"The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"unit_amount":{"type":"integer","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."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["amount","currency","description","discountable","discounts","invoiceitem","metadata","period","price","quantity","quantity_decimal","tax_behavior","tax_code","tax_rates","unit_amount","unit_amount_decimal"]}},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]},"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://docs.stripe.com/billing/invoices/connect) documentation for details.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"preview_mode":{"type":"string","description":"Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.","enum":["next","recurring"]},"schedule":{"maxLength":5000,"type":"string","description":"The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields."},"schedule_details":{"title":"schedule_details_params","type":"object","properties":{"amendments":{"type":"array","description":"Changes to apply to the phases of the subscription schedule, in the order provided.","items":{"title":"amendment_specs","required":["amendment_start"],"type":"object","properties":{"amendment_end":{"title":"specs","required":["type"],"type":"object","properties":{"discount_end":{"title":"discount_end_specs","required":["discount"],"type":"object","properties":{"discount":{"maxLength":5000,"type":"string","description":"The ID of a specific discount."}},"description":"Use the `end` time of a given discount.","x-stripeMostCommon":["discount"]},"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the amendment starting from the `amendment_start`.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.","format":"unix-time"},"type":{"type":"string","description":"Select one of three ways to pass the `amendment_end`.","enum":["discount_end","duration","schedule_end","timestamp","trial_end","trial_start","upcoming_invoice"]}},"description":"Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.","x-stripeMostCommon":["discount_end","duration","timestamp","type"]},"amendment_start":{"title":"specs","required":["type"],"type":"object","properties":{"amendment_end":{"title":"amendment_end_index_specs","required":["index"],"type":"object","properties":{"index":{"type":"integer","description":"The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array."}},"description":"Details of another amendment in the same array, immediately after which this amendment should begin.","x-stripeMostCommon":["index"]},"discount_end":{"title":"discount_end_specs","required":["discount"],"type":"object","properties":{"discount":{"maxLength":5000,"type":"string","description":"The ID of a specific discount."}},"description":"Use the `end` time of a given discount.","x-stripeMostCommon":["discount"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the amendment to start.","format":"unix-time"},"type":{"type":"string","description":"Select one of three ways to pass the `amendment_start`.","enum":["amendment_end","discount_end","now","schedule_end","timestamp","trial_end","trial_start","upcoming_invoice"]}},"description":"Details to identify the earliest timestamp where the proposed change should take effect.","x-stripeMostCommon":["amendment_end","discount_end","timestamp","type"]},"billing_cycle_anchor":{"type":"string","description":"For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.","enum":["amendment_start","automatic"]},"discount_actions":{"type":"array","description":"Changes to the coupons being redeemed or discounts being applied during the amendment time span.","items":{"title":"specs","required":["type"],"type":"object","properties":{"add":{"title":"add_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to redeem."},"discount":{"maxLength":5000,"type":"string","description":"An ID of an existing discount for a coupon that was already redeemed."},"discount_end":{"title":"amendment_discount_end","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["amendment_end"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["type"]},"index":{"type":"integer","description":"The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array."},"promotion_code":{"maxLength":5000,"type":"string","description":"The promotion code to redeem."}},"description":"Details of the discount to add.","x-stripeMostCommon":["coupon","discount","discount_end","index","promotion_code","settings"]},"remove":{"title":"remove_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to remove from the `discounts` array."},"discount":{"maxLength":5000,"type":"string","description":"The ID of a discount to remove from the `discounts` array."},"promotion_code":{"maxLength":5000,"type":"string","description":"The ID of a promotion code to remove from the `discounts` array."}},"description":"Details of the discount to remove.","x-stripeMostCommon":["coupon","discount","promotion_code"]},"set":{"title":"set_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to replace the `discounts` array with."},"discount":{"maxLength":5000,"type":"string","description":"An ID of an existing discount to replace the `discounts` array with."},"promotion_code":{"maxLength":5000,"type":"string","description":"An ID of an existing promotion code to replace the `discounts` array with."}},"description":"Details of the discount to replace the existing discounts with.","x-stripeMostCommon":["coupon","discount","promotion_code","settings"]},"type":{"type":"string","description":"Determines the type of discount action.","enum":["add","remove","set"]}},"x-stripeMostCommon":["add","remove","set","type"]}},"item_actions":{"type":"array","description":"Changes to the subscription items during the amendment time span.","items":{"title":"specs","required":["type"],"type":"object","properties":{"add":{"title":"add_item_specs","required":["price"],"type":"object","properties":{"discounts":{"type":"array","description":"The discounts applied to the item. Subscription item discounts are applied before subscription discounts.","items":{"title":"schedule_amendments_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"quantity":{"type":"integer","description":"Quantity for this item."},"tax_rates":{"type":"array","description":"The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.","items":{"maxLength":5000,"type":"string"}},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"description":"Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.","x-stripeMostCommon":["discounts","metadata","price","quantity","tax_rates","trial","trial_offer"]},"remove":{"title":"remove_item_specs","required":["price"],"type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"ID of a price to remove."}},"description":"Details of the subscription item to remove.","x-stripeMostCommon":["price"]},"set":{"title":"set_item_specs","required":["price"],"type":"object","properties":{"discounts":{"type":"array","description":"If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.","items":{"title":"schedule_amendments_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"quantity":{"type":"integer","description":"If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`."},"tax_rates":{"type":"array","description":"If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.","items":{"maxLength":5000,"type":"string"}},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"description":"Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.","x-stripeMostCommon":["discounts","metadata","price","quantity","tax_rates","trial","trial_offer"]},"type":{"type":"string","description":"Determines the type of item action.","enum":["add","remove","set"]}},"x-stripeMostCommon":["add","remove","set","type"]}},"metadata_actions":{"type":"array","description":"Instructions for how to modify phase metadata","items":{"title":"specs","required":["type"],"type":"object","properties":{"add":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata."},"remove":{"type":"array","description":"Keys to remove from schedule phase metadata.","items":{"maxLength":5000,"type":"string"}},"set":{"description":"Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"type":{"type":"string","description":"Select one of three ways to update phase-level `metadata` on subscription schedules.","enum":["add","remove","set"]}},"x-stripeMostCommon":["add","remove","set","type"]}},"proration_behavior":{"type":"string","description":"Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.","enum":["always_invoice","create_prorations","none"]},"set_pause_collection":{"title":"specs","required":["type"],"type":"object","properties":{"set":{"title":"pause_collection_params","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}}},"description":"Details of the pause_collection behavior to apply to the amendment.","x-stripeMostCommon":["behavior"]},"type":{"type":"string","description":"Determines the type of the pause_collection amendment.","enum":["remove","set"]}},"description":"Defines how to pause collection for the underlying subscription throughout the duration of the amendment.","x-stripeMostCommon":["set","type"]},"set_schedule_end":{"type":"string","description":"Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.","enum":["amendment_end","amendment_start"]},"trial_settings":{"title":"trial_settings_specs","type":"object","properties":{"end_behavior":{"title":"end_behavior_specs","type":"object","properties":{"prorate_up_front":{"type":"string","description":"Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.","enum":["defer","include"]}},"description":"Defines how the subscription should behave when a trial ends.","x-stripeMostCommon":["prorate_up_front"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"x-stripeMostCommon":["amendment_end","amendment_start","billing_cycle_anchor","billing_schedules_actions","discount_actions","effective_at","item_actions","metadata_actions","proration_behavior","set_pause_collection","set_schedule_end","trial_settings"]}},"billing_behavior":{"type":"string","description":"Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.","enum":["prorate_on_next_phase","prorate_up_front"]},"billing_mode":{"title":"billing_mode","required":["type"],"type":"object","properties":{"flexible":{"title":"flexible_params","type":"object","properties":{"proration_discounts":{"type":"string","description":"Controls how invoices and invoice items display proration amounts and discount amounts.","enum":["included","itemized"],"x-stripeEnum":{"kind":"open","values":[{"description":"Amounts are net of discounts, and discount amounts are zero.","value":"included"},{"description":"Amounts are gross of discounts, and discount amounts are accurate.","value":"itemized"}]}}},"description":"Configure behavior for flexible billing mode.","x-stripeMostCommon":["proration_discounts"]},"type":{"type":"string","description":"Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.","enum":["classic","flexible"]}},"description":"Controls how prorations and invoices for subscriptions are calculated and orchestrated.","x-stripeMostCommon":["flexible","type"]},"end_behavior":{"type":"string","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","release"]},"phases":{"type":"array","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":{"title":"phase_configuration_params","required":["items"],"type":"object","properties":{"add_invoice_items":{"type":"array","description":"A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.","items":{"title":"add_invoice_item_entry","type":"object","properties":{"discountable":{"type":"boolean","description":"Controls whether discounts apply to this invoice item. Defaults to true if no value is provided."},"discounts":{"type":"array","description":"The coupons to redeem into discounts for the item.","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"title":"invoice_item_period","required":["end","start"],"type":"object","properties":{"end":{"title":"invoice_item_period_end","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the end of the invoice item period.","enum":["min_item_period_end","phase_end","timestamp"],"x-stripeBypassValidation":true}},"description":"End of the invoice item period.","x-stripeMostCommon":["timestamp","type"]},"start":{"title":"invoice_item_period_start","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the start of the invoice item period.","enum":["max_item_period_start","phase_start","timestamp"],"x-stripeBypassValidation":true}},"description":"Start of the invoice item period.","x-stripeMostCommon":["timestamp","type"]}},"description":"The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.","x-stripeMostCommon":["end","start"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. One of `price` or `price_data` is required."},"price_data":{"title":"one_time_price_data_with_negative_amounts","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for this item. Defaults to 1."},"tax_rates":{"description":"The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["price","quantity"],"x-stripeParam":{"class_name":"AddInvoiceItem"}}},"application_fee_percent":{"type":"number","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":{"title":"automatic_tax_config","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Automatic tax settings for this phase.","x-stripeMostCommon":["enabled","liability"]},"billing_cycle_anchor":{"type":"string","description":"Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["automatic","phase_start"]},"billing_thresholds":{"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.","anyOf":[{"title":"billing_thresholds_param","type":"object","properties":{"amount_gte":{"type":"integer","description":"Monetary threshold that triggers the subscription to advance to a new billing period"},"reset_billing_cycle_anchor":{"type":"boolean","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."}},"x-stripeMostCommon":["amount_gte","reset_billing_cycle_anchor"]},{"type":"string","enum":[""]}]},"collection_method":{"type":"string","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`. Defaults to `charge_automatically` on creation.","enum":["charge_automatically","send_invoice"]},"currency":{"type":"string","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).","format":"currency"},"default_payment_method":{"maxLength":5000,"type":"string","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."},"default_tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.","anyOf":[{"type":"array","items":{"title":"schedule_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"duration":{"title":"duration_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies phase duration. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The multiplier applied to the interval."}},"description":"The number of intervals the phase should last. If set, `end_date` must not be set.","x-stripeMostCommon":["interval","interval_count"]},"end_date":{"description":"The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]},"invoice_settings":{"title":"invoice_settings","type":"object","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.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"days_until_due":{"type":"integer","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`."},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","days_until_due","description","footer","issuer","send_hosted_payment_email","supported_payment_methods"]},"items":{"type":"array","description":"List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.","items":{"title":"configuration_item_params","type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"schedule_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`."},"plan":{"maxLength":5000,"type":"string","description":"The plan ID to subscribe to. You may specify the same ID in `plan` and `price`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"x-stripeMostCommon":["billing_thresholds","discounts","metadata","plan","price","quantity","tax_rates","trial","trial_offer"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/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, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`."},"on_behalf_of":{"type":"string","description":"The account on behalf of which to charge, for each of the associated subscription's invoices."},"pause_collection":{"title":"pause_collection_params","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}}},"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](https://docs.stripe.com/billing/subscriptions/pause-payment).","x-stripeMostCommon":["behavior"]},"proration_behavior":{"type":"string","description":"Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.","enum":["always_invoice","create_prorations","none"]},"start_date":{"description":"The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. Prefer to specify `now` over an explicit timestamp when appropriate to avoid unexpected behavior due to request delays or clock skew resulting in the phase being slightly backdated or postdated.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]},"transfer_data":{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"description":"The data with which to automatically create a Transfer for each of the associated subscription's invoices.","x-stripeMostCommon":["amount_percent","destination"]},"trial":{"type":"boolean","description":"If set to true the entire phase is counted as a trial and the customer will not be charged for any fees."},"trial_continuation":{"type":"string","description":"Specify trial behavior when crossing phase boundaries","enum":["continue","none"]},"trial_end":{"description":"Sets the phase to trialing from the start date to this date. Must be within the phase. When previewing an update, if combined with `trial=true`, it must match the phase end date.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]},"trial_settings":{"title":"trial_settings_specs","type":"object","properties":{"end_behavior":{"title":"end_behavior_specs","type":"object","properties":{"prorate_up_front":{"type":"string","description":"Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.","enum":["defer","include"]}},"description":"Defines how the subscription should behave when a trial ends.","x-stripeMostCommon":["prorate_up_front"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"x-stripeMostCommon":["add_invoice_items","application_fee_percent","automatic_tax","billing_cycle_anchor","billing_thresholds","collection_method","currency","default_payment_method","default_tax_rates","description","discounts","duration","effective_at","end_date","invoice_settings","items","metadata","on_behalf_of","pause_collection","proration_behavior","start_date","tax_filing_currency","transfer_data","trial","trial_continuation","trial_end","trial_settings"]}},"prebilling":{"description":"Provide any time periods to bill in advance.","anyOf":[{"type":"array","items":{"title":"prebilling_params","type":"object","properties":{"bill_until":{"title":"specs","required":["type"],"type":"object","properties":{"amendment_end":{"title":"amendment_end_specs","required":["index"],"type":"object","properties":{"index":{"type":"integer","description":"The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments."}},"description":"End the prebilled period when a specified amendment ends.","x-stripeMostCommon":["index"]},"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for prebilling, starting from `bill_from`.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"End the prebilled period at a precise integer timestamp, starting from the Unix epoch.","format":"unix-time"},"type":{"type":"string","description":"Select one of several ways to pass the `bill_until` value.","enum":["amendment_end","duration","schedule_end","timestamp"]}},"description":"The end of the prebilled time period.","x-stripeMostCommon":["amendment_end","duration","timestamp","type"]},"iterations":{"type":"integer","description":"This is used to determine the number of billing cycles to prebill."}},"x-stripeMostCommon":["bill_until","iterations"]}},{"type":"string","enum":[""]}]},"proration_behavior":{"type":"string","description":"In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.","enum":["always_invoice","create_prorations","none"]}},"description":"The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.","x-stripeMostCommon":["amendments","billing_behavior","billing_mode","billing_schedules","default_settings","end_behavior","phases","prebilling","proration_behavior"]},"subscription":{"maxLength":5000,"type":"string","description":"The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions."},"subscription_details":{"title":"subscription_details_params","type":"object","properties":{"billing_cycle_anchor":{"title":"billing_cycle_anchor_param","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A timestamp to use as the subscription's billing cycle anchor. Only valid when `type` is `timestamp`.","format":"unix-time"},"type":{"type":"string","description":"Determines how the subscription's billing cycle anchor behaves for the invoice preview.","enum":["now","timestamp","unchanged"],"x-stripeEnum":{"kind":"open","values":[{"description":"Set the subscription's billing cycle anchor to the current time (in UTC) and start a new billing period.","value":"now"},{"description":"Set the subscription's billing cycle anchor to the time specified in `timestamp`.","value":"timestamp"},{"description":"Keep the subscription's existing billing cycle anchor unchanged.","value":"unchanged"}]}}},"description":"For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://docs.stripe.com/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`.","x-stripeMostCommon":["timestamp","type"]},"billing_mode":{"title":"billing_mode","required":["type"],"type":"object","properties":{"flexible":{"title":"flexible_params","type":"object","properties":{"proration_discounts":{"type":"string","description":"Controls how invoices and invoice items display proration amounts and discount amounts.","enum":["included","itemized"],"x-stripeEnum":{"kind":"open","values":[{"description":"Amounts are net of discounts, and discount amounts are zero.","value":"included"},{"description":"Amounts are gross of discounts, and discount amounts are accurate.","value":"itemized"}]}}},"description":"Configure behavior for flexible billing mode.","x-stripeMostCommon":["proration_discounts"]},"type":{"type":"string","description":"Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.","enum":["classic","flexible"]}},"description":"Controls how prorations and invoices for subscriptions are calculated and orchestrated.","x-stripeMostCommon":["flexible","type"]},"billing_schedules":{"description":"Sets the billing schedules for the subscription.","anyOf":[{"type":"array","items":{"title":"billing_schedules_update_params","type":"object","properties":{"applies_to":{"type":"array","description":"Configure billing schedule differently for individual subscription items.","items":{"title":"billing_schedules_applies_to","required":["type"],"type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"type":{"type":"string","description":"Controls which subscription items the billing schedule applies to.","enum":["price"]}},"x-stripeMostCommon":["price","type"]}},"bill_until":{"title":"billing_schedules_bill_until","required":["type"],"type":"object","properties":{"duration":{"title":"billing_schedules_bill_until_duration","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing duration. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The multiplier applied to the interval."}},"description":"Specifies the billing period.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"The end date of the billing schedule.","format":"unix-time"},"type":{"type":"string","description":"Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.","enum":["duration","timestamp"]}},"description":"The end date for the billing schedule. You must not set this earlier than current period end for every applicable subscription item.","x-stripeMostCommon":["duration","timestamp","type"]},"key":{"maxLength":200,"type":"string","description":"Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated."}},"x-stripeMostCommon":["applies_to","bill_until","key"]}},{"type":"string","enum":[""]}]},"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.","anyOf":[{"type":"integer","format":"unix-time"},{"type":"string","enum":[""]},{"type":"string","enum":["max_billed_until","max_period_end","min_period_end"]}]},"cancel_at_period_end":{"type":"boolean","description":"Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`."},"cancel_now":{"type":"boolean","description":"This simulates the subscription being canceled or expired immediately."},"default_tax_rates":{"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.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"items":{"type":"array","description":"A list of up to 20 subscription items, each with an attached price.","items":{"title":"subscription_item_update_params","type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"clear_usage":{"type":"boolean","description":"Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached."},"current_trial":{"title":"current_trial_param","required":["trial_offer"],"type":"object","properties":{"trial_end":{"type":"integer","description":"Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.","format":"unix-time"},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the subscription item."}},"description":"The trial offer to apply to this subscription item.","x-stripeMostCommon":["trial_end","trial_offer"]},"deleted":{"type":"boolean","description":"A flag that, if set to `true`, will delete the specified item."},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"id":{"maxLength":5000,"type":"string","description":"Subscription item to update. If you omit `id`, the API adds a new subscription item rather than updating the existing one. See [Changing a subscription's price](https://docs.stripe.com/billing/subscriptions/change-price#changing)."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"plan":{"maxLength":5000,"type":"string","description":"Plan ID for this item, as a string."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for this item."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["billing_thresholds","clear_usage","current_trial","deleted","discounts","id","metadata","plan","price","quantity","tax_rates"]}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"pause":{"title":"subscription_details_pause_params","type":"object","properties":{"bill_for":{"title":"bill_for_param","type":"object","properties":{"outstanding_usage_through":{"title":"outstanding_usage_through_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"When to bill metered usage in the current period.","enum":["none","now"],"x-stripeEnum":{"kind":"open","values":[{"description":"Don't bill for metered usage in the current period.","value":"none"},{"description":"Bill for metered usage in the current period, from current period start to pause time (default).","value":"now"}]}}},"description":"Controls when to bill for metered usage in the current period. Defaults to `{ type: \"now\" }`.","x-stripeMostCommon":["type"]},"unused_time_from":{"title":"unused_time_from_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"When to credit for unused time.","enum":["item_current_period_start","none","now"],"x-stripeEnum":{"kind":"open","values":[{"description":"Credit unused time from each item's current period start to period end.","value":"item_current_period_start"},{"description":"Don't credit for unused time.","value":"none"},{"description":"Credit unused time from pause time to period end (default).","value":"now"}]}}},"description":"Controls when to credit for unused time on licensed items. Defaults to `{ type: \"now\" }`.","x-stripeMostCommon":["type"]}},"description":"Controls what to bill for when pausing the subscription.","x-stripeMostCommon":["outstanding_usage_through","unused_time_from"]},"invoicing_behavior":{"type":"string","description":"Determines how to handle debits and credits when pausing. Defaults to `pending_invoice_item`.","enum":["invoice","pending_invoice_item"],"x-stripeEnum":{"kind":"open","values":[{"description":"Invoices immediately for debits and credits in the current period. If pausing doesn't create any invoice items, Stripe doesn't generate an invoice.","value":"invoice"},{"description":"Creates pending invoice items for debits and credits in the current period.","value":"pending_invoice_item"}]}},"type":{"type":"string","description":"The type of pause to apply. Defaults to `subscription`.","enum":["subscription"],"x-stripeEnum":{"kind":"open","values":[{"description":"Pauses collection, billing, and servicing.","value":"subscription"}]}}},"description":"Previews the invoice that would be generated when pausing the subscription. Passing an empty hash won't preview pausing and instead returns the next invoice.\n\nTo receive a preview invoice, set `invoicing_behavior` to `invoice`. A preview isn't available if the `bill_for` options produce no billable amounts.\n\n`pending_invoice_item` never has a preview available because pausing wouldn't generate an invoice, and paused subscriptions don't generate invoices either.","x-stripeMostCommon":["bill_for","invoicing_behavior","type"]},"prebilling":{"title":"prebilling_preview_params","required":["iterations"],"type":"object","properties":{"iterations":{"type":"integer","description":"This is used to determine the number of billing cycles to prebill."}},"description":"The pre-billing to apply to the subscription as a preview.","x-stripeMostCommon":["iterations"]},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/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"]},"proration_date":{"type":"integer","description":"If previewing an update to a subscription, and doing proration, `subscription_details.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_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.","format":"unix-time"},"resume_at":{"maxLength":5000,"type":"string","description":"For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.","enum":["now"]},"start_date":{"type":"integer","description":"Date a subscription is intended to start (can be future or past).","format":"unix-time"},"trial_end":{"description":"If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.","anyOf":[{"maxLength":5000,"type":"string","enum":["now"]},{"type":"integer","format":"unix-time"}]}},"description":"The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.","x-stripeMostCommon":["billing_cycle_anchor","billing_mode","billing_schedules","cancel_at","cancel_at_period_end","cancel_now","default_tax_rates","items","metadata","pause","prebilling","proration_behavior","proration_date","resume_at","start_date","trial_end"]}},"additionalProperties":false,"x-stripeMostCommon":["automatic_tax","customer","customer_account","subscription"]},"encoding":{"automatic_tax":{"style":"deepObject","explode":true},"customer_details":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"invoice_items":{"style":"deepObject","explode":true},"issuer":{"style":"deepObject","explode":true},"on_behalf_of":{"style":"deepObject","explode":true},"schedule_details":{"style":"deepObject","explode":true},"subscription_details":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_preview_invoice"}},"/v1/invoices/search":{"get":{"summary":"Search invoices","description":"Search for invoices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetInvoicesSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for invoices](https://docs.stripe.com/search#query-fields-for-invoices).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/invoice"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_invoices"}},"/v1/invoices/{invoice}":{"get":{"summary":"Retrieve an invoice","description":"Retrieves the invoice with the given ID.
","operationId":"GetInvoicesInvoice","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_invoice"},"post":{"summary":"Update an invoice","description":"Draft invoices are fully editable. Once an invoice is finalized,\nyou can no longer change most of its details, including monetary values and collection_method. For most invoices,\nthis also includes description.
If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or automatically reconciling invoices, pass\nauto_advance=false.
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":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_draft_invoice"}},"/v1/invoices/{invoice}/add_lines":{"post":{"summary":"Bulk add invoice line items","description":"Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
","operationId":"PostInvoicesInvoiceAddLines","parameters":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["lines"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"lines":{"type":"array","description":"The line items to add.","items":{"title":"lines_data_param","type":"object","properties":{"amount":{"type":"integer","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."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking."},"discountable":{"type":"boolean","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."},"discounts":{"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.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"invoice_item":{"maxLength":5000,"type":"string","description":"ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created."},"margins":{"description":"The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"period":{"title":"period","required":["end","start"],"type":"object","properties":{"end":{"type":"integer","description":"The end of the period, which must be greater than or equal to the start. This value is inclusive.","format":"unix-time"},"start":{"type":"integer","description":"The start of the period. This value is inclusive.","format":"unix-time"}},"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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.","x-stripeMostCommon":["end","start"]},"price_data":{"title":"one_time_price_data_with_product_data","required":["currency"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required."},"product_data":{"title":"product_data","required":["name"],"type":"object","properties":{"description":{"maxLength":40000,"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."},"images":{"type":"array","description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"description":"Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.","x-stripeMostCommon":["description","images","metadata","name","tax_code","tax_details","unit_label"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","unit_amount"]},"pricing":{"title":"pricing_param","type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."}},"description":"The pricing information for the invoice item.","x-stripeMostCommon":["price"]},"quantity":{"type":"integer","description":"Non-negative integer. The quantity of units for the line item. Use `quantity_decimal` instead to provide decimal precision. This field will be deprecated in favor of `quantity_decimal` in a future version."},"quantity_decimal":{"type":"string","description":"Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.","format":"decimal"},"tax_amounts":{"description":"A list of up to 20 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://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts.","anyOf":[{"type":"array","items":{"title":"tax_amount_param","required":["amount","tax_rate_data","taxable_amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount, in cents (or local equivalent), of the tax."},"tax_rate_data":{"title":"tax_rate_data_param","required":["display_name","inclusive","percentage"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."},"display_name":{"maxLength":200,"type":"string","description":"The display name of the tax rate, which will be shown to users."},"inclusive":{"type":"boolean","description":"This specifies if the tax rate is inclusive or exclusive."},"jurisdiction":{"maxLength":200,"type":"string","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."},"jurisdiction_level":{"type":"string","description":"The level of the jurisdiction that imposes this tax rate.","enum":["city","country","county","district","multiple","state"]},"percentage":{"type":"number","description":"The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero."},"state":{"maxLength":5000,"type":"string","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."},"tax_type":{"type":"string","description":"The high-level tax type, such as `vat` or `sales_tax`.","enum":["amusement_tax","communications_tax","digital_excise_tax","gst","hst","igst","jct","lease_tax","mass_transit_parking_tax","parking_tax","pst","qst","retail_delivery_fee","rst","sales_tax","service_tax","utility_users_tax","vat"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Amusement Tax","value":"amusement_tax"},{"description":"Communications Tax","value":"communications_tax"},{"description":"Digital Excise Tax","value":"digital_excise_tax"},{"description":"Goods and Services Tax","value":"gst"},{"description":"Harmonized Sales Tax","value":"hst"},{"description":"Integrated Goods and Services Tax","value":"igst"},{"description":"Japanese Consumption Tax","value":"jct"},{"description":"Chicago Lease Tax","value":"lease_tax"},{"description":"Mass Transit Parking Tax","value":"mass_transit_parking_tax"},{"description":"Parking Tax","value":"parking_tax"},{"description":"Provincial Sales Tax","value":"pst"},{"description":"Quebec Sales Tax","value":"qst"},{"description":"Retail Delivery Fee","value":"retail_delivery_fee"},{"description":"Retail Sales Tax","value":"rst"},{"description":"Sales Tax","value":"sales_tax"},{"description":"Service Tax","value":"service_tax"},{"description":"Utility Users Tax","value":"utility_users_tax"},{"description":"Value-Added Tax","value":"vat"}]}}},"description":"Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.","x-stripeMostCommon":["country","description","display_name","inclusive","jurisdiction","jurisdiction_level","percentage","state","tax_type"]},"taxability_reason":{"type":"string","description":"The reasoning behind this tax, for example, if the product is tax exempt.","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"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"No tax is applied as the customer is exempt from tax.","value":"customer_exempt"},{"description":"No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (`txcd_00000000`) was used.","value":"not_collecting"},{"description":"No tax is imposed on this transaction.","value":"not_subject_to_tax"},{"description":"No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.","value":"not_supported"},{"description":"A portion of the price is exempt from tax.","value":"portion_product_exempt"},{"description":"A portion of the price is taxed at a reduced rate.","value":"portion_reduced_rated"},{"description":"A portion of the price is taxed at the standard rate.","value":"portion_standard_rated"},{"description":"The product or service is nontaxable or exempt from tax.","value":"product_exempt"},{"description":"The product or service is not taxed due to a sales tax holiday.","value":"product_exempt_holiday"},{"description":"The shipping cost tax rate is calculated as a weighted average of the other line items' rates, weighted by their amounts.","value":"proportionally_rated"},{"description":"Taxed at a reduced rate.","value":"reduced_rated"},{"description":"No tax is applied as it is the responsibility of the buyer to account for tax in this case.","value":"reverse_charge"},{"description":"Taxed at the standard rate.","value":"standard_rated"},{"description":"A reduced amount of the price is subject to tax.","value":"taxable_basis_reduced"},{"description":"The transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the \"input VAT\" paid on your business purchases).","value":"zero_rated"}]}},"taxable_amount":{"type":"integer","description":"The amount on which tax is calculated, in cents (or local equivalent)."}},"x-stripeMostCommon":["amount","tax_rate_data","taxability_reason","taxable_amount"]}},{"type":"string","enum":[""]}]},"tax_rates":{"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.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["amount","description","invoice_item","metadata","period","pricing","quantity_decimal"]}}},"additionalProperties":false,"x-stripeMostCommon":["invoice_metadata","lines"]},"encoding":{"expand":{"style":"deepObject","explode":true},"invoice_metadata":{"style":"deepObject","explode":true},"lines":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"add_invoice_lines"}},"/v1/invoices/{invoice}/attach_payment":{"post":{"summary":"Attach a payment to an Invoice","description":"Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited\nto the invoice, increasing its amount_paid. When the invoice is fully paid, the\ninvoice’s status becomes paid.
If the PaymentIntent’s status is already succeeded when it’s attached, it’s\ncredited to the invoice immediately.
See: Partial payments to learn more.
","operationId":"PostInvoicesInvoiceAttachPayment","parameters":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount_requested":{"type":"integer","description":"The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_intent":{"maxLength":5000,"type":"string","description":"The ID of the PaymentIntent to attach to the invoice."},"payment_record":{"maxLength":5000,"type":"string","description":"The ID of the PaymentRecord to attach to the invoice."},"payment_record_data":{"title":"out_of_band_payment","required":["amount","currency","money_movement_type"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that was paid out of band."},"currency":{"type":"string","description":"The currency that was paid out of band.","format":"currency"},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"money_movement_type":{"maxLength":5000,"type":"string","description":"The type of money movement for this out of band payment record."},"paid_at":{"type":"integer","description":"The timestamp when this out of band payment was paid.","format":"unix-time"},"payment_reference":{"maxLength":5000,"type":"string","description":"The reference for this out of band payment record."}},"description":"The PaymentRecord data for attaching an out of band payment to the invoice.","x-stripeMostCommon":["amount","currency","money_movement_type","payment_method","payment_reference"]}},"additionalProperties":false,"x-stripeMostCommon":["amount_requested","payment_intent","payment_record","payment_record_data"]},"encoding":{"expand":{"style":"deepObject","explode":true},"payment_record_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"attach_invoice_payment"}},"/v1/invoices/{invoice}/detach_payment":{"post":{"summary":"Detach a payment from an Invoice","description":"Detaches a payment from the invoice, removing it from the list of payments
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":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"auto_advance":{"type":"boolean","description":"Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["auto_advance"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"finalize_invoice"}},"/v1/invoices/{invoice}/lines":{"get":{"summary":"Retrieve an invoice's line items","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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"InvoiceLinesList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_invoice_line_items"}},"/v1/invoices/{invoice}/lines/{line_item_id}":{"post":{"summary":"Update an invoice's line item","description":"Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,\nso they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice\nitem and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\nUpdating an invoice’s line item is only possible before the invoice is finalized.
Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
","operationId":"PostInvoicesInvoiceMarkUncollectible","parameters":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"mark_invoice_uncollectible"}},"/v1/invoices/{invoice}/pay":{"post":{"summary":"Pay an invoice","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":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"forgive":{"type":"boolean","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. \n\nPassing `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`."},"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 payment_method param or the invoice's default_payment_method or default_source, if set.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"off_session":{"type":"boolean","description":"Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session)."},"paid_out_of_band":{"type":"boolean","description":"Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`."},"payment_method":{"maxLength":5000,"type":"string","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."},"source":{"maxLength":5000,"type":"string","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."}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true},"mandate":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"pay_invoice"}},"/v1/invoices/{invoice}/remove_lines":{"post":{"summary":"Bulk remove invoice line items","description":"Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
","operationId":"PostInvoicesInvoiceRemoveLines","parameters":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["lines"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"lines":{"type":"array","description":"The line items to remove.","items":{"title":"lines_data_param","required":["behavior","id"],"type":"object","properties":{"behavior":{"type":"string","description":"Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.","enum":["delete","unassign"]},"id":{"maxLength":5000,"type":"string","description":"ID of an existing line item to remove from this invoice."}},"x-stripeMostCommon":["behavior","id"]}}},"additionalProperties":false,"x-stripeMostCommon":["invoice_metadata","lines"]},"encoding":{"expand":{"style":"deepObject","explode":true},"invoice_metadata":{"style":"deepObject","explode":true},"lines":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"remove_invoice_lines"}},"/v1/invoices/{invoice}/send":{"post":{"summary":"Send an invoice for manual payment","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.
\n\nRequests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
","operationId":"PostInvoicesInvoiceUpdateLines","parameters":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["lines"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"lines":{"type":"array","description":"The line items to update.","items":{"title":"lines_data_param","required":["id"],"type":"object","properties":{"amount":{"type":"integer","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."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking."},"discountable":{"type":"boolean","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."},"discounts":{"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.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"id":{"maxLength":5000,"type":"string","description":"ID of an existing line item on the invoice."},"margins":{"description":"The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"period":{"title":"period","required":["end","start"],"type":"object","properties":{"end":{"type":"integer","description":"The end of the period, which must be greater than or equal to the start. This value is inclusive.","format":"unix-time"},"start":{"type":"integer","description":"The start of the period. This value is inclusive.","format":"unix-time"}},"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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.","x-stripeMostCommon":["end","start"]},"price_data":{"title":"one_time_price_data_with_product_data","required":["currency"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required."},"product_data":{"title":"product_data","required":["name"],"type":"object","properties":{"description":{"maxLength":40000,"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."},"images":{"type":"array","description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"description":"Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.","x-stripeMostCommon":["description","images","metadata","name","tax_code","tax_details","unit_label"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","unit_amount"]},"pricing":{"title":"pricing_param","type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."}},"description":"The pricing information for the invoice item.","x-stripeMostCommon":["price"]},"quantity":{"type":"integer","description":"Non-negative integer. The quantity of units for the line item. Use `quantity_decimal` instead to provide decimal precision. This field will be deprecated in favor of `quantity_decimal` in a future version."},"quantity_decimal":{"type":"string","description":"Non-negative decimal with at most 12 decimal places. The quantity of units for the line item.","format":"decimal"},"tax_amounts":{"description":"A list of up to 20 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://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts.","anyOf":[{"type":"array","items":{"title":"tax_amount_param","required":["amount","tax_rate_data","taxable_amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount, in cents (or local equivalent), of the tax."},"tax_rate_data":{"title":"tax_rate_data_param","required":["display_name","inclusive","percentage"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."},"display_name":{"maxLength":200,"type":"string","description":"The display name of the tax rate, which will be shown to users."},"inclusive":{"type":"boolean","description":"This specifies if the tax rate is inclusive or exclusive."},"jurisdiction":{"maxLength":200,"type":"string","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."},"jurisdiction_level":{"type":"string","description":"The level of the jurisdiction that imposes this tax rate.","enum":["city","country","county","district","multiple","state"]},"percentage":{"type":"number","description":"The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero."},"state":{"maxLength":5000,"type":"string","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."},"tax_type":{"type":"string","description":"The high-level tax type, such as `vat` or `sales_tax`.","enum":["amusement_tax","communications_tax","digital_excise_tax","gst","hst","igst","jct","lease_tax","mass_transit_parking_tax","parking_tax","pst","qst","retail_delivery_fee","rst","sales_tax","service_tax","utility_users_tax","vat"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Amusement Tax","value":"amusement_tax"},{"description":"Communications Tax","value":"communications_tax"},{"description":"Digital Excise Tax","value":"digital_excise_tax"},{"description":"Goods and Services Tax","value":"gst"},{"description":"Harmonized Sales Tax","value":"hst"},{"description":"Integrated Goods and Services Tax","value":"igst"},{"description":"Japanese Consumption Tax","value":"jct"},{"description":"Chicago Lease Tax","value":"lease_tax"},{"description":"Mass Transit Parking Tax","value":"mass_transit_parking_tax"},{"description":"Parking Tax","value":"parking_tax"},{"description":"Provincial Sales Tax","value":"pst"},{"description":"Quebec Sales Tax","value":"qst"},{"description":"Retail Delivery Fee","value":"retail_delivery_fee"},{"description":"Retail Sales Tax","value":"rst"},{"description":"Sales Tax","value":"sales_tax"},{"description":"Service Tax","value":"service_tax"},{"description":"Utility Users Tax","value":"utility_users_tax"},{"description":"Value-Added Tax","value":"vat"}]}}},"description":"Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.","x-stripeMostCommon":["country","description","display_name","inclusive","jurisdiction","jurisdiction_level","percentage","state","tax_type"]},"taxability_reason":{"type":"string","description":"The reasoning behind this tax, for example, if the product is tax exempt.","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"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"No tax is applied as the customer is exempt from tax.","value":"customer_exempt"},{"description":"No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (`txcd_00000000`) was used.","value":"not_collecting"},{"description":"No tax is imposed on this transaction.","value":"not_subject_to_tax"},{"description":"No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.","value":"not_supported"},{"description":"A portion of the price is exempt from tax.","value":"portion_product_exempt"},{"description":"A portion of the price is taxed at a reduced rate.","value":"portion_reduced_rated"},{"description":"A portion of the price is taxed at the standard rate.","value":"portion_standard_rated"},{"description":"The product or service is nontaxable or exempt from tax.","value":"product_exempt"},{"description":"The product or service is not taxed due to a sales tax holiday.","value":"product_exempt_holiday"},{"description":"The shipping cost tax rate is calculated as a weighted average of the other line items' rates, weighted by their amounts.","value":"proportionally_rated"},{"description":"Taxed at a reduced rate.","value":"reduced_rated"},{"description":"No tax is applied as it is the responsibility of the buyer to account for tax in this case.","value":"reverse_charge"},{"description":"Taxed at the standard rate.","value":"standard_rated"},{"description":"A reduced amount of the price is subject to tax.","value":"taxable_basis_reduced"},{"description":"The transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the \"input VAT\" paid on your business purchases).","value":"zero_rated"}]}},"taxable_amount":{"type":"integer","description":"The amount on which tax is calculated, in cents (or local equivalent)."}},"x-stripeMostCommon":["amount","tax_rate_data","taxability_reason","taxable_amount"]}},{"type":"string","enum":[""]}]},"tax_rates":{"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.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["amount","description","id","metadata","period","pricing","quantity_decimal"]}}},"additionalProperties":false,"x-stripeMostCommon":["invoice_metadata","lines"]},"encoding":{"expand":{"style":"deepObject","explode":true},"invoice_metadata":{"style":"deepObject","explode":true},"lines":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_invoice_lines"}},"/v1/invoices/{invoice}/void":{"post":{"summary":"Void an invoice","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.
\n\nConsult 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":[{"name":"invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"void_invoice"}},"/v1/issuing/authorizations":{"get":{"summary":"List all authorizations","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.
Retrieves an Issuing Authorization object.
Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. \nThis method is deprecated. Instead, respond directly to the webhook request to approve an authorization.
[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\nThis method is deprecated. Instead, respond directly to the webhook request to decline an authorization.
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.
Creates a new Issuing Cardholder object that can be issued cards.
Retrieves an Issuing Cardholder object.
Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
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.
Creates an Issuing Card object.
Retrieves an Issuing Card object.
Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
Creates a CreditUnderwritingRecord object with information about a credit application submission.
Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
Retrieves a CreditUnderwritingRecord object.
Update a CreditUnderwritingRecord object to correct mistakes.
Update a CreditUnderwritingRecord object from a decision made on a credit application.
Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing DisputeSettlementDetail object.
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.
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.
Retrieves an Issuing Dispute object.
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.
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.
Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Retrieves an Issuing FraudLiabilityDebit object.
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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"lookup_keys","in":"query","description":"Only return personalization designs with the given lookup keys.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":200,"type":"string"}}},{"name":"preferences","in":"query","description":"Only return personalization designs with the given preferences.","required":false,"style":"deepObject","explode":true,"schema":{"title":"preferences_list_param","type":"object","properties":{"is_default":{"type":"boolean","description":"Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default."},"is_platform_default":{"type":"boolean","description":"Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts."}},"x-stripeMostCommon":["is_default","is_platform_default"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return personalization designs with the given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["active","inactive","rejected","review"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"IssuingPersonalizationDesignList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/issuing.personalization_design"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/issuing/personalization_designs","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_issuing_personalization_designs"},"post":{"summary":"Create a personalization design","description":"Creates a personalization design object.
","operationId":"PostIssuingPersonalizationDesigns","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["physical_bundle"],"type":"object","properties":{"card_logo":{"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":{"title":"carrier_text_param","type":"object","properties":{"footer_body":{"description":"The footer body text of the carrier letter.","anyOf":[{"maxLength":200,"type":"string"},{"type":"string","enum":[""]}]},"footer_title":{"description":"The footer title text of the carrier letter.","anyOf":[{"maxLength":30,"type":"string"},{"type":"string","enum":[""]}]},"header_body":{"description":"The header body text of the carrier letter.","anyOf":[{"maxLength":200,"type":"string"},{"type":"string","enum":[""]}]},"header_title":{"description":"The header title text of the carrier letter.","anyOf":[{"maxLength":30,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Hash containing carrier text, for use with physical bundles that support carrier text.","x-stripeMostCommon":["footer_body","footer_title","header_body","header_title"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"lookup_key":{"maxLength":200,"type":"string","description":"A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":200,"type":"string","description":"Friendly display name."},"physical_bundle":{"maxLength":5000,"type":"string","description":"The physical bundle object belonging to this personalization design."},"preferences":{"title":"preferences_param","required":["is_default"],"type":"object","properties":{"is_default":{"type":"boolean","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."}},"description":"Information on whether this personalization design is used to create cards when one is not specified.","x-stripeMostCommon":["is_default"]},"transfer_lookup_key":{"type":"boolean","description":"If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design."}},"additionalProperties":false,"x-stripeMostCommon":["card_logo","carrier_text","lookup_key","metadata","name","physical_bundle","preferences","transfer_lookup_key"]},"encoding":{"carrier_text":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"preferences":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.personalization_design"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_issuing_personalization_design"}},"/v1/issuing/personalization_designs/{personalization_design}":{"get":{"summary":"Retrieve a personalization design","description":"Retrieves a personalization design object.
","operationId":"GetIssuingPersonalizationDesignsPersonalizationDesign","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"personalization_design","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.personalization_design"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_issuing_personalization_design"},"post":{"summary":"Update a personalization design","description":"Updates a card personalization object.
","operationId":"PostIssuingPersonalizationDesignsPersonalizationDesign","parameters":[{"name":"personalization_design","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","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`.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"carrier_text":{"description":"Hash containing carrier text, for use with physical bundles that support carrier text.","anyOf":[{"title":"carrier_text_param","type":"object","properties":{"footer_body":{"description":"The footer body text of the carrier letter.","anyOf":[{"maxLength":200,"type":"string"},{"type":"string","enum":[""]}]},"footer_title":{"description":"The footer title text of the carrier letter.","anyOf":[{"maxLength":30,"type":"string"},{"type":"string","enum":[""]}]},"header_body":{"description":"The header body text of the carrier letter.","anyOf":[{"maxLength":200,"type":"string"},{"type":"string","enum":[""]}]},"header_title":{"description":"The header title text of the carrier letter.","anyOf":[{"maxLength":30,"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["footer_body","footer_title","header_body","header_title"]},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"lookup_key":{"description":"A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.","anyOf":[{"maxLength":200,"type":"string"},{"type":"string","enum":[""]}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":"Friendly display name. Providing an empty string will set the field to null.","anyOf":[{"maxLength":200,"type":"string"},{"type":"string","enum":[""]}]},"physical_bundle":{"maxLength":5000,"type":"string","description":"The physical bundle object belonging to this personalization design."},"preferences":{"title":"preferences_param","required":["is_default"],"type":"object","properties":{"is_default":{"type":"boolean","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."}},"description":"Information on whether this personalization design is used to create cards when one is not specified.","x-stripeMostCommon":["is_default"]},"transfer_lookup_key":{"type":"boolean","description":"If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design."}},"additionalProperties":false,"x-stripeMostCommon":["card_logo","carrier_text","lookup_key","metadata","name","physical_bundle","preferences","transfer_lookup_key"]},"encoding":{"card_logo":{"style":"deepObject","explode":true},"carrier_text":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"lookup_key":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"name":{"style":"deepObject","explode":true},"preferences":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.personalization_design"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_issuing_personalization_design"}},"/v1/issuing/physical_bundles":{"get":{"summary":"List all physical bundles","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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return physical bundles with the given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["active","inactive","review"]}},{"name":"type","in":"query","description":"Only return physical bundles with the given type.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["custom","standard"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"IssuingPhysicalBundleList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/issuing.physical_bundle"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/issuing/physical_bundles","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_issuing_physical_bundles"}},"/v1/issuing/physical_bundles/{physical_bundle}":{"get":{"summary":"Retrieve a physical bundle","description":"Retrieves a physical bundle object.
","operationId":"GetIssuingPhysicalBundlesPhysicalBundle","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"physical_bundle","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.physical_bundle"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_issuing_physical_bundle"}},"/v1/issuing/tokens":{"get":{"summary":"List all issuing tokens for card","description":"Lists all Issuing Token objects for a given card.
Retrieves an Issuing Token object.
Attempts to update the specified Issuing Token object to the status specified.
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.
Retrieves an Issuing Transaction object.
Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Retrieves a list of Mandates for a given PaymentMethod.
","operationId":"GetMandates","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"on_behalf_of","in":"query","description":"The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://docs.stripe.com/payments/connected-accounts).","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"payment_method","in":"query","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.","required":true,"style":"form","explode":true,"schema":{"type":"string","enum":["active","inactive","pending"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentFlowsMandateList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/mandate"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/mandates","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_mandates"}},"/v1/mandates/{mandate}":{"get":{"summary":"Retrieve a Mandate","description":"Retrieves a Mandate object.
","operationId":"GetMandatesMandate","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"mandate","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mandate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_mandate"}},"/v1/orders":{"get":{"summary":"List all orders","description":"Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
","operationId":"GetOrders","parameters":[{"name":"customer","in":"query","description":"Only return orders for the given customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"OrdersV2ResourceOrderList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/order"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/orders","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"post":{"summary":"Create an order","description":"Creates a new open order object.
Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
","operationId":"GetOrdersId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/order"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"post":{"summary":"Update an order","description":"Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
","operationId":"PostOrdersId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"automatic_tax":{"title":"automatic_tax","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable automatic tax calculation which will automatically compute tax rates on this order."}},"description":"Settings for automatic tax calculation for this order.","x-stripeMostCommon":["enabled"]},"billing_details":{"description":"Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided.","anyOf":[{"title":"billing_details","type":"object","properties":{"address":{"title":"validated_optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as \"NY\" or \"TX\"."}},"description":"The billing address provided by the customer.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"The billing email provided by the customer."},"name":{"maxLength":5000,"type":"string","description":"The billing name provided by the customer."},"phone":{"maxLength":20,"type":"string","description":"The billing phone number provided by the customer."}},"x-stripeMostCommon":["address","email","name","phone"]},{"type":"string","enum":[""]}]},"currency":{"type":"string","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).","format":"currency"},"customer":{"maxLength":5000,"type":"string","description":"The customer associated with this order."},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `\"\"` to unset this field.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","coupon_data"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"ip_address":{"type":"string","description":"The IP address of the purchaser for this order."},"line_items":{"type":"array","description":"A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.","items":{"title":"update_params","type":"object","properties":{"description":{"maxLength":5000,"type":"string","description":"The description for the line item. Will default to the name of the associated product."},"discounts":{"description":"The discounts applied to this line item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."}},"x-stripeMostCommon":["coupon","coupon_data"]}},{"type":"string","enum":[""]}]},"id":{"maxLength":5000,"type":"string","description":"The ID of an existing line item on the order."},"price":{"maxLength":5000,"type":"string","description":"The ID of a [Price](https://docs.stripe.com/api/prices) to add to the Order.\n\nThe `price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use."},"price_data":{"title":"price_data_with_optional_product","type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"ID of the [Product](https://docs.stripe.com/api/products) this [Price](https://docs.stripe.com/api/prices) belongs to.\n\nUse this to implement a variable-pricing model in your integration. This is required if `product_data` is not specified."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new Price object inline.\n\nThe `price_data` parameter is an alternative to using the `product` or `price` parameters. If you create a Product upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define Products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.\n\nEach time you pass `price_data` we create a Price for the Product. This Price is hidden in both the Dashboard and API lists and cannot be reused.","x-stripeMostCommon":["currency","product","unit_amount"]},"product":{"maxLength":5000,"type":"string","description":"The ID of a [Product](https://docs.stripe.com/api/products) to add to the Order.\n\nThe Product must have a `default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter."},"product_data":{"title":"product_upsert_data","required":["id","name"],"type":"object","properties":{"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.","anyOf":[{"maxLength":40000,"type":"string"},{"type":"string","enum":[""]}]},"id":{"maxLength":5000,"type":"string","description":"A unique identifier for this product.\n\n`product_data` automatically creates a Product with this ID. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates. If any of the fields in the existing Product are different from the values in `product_data`, `product_data` updates the existing Product with the new information. So set `product_data[id]` to the same string every time you sell the same product, but don't re-use the same string for different products."},"images":{"description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"package_dimensions":{"description":"The dimensions of this product for shipping purposes.","anyOf":[{"title":"package_dimensions_specs","required":["height","length","weight","width"],"type":"object","properties":{"height":{"type":"number","description":"Height, in inches. Maximum precision is 2 decimal places."},"length":{"type":"number","description":"Length, in inches. Maximum precision is 2 decimal places."},"weight":{"type":"number","description":"Weight, in ounces. Maximum precision is 2 decimal places."},"width":{"type":"number","description":"Width, in inches. Maximum precision is 2 decimal places."}},"x-stripeMostCommon":["height","length","weight","width"]},{"type":"string","enum":[""]}]},"shippable":{"type":"boolean","description":"Whether this product is shipped (i.e., physical goods)."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"url":{"description":"A URL of a publicly-accessible webpage for this product.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Defines a [Product](https://docs.stripe.com/api/products) inline and adds it to the Order.\n\n`product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.\n\n`product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.","x-stripeMostCommon":["id","metadata","name","sku","tax_code"]},"quantity":{"type":"integer","description":"The quantity of the line item."},"tax_rates":{"description":"The tax rates applied to this line item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["id","product","quantity"]}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment":{"title":"update_params","required":["settings"],"type":"object","properties":{"settings":{"title":"update_params","type":"object","properties":{"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.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"payment_method_options":{"title":"update_params","type":"object","properties":{"acss_debit":{"description":"If paying by `acss_debit`, this sub-hash contains details about the ACSS Debit payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_intent_payment_method_options_mandate_options_param","type":"object","properties":{"custom_mandate_url":{"description":"A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"interval_description":{"maxLength":500,"type":"string","description":"Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'."},"payment_schedule":{"type":"string","description":"Payment schedule for the mandate.","enum":["combined","interval","sporadic"]},"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["custom_mandate_url","interval_description","payment_schedule","transaction_type"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session","on_session"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."},"verification_method":{"type":"string","description":"Bank account verification method. The default value is `automatic`.","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["financial_connections","mandate_options","setup_future_usage","target_date","verification_method"]},{"type":"string","enum":[""]}]},"afterpay_clearpay":{"description":"If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"afterpay_clearpay_payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.","enum":["automatic","automatic_async","manual"]},"reference":{"maxLength":128,"type":"string","description":"An internal identifier or reference this payment corresponds to. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the order's Customer, if present, after the order's 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://docs.stripe.com/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen 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://docs.stripe.com/strong-customer-authentication).\n\nIf `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":["none"]}},"x-stripeMostCommon":["capture_method","reference","setup_future_usage"]},{"type":"string","enum":[""]}]},"alipay":{"description":"If paying by `alipay`, this sub-hash contains details about the Alipay payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]}},"x-stripeMostCommon":["setup_future_usage"]},{"type":"string","enum":[""]}]},"bancontact":{"description":"If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"preferred_language":{"type":"string","description":"Preferred language of the Bancontact authorization page that the customer is redirected to.","enum":["de","en","fr","nl"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]}},"x-stripeMostCommon":["preferred_language","setup_future_usage"]},{"type":"string","enum":[""]}]},"card":{"description":"If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"card_payment_method_options","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["automatic","automatic_async","manual"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the order's Customer, if present, after the order's 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://docs.stripe.com/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen 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://docs.stripe.com/strong-customer-authentication).\n\nIf `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":["none","off_session","on_session"]}},"x-stripeMostCommon":["capture_method","setup_future_usage"]},{"type":"string","enum":[""]}]},"customer_balance":{"description":"If paying by `customer_balance`, this sub-hash contains details about the Customer Balance payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_intent_payment_method_options_param","type":"object","properties":{"bank_transfer":{"title":"bank_transfer_param","required":["type"],"type":"object","properties":{"eu_bank_transfer":{"title":"eu_bank_transfer_params","required":["country"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."}},"description":"Configuration for the eu_bank_transfer funding type.","x-stripeMostCommon":["country"]},"requested_address_types":{"type":"array","description":"List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.","items":{"type":"string","enum":["aba","iban","sepa","sort_code","spei","swift","zengin"],"x-stripeBypassValidation":true}},"type":{"type":"string","description":"The list of bank transfer types 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"],"x-stripeBypassValidation":true}},"description":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.","x-stripeMostCommon":["eu_bank_transfer","id_bank_account","id_bank_transfer","requested_address_types","type"]},"funding_type":{"type":"string","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"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["none"]}},"x-stripeMostCommon":["bank_transfer","funding_type","setup_future_usage"]},{"type":"string","enum":[""]}]},"ideal":{"description":"If paying by `ideal`, this sub-hash contains details about the iDEAL payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]}},"x-stripeMostCommon":["setup_future_usage"]},{"type":"string","enum":[""]}]},"klarna":{"description":"If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.","enum":["","manual"]},"on_demand":{"title":"on_demand_param","type":"object","properties":{"average_amount":{"type":"integer","description":"Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc."},"maximum_amount":{"type":"integer","description":"The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc."},"minimum_amount":{"type":"integer","description":"The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc."},"purchase_interval":{"type":"string","description":"Interval at which the customer is making purchases","enum":["day","month","week","year"]},"purchase_interval_count":{"type":"integer","description":"The number of `purchase_interval` between charges"}},"description":"On-demand details if setting up or charging an on-demand payment.","x-stripeMostCommon":["average_amount","maximum_amount","minimum_amount","purchase_interval","purchase_interval_count"]},"preferred_locale":{"type":"string","description":"Preferred language of the Klarna authorization page that the customer is redirected to","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-RO","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","ro-RO","sv-FI","sv-SE"],"x-stripeBypassValidation":true},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["none","off_session","on_session"]},"subscriptions":{"description":"Subscription details if setting up or charging a subscription.","anyOf":[{"type":"array","items":{"title":"subscription_param","required":["interval","reference"],"type":"object","properties":{"interval":{"type":"string","description":"Unit of time between subscription charges.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months."},"name":{"maxLength":255,"type":"string","description":"Name for subscription."},"next_billing":{"title":"subscription_next_billing_param","required":["amount","date"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount of the next charge for the subscription."},"date":{"maxLength":5000,"type":"string","description":"The date of the next charge for the subscription in YYYY-MM-DD format."}},"description":"Describes the upcoming charge for this subscription.","x-stripeMostCommon":["amount","date"]},"reference":{"maxLength":255,"type":"string","description":"A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges."}},"x-stripeMostCommon":["interval","interval_count","name","next_billing","reference"]}},{"type":"string","enum":[""]}]},"supplementary_purchase_data":{"description":"Supplementary Purchase Data for the corresponding Klarna payment","anyOf":[{"title":"supplementary_purchase_data_param","type":"object","properties":{"bus_reservation_details":{"description":"Supplementary bus reservation details.","anyOf":[{"type":"array","items":{"title":"bus_reservation_details_param","type":"object","properties":{"affiliate_name":{"maxLength":255,"type":"string","description":"Name of associated or partner company for the service."},"arrival":{"title":"arrival_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the arrival location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"arrival_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the arrival location."}},"description":"Arrival details.","x-stripeMostCommon":["address","arrival_location"]},"carrier_name":{"maxLength":255,"type":"string","description":"Name of transportation company."},"currency":{"type":"string","description":"Currency.","format":"currency"},"departure":{"title":"departure_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the departure location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"departs_at":{"type":"integer","description":"Timestamp of departure.","format":"unix-time"},"departure_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the origin location."}},"description":"Departure details.","x-stripeMostCommon":["address","departs_at","departure_location"]},"insurances":{"type":"array","description":"List of insurances for this reservation.","items":{"title":"insurance_param","type":"object","properties":{"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the company providing the insurance."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance coverage for baggage loss or damage.","value":"baggage"},{"description":"Insurance that protects against bankruptcy of service providers.","value":"bankruptcy"},{"description":"Insurance that covers cancelation costs.","value":"cancelation"},{"description":"Emergency insurance coverage for unexpected situations.","value":"emergency"},{"description":"Medical insurance coverage for incidents.","value":"medical"}]}},"price":{"type":"integer","description":"Price of insurance in cents."}},"x-stripeMostCommon":["currency","insurance_company_name","insurance_type","price"]}},"passengers":{"type":"array","description":"List of passengers that this reservation applies to.","items":{"title":"passenger_param","type":"object","properties":{"family_name":{"maxLength":99,"type":"string","description":"The family name of the person."},"given_name":{"maxLength":99,"type":"string","description":"The given name of the person."}},"x-stripeMostCommon":["family_name","given_name"]}},"price":{"type":"integer","description":"Price in cents."},"ticket_class":{"type":"string","description":"Ticket class.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating with premium amenities and services.","value":"business"},{"description":"Standard economy class seating with basic amenities.","value":"economy"},{"description":"Premium first class with luxury amenities and exclusive services.","value":"first_class"},{"description":"Enhanced economy class with additional comfort and services.","value":"premium_economy"}]}}},"x-stripeMostCommon":["affiliate_name","arrival","carrier_name","currency","departure","insurances","passengers","price","ticket_class"]}},{"type":"string","enum":[""]}]},"event_reservation_details":{"description":"Supplementary event reservation details.","anyOf":[{"type":"array","items":{"title":"event_reservation_details_param","type":"object","properties":{"access_controlled_venue":{"type":"boolean","description":"Indicates if the tickets are digitally checked when entering the venue."},"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the event.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"affiliate_name":{"maxLength":255,"type":"string","description":"Name of associated or partner company for the service."},"ends_at":{"type":"integer","description":"End timestamp of the event.","format":"unix-time"},"event_company_name":{"maxLength":255,"type":"string","description":"Company selling the ticket."},"event_name":{"maxLength":255,"type":"string","description":"Name of the event."},"event_type":{"type":"string","description":"Type of the event.","enum":["concert","conference","digital_education","expo","festival","in_person_education","sport","tour"],"x-stripeEnum":{"kind":"open","values":[{"description":"Musical performance or concert event.","value":"concert"},{"description":"Professional conference or meeting event.","value":"conference"},{"description":"Online or digital educational event.","value":"digital_education"},{"description":"Exhibition or trade show event.","value":"expo"},{"description":"Festival or celebration event.","value":"festival"},{"description":"In-person educational event or workshop.","value":"in_person_education"},{"description":"Sporting event or competition.","value":"sport"},{"description":"Guided tour or sightseeing event.","value":"tour"}]}},"insurances":{"type":"array","description":"List of insurances for this event.","items":{"title":"insurance_param","type":"object","properties":{"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the company providing the insurance."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance that protects against bankruptcy of service providers.","value":"bankruptcy"},{"description":"Insurance that covers cancelation costs.","value":"cancelation"},{"description":"Emergency insurance coverage for unexpected situations.","value":"emergency"},{"description":"Medical insurance coverage for incidents.","value":"medical"}]}},"price":{"type":"integer","description":"Price of insurance in cents."}},"x-stripeMostCommon":["currency","insurance_company_name","insurance_type","price"]}},"starts_at":{"type":"integer","description":"Start timestamp of the event.","format":"unix-time"},"venue_name":{"maxLength":255,"type":"string","description":"Name of the venue where the event takes place."}},"x-stripeMostCommon":["access_controlled_venue","address","affiliate_name","ends_at","event_company_name","event_name","event_type","insurances","starts_at","venue_name"]}},{"type":"string","enum":[""]}]},"ferry_reservation_details":{"description":"Supplementary ferry reservation details.","anyOf":[{"type":"array","items":{"title":"ferry_reservation_details_param","type":"object","properties":{"affiliate_name":{"maxLength":255,"type":"string","description":"Name of associated or partner company for the service."},"arrival":{"title":"arrival_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the arrival location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"arrival_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the arrival location."}},"description":"Arrival details.","x-stripeMostCommon":["address","arrival_location"]},"carrier_name":{"maxLength":255,"type":"string","description":"Name of transportation company."},"currency":{"type":"string","description":"Currency.","format":"currency"},"departure":{"title":"departure_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the departure location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"departs_at":{"type":"integer","description":"Timestamp of departure.","format":"unix-time"},"departure_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the origin location."}},"description":"Departure details.","x-stripeMostCommon":["address","departs_at","departure_location"]},"insurances":{"type":"array","description":"List of insurances for this reservation.","items":{"title":"insurance_param","type":"object","properties":{"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the company providing the insurance."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance coverage for baggage loss or damage.","value":"baggage"},{"description":"Insurance that protects against bankruptcy of service providers.","value":"bankruptcy"},{"description":"Insurance that covers cancelation costs.","value":"cancelation"},{"description":"Emergency insurance coverage for unexpected situations.","value":"emergency"},{"description":"Medical insurance coverage for incidents.","value":"medical"}]}},"price":{"type":"integer","description":"Price of insurance in cents."}},"x-stripeMostCommon":["currency","insurance_company_name","insurance_type","price"]}},"passengers":{"type":"array","description":"List of passengers that this reservation applies to.","items":{"title":"passenger_param","type":"object","properties":{"family_name":{"maxLength":99,"type":"string","description":"The family name of the person."},"given_name":{"maxLength":99,"type":"string","description":"The given name of the person."}},"x-stripeMostCommon":["family_name","given_name"]}},"price":{"type":"integer","description":"Price in cents."},"ticket_class":{"type":"string","description":"Ticket class.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating with premium amenities and services.","value":"business"},{"description":"Standard economy class seating with basic amenities.","value":"economy"},{"description":"Premium first class with luxury amenities and exclusive services.","value":"first_class"},{"description":"Enhanced economy class with additional comfort and services.","value":"premium_economy"}]}}},"x-stripeMostCommon":["affiliate_name","arrival","carrier_name","currency","departure","insurances","passengers","price","ticket_class"]}},{"type":"string","enum":[""]}]},"insurances":{"description":"Supplementary insurance details.","anyOf":[{"type":"array","items":{"title":"insurance_param","type":"object","properties":{"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the company providing the insurance."},"insurance_type":{"type":"string","description":"Type of insurance","enum":["bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance that protects against bankruptcy of service providers.","value":"bankruptcy"},{"description":"Insurance that covers cancelation costs.","value":"cancelation"},{"description":"Emergency insurance coverage for unexpected situations.","value":"emergency"},{"description":"Medical insurance coverage for incidents.","value":"medical"}]}},"price":{"type":"integer","description":"Price of insurance in cents."}},"x-stripeMostCommon":["currency","insurance_company_name","insurance_type","price"]}},{"type":"string","enum":[""]}]},"marketplace_sellers":{"description":"Supplementary marketplace seller details.","anyOf":[{"type":"array","items":{"title":"marketplace_seller_param","type":"object","properties":{"line_item_references":{"type":"array","description":"The references to line items for purchases with multiple associated sub-sellers.","items":{"maxLength":255,"type":"string"}},"marketplace_seller_address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"The address of the selling or delivering merchant.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"marketplace_seller_name":{"maxLength":255,"type":"string","description":"The name of the marketplace seller."},"marketplace_seller_reference":{"maxLength":255,"type":"string","description":"The unique identifier for the marketplace seller."},"number_of_transactions":{"type":"integer","description":"The number of transactions the sub-seller completed in the last 12 months."},"product_category":{"type":"string","description":"The category of the product.","enum":["accessories","appliances","apps_and_games","arts_crafts_and_sewing","automotive","baby","baby_clothing","bags_and_purses","beauty","books","cds_and_vinyl","cell_phones_and_accessories","collectibles_and_fine_arts","digital_music","electronics","grocery_and_gourmet_food","handmade","health_and_personal_care","home_and_kitchen","industrial_and_scientific","luggage_and_travel_gear","magazine_subscriptions","men_clothing","musical_instruments","office_products","patio_lawn_and_garden","pet_supplies","shoes","software","sports_and_outdoors","tools_and_home_improvement","toys_and_games","video_games","women_clothing"],"x-stripeEnum":{"kind":"open","values":[{"description":"Fashion and general accessories.","value":"accessories"},{"description":"Home and kitchen appliances.","value":"appliances"},{"description":"Mobile and software applications and games.","value":"apps_and_games"},{"description":"Art supplies, craft materials, and sewing products.","value":"arts_crafts_and_sewing"},{"description":"Automotive parts, accessories, and tools.","value":"automotive"},{"description":"Baby care products and equipment.","value":"baby"},{"description":"Clothing for babies and infants.","value":"baby_clothing"},{"description":"Handbags, purses, and bags.","value":"bags_and_purses"},{"description":"Cosmetics, skincare, and beauty products.","value":"beauty"},{"description":"Physical books and publications.","value":"books"},{"description":"Music in physical media formats.","value":"cds_and_vinyl"},{"description":"Mobile phones and related accessories.","value":"cell_phones_and_accessories"},{"description":"Collectible items and fine art pieces.","value":"collectibles_and_fine_arts"},{"description":"Digital music downloads and streaming.","value":"digital_music"},{"description":"Consumer electronics and devices.","value":"electronics"},{"description":"Food, beverages, and gourmet products.","value":"grocery_and_gourmet_food"},{"description":"Handcrafted and artisanal products.","value":"handmade"},{"description":"Health products and personal care items.","value":"health_and_personal_care"},{"description":"Home furnishings and kitchen supplies.","value":"home_and_kitchen"},{"description":"Industrial equipment and scientific supplies.","value":"industrial_and_scientific"},{"description":"Luggage, suitcases, and travel accessories.","value":"luggage_and_travel_gear"},{"description":"Magazine and periodical subscriptions.","value":"magazine_subscriptions"},{"description":"Clothing and apparel for men.","value":"men_clothing"},{"description":"Musical instruments and equipment.","value":"musical_instruments"},{"description":"Office supplies and business products.","value":"office_products"},{"description":"Outdoor, lawn, and garden products.","value":"patio_lawn_and_garden"},{"description":"Pet care products and supplies.","value":"pet_supplies"},{"description":"Footwear for all categories.","value":"shoes"},{"description":"Computer software and applications.","value":"software"},{"description":"Sports equipment and outdoor gear.","value":"sports_and_outdoors"},{"description":"Tools and home improvement supplies.","value":"tools_and_home_improvement"},{"description":"Toys, games, and children's entertainment.","value":"toys_and_games"},{"description":"Video games and gaming consoles.","value":"video_games"},{"description":"Clothing and apparel for women.","value":"women_clothing"}]}},"seller_last_login_at":{"type":"integer","description":"The date when the seller's account with the marketplace was last logged in.","format":"unix-time"},"seller_rating":{"type":"string","description":"The current rating of the marketplace seller. If the marketplace uses numeric ranking, map these to the enum values.","enum":["high","low","medium","very_high","very_low"],"x-stripeEnum":{"kind":"open","values":[{"description":"High rating.","value":"high"},{"description":"Low rating.","value":"low"},{"description":"Medium rating.","value":"medium"},{"description":"Very high rating.","value":"very_high"},{"description":"Very low rating.","value":"very_low"}]}},"seller_registered_at":{"type":"integer","description":"The date when the seller's account with the marketplace was created.","format":"unix-time"},"seller_updated_at":{"type":"integer","description":"The date when the seller's account with the marketplace was last updated.","format":"unix-time"},"shipping_references":{"type":"array","description":"The references to shipping addresses for purchases with multiple associated sub-sellers.","items":{"maxLength":255,"type":"string"}},"volume_of_transactions":{"type":"integer","description":"The accumulated amount of sales transactions made by the sub-merchant or sub-seller within the past 12 months in the payment currency. These transactions are in minor currency units."}},"x-stripeMostCommon":["line_item_references","marketplace_seller_address","marketplace_seller_name","marketplace_seller_reference","number_of_transactions","product_category","seller_last_login_at","seller_rating","seller_registered_at","seller_updated_at","shipping_references","volume_of_transactions"]}},{"type":"string","enum":[""]}]},"round_trip_reservation_details":{"description":"Supplementary round trip reservation details.","anyOf":[{"type":"array","items":{"title":"round_trip_reservation_details_param","type":"object","properties":{"affiliate_name":{"maxLength":255,"type":"string","description":"Name of associated or partner company for the service."},"arrival":{"title":"arrival_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the arrival location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"arrival_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the arrival location."}},"description":"Arrival details.","x-stripeMostCommon":["address","arrival_location"]},"carrier_name":{"maxLength":255,"type":"string","description":"Name of transportation company."},"currency":{"type":"string","description":"Currency.","format":"currency"},"departure":{"title":"departure_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the departure location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"departs_at":{"type":"integer","description":"Timestamp of departure.","format":"unix-time"},"departure_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the origin location."}},"description":"Departure details.","x-stripeMostCommon":["address","departs_at","departure_location"]},"insurances":{"type":"array","description":"List of insurances for this reservation.","items":{"title":"insurance_param","type":"object","properties":{"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the company providing the insurance."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance coverage for baggage loss or damage.","value":"baggage"},{"description":"Insurance that protects against bankruptcy of service providers.","value":"bankruptcy"},{"description":"Insurance that covers cancelation costs.","value":"cancelation"},{"description":"Emergency insurance coverage for unexpected situations.","value":"emergency"},{"description":"Medical insurance coverage for incidents.","value":"medical"}]}},"price":{"type":"integer","description":"Price of insurance in cents."}},"x-stripeMostCommon":["currency","insurance_company_name","insurance_type","price"]}},"passengers":{"type":"array","description":"List of passengers that this reservation applies to.","items":{"title":"passenger_param","type":"object","properties":{"family_name":{"maxLength":99,"type":"string","description":"The family name of the person."},"given_name":{"maxLength":99,"type":"string","description":"The given name of the person."}},"x-stripeMostCommon":["family_name","given_name"]}},"price":{"type":"integer","description":"Price in cents."},"ticket_class":{"type":"string","description":"Ticket class.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating with premium amenities and services.","value":"business"},{"description":"Standard economy class seating with basic amenities.","value":"economy"},{"description":"Premium first class with luxury amenities and exclusive services.","value":"first_class"},{"description":"Enhanced economy class with additional comfort and services.","value":"premium_economy"}]}}},"x-stripeMostCommon":["affiliate_name","arrival","carrier_name","currency","departure","insurances","passengers","price","ticket_class"]}},{"type":"string","enum":[""]}]},"train_reservation_details":{"description":"Supplementary train reservation details.","anyOf":[{"type":"array","items":{"title":"train_reservation_details_param","type":"object","properties":{"affiliate_name":{"maxLength":255,"type":"string","description":"Name of associated or partner company for the service."},"arrival":{"title":"arrival_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the arrival location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"arrival_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the arrival location."}},"description":"Arrival details.","x-stripeMostCommon":["address","arrival_location"]},"carrier_name":{"maxLength":255,"type":"string","description":"Name of transportation company."},"currency":{"type":"string","description":"Currency.","format":"currency"},"departure":{"title":"departure_param","type":"object","properties":{"address":{"title":"address_param","type":"object","properties":{"city":{"maxLength":99,"type":"string","description":"The city or town."},"country":{"maxLength":5000,"type":"string","description":"The country in ISO 3166-1 alpha-2 format."},"postal_code":{"maxLength":10,"type":"string","description":"The postal code formatted according to country."},"region":{"maxLength":99,"type":"string","description":"The state, county, province, or region formatted according to country."},"street_address":{"maxLength":99,"type":"string","description":"Line 1 of the street address."},"street_address2":{"maxLength":99,"type":"string","description":"Line 2 of the street address."}},"description":"Address of the departure location.","x-stripeMostCommon":["city","country","postal_code","region","street_address","street_address2"]},"departs_at":{"type":"integer","description":"Timestamp of departure.","format":"unix-time"},"departure_location":{"maxLength":255,"type":"string","description":"Identifier name or reference for the origin location."}},"description":"Departure details.","x-stripeMostCommon":["address","departs_at","departure_location"]},"insurances":{"type":"array","description":"List of insurances for this reservation.","items":{"title":"insurance_param","type":"object","properties":{"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the company providing the insurance."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance coverage for baggage loss or damage.","value":"baggage"},{"description":"Insurance that protects against bankruptcy of service providers.","value":"bankruptcy"},{"description":"Insurance that covers cancelation costs.","value":"cancelation"},{"description":"Emergency insurance coverage for unexpected situations.","value":"emergency"},{"description":"Medical insurance coverage for incidents.","value":"medical"}]}},"price":{"type":"integer","description":"Price of insurance in cents."}},"x-stripeMostCommon":["currency","insurance_company_name","insurance_type","price"]}},"passengers":{"type":"array","description":"List of passengers that this reservation applies to.","items":{"title":"passenger_param","type":"object","properties":{"family_name":{"maxLength":99,"type":"string","description":"The family name of the person."},"given_name":{"maxLength":99,"type":"string","description":"The given name of the person."}},"x-stripeMostCommon":["family_name","given_name"]}},"price":{"type":"integer","description":"Price in cents."},"ticket_class":{"type":"string","description":"Ticket class.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating with premium amenities and services.","value":"business"},{"description":"Standard economy class seating with basic amenities.","value":"economy"},{"description":"Premium first class with luxury amenities and exclusive services.","value":"first_class"},{"description":"Enhanced economy class with additional comfort and services.","value":"premium_economy"}]}}},"x-stripeMostCommon":["affiliate_name","arrival","carrier_name","currency","departure","insurances","passengers","price","ticket_class"]}},{"type":"string","enum":[""]}]},"vouchers":{"description":"Voucher details, such as a gift card or discount code.","anyOf":[{"type":"array","items":{"title":"voucher_param","type":"object","properties":{"affiliate_name":{"maxLength":255,"type":"string","description":"Name of associated or partner company for this voucher."},"ends_at":{"type":"integer","description":"The voucher validity end time.","format":"unix-time"},"starts_at":{"type":"integer","description":"The voucher validity start time.","format":"unix-time"},"voucher_company":{"maxLength":255,"type":"string","description":"The issuer or provider of this voucher."},"voucher_name":{"maxLength":255,"type":"string","description":"The name or reference to identify the voucher."},"voucher_type":{"type":"string","description":"The type of this voucher.","enum":["digital_product","discount","gift_card","physical_product","services"],"x-stripeEnum":{"kind":"open","values":[{"description":"Voucher for digital goods or downloadable content.","value":"digital_product"},{"description":"Voucher that provides a discount on purchases.","value":"discount"},{"description":"Voucher that can be redeemed for merchandise or services.","value":"gift_card"},{"description":"Voucher for physical merchandise or goods.","value":"physical_product"},{"description":"Voucher for services or experiences.","value":"services"}]}}},"x-stripeMostCommon":["affiliate_name","ends_at","starts_at","voucher_company","voucher_name","voucher_type"]}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["bus_reservation_details","customer","event_reservation_details","ferry_reservation_details","insurances","marketplace_sellers","round_trip_reservation_details","train_reservation_details","vouchers"]},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["capture_method","extra_merchant_data_blob","interoperability_token","line_items","on_demand","partner_confirmation_token","payment_details","payment_method_category","payment_option_id","preferred_locale","request_incremental_authorization","request_multicapture","setup_future_usage","subscriptions","supplementary_purchase_data"]},{"type":"string","enum":[""]}]},"link":{"description":"If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_intent_payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds are captured from the customer's account.\n\nIf provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.","enum":["","manual"]},"persistent_token":{"maxLength":5000,"type":"string","description":"[Deprecated] This is a legacy parameter that no longer has any function."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]}},"x-stripeMostCommon":["capture_method","persistent_token","request_multicapture","setup_future_usage"]},{"type":"string","enum":[""]}]},"oxxo":{"description":"If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"expires_after_days":{"type":"integer","description":"The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["none"]}},"x-stripeMostCommon":["expires_after_days","setup_future_usage"]},{"type":"string","enum":[""]}]},"p24":{"description":"If paying by `p24`, this sub-hash contains details about the P24 payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["none"]},"tos_shown_and_accepted":{"type":"boolean","description":"Confirm that the payer has accepted the P24 terms and conditions."}},"x-stripeMostCommon":["installments","setup_future_usage","tos_shown_and_accepted"]},{"type":"string","enum":[""]}]},"paypal":{"description":"If paying by `paypal`, this sub-hash contains details about the PayPal payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["","manual"]},"line_items":{"type":"array","description":"The line items purchased by the customer.","items":{"title":"line_item_param","required":["name","quantity","unit_amount"],"type":"object","properties":{"category":{"type":"string","description":"Type of the line item.","enum":["digital_goods","donation","physical_goods"]},"description":{"maxLength":127,"type":"string","description":"Description of the line item."},"name":{"maxLength":127,"type":"string","description":"Descriptive name of the line item."},"quantity":{"type":"integer","description":"Quantity of the line item. Must be a positive number."},"sku":{"maxLength":127,"type":"string","description":"Client facing stock keeping unit, article number or similar."},"sold_by":{"maxLength":5000,"type":"string","description":"The Stripe account ID of the connected account that sells the item."},"tax":{"title":"line_item_tax_param","required":["amount","behavior"],"type":"object","properties":{"amount":{"type":"integer","description":"The tax for a single unit of the line item in minor units. Cannot be a negative number."},"behavior":{"type":"string","description":"The tax behavior for the line item.","enum":["exclusive","inclusive"]}},"description":"The tax information for the line item.","x-stripeMostCommon":["amount","behavior"]},"unit_amount":{"type":"integer","description":"Price for a single unit of the line item in minor units. Cannot be a negative number."}},"x-stripeMostCommon":["category","description","name","quantity","sku","sold_by","tax","unit_amount"]}},"preferred_locale":{"type":"string","description":"[Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.","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"],"x-stripeBypassValidation":true},"reference":{"maxLength":127,"type":"string","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."},"reference_id":{"maxLength":127,"type":"string","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."},"risk_correlation_id":{"maxLength":32,"type":"string","description":"The risk correlation ID for an on-session payment using a saved PayPal payment method."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]},"subsellers":{"type":"array","description":"The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.","items":{"maxLength":32,"type":"string"}}},"x-stripeMostCommon":["allow_delayed_notification","capture_method","line_items","preferred_locale","reference","reference_id","risk_correlation_id","setup_future_usage","subsellers"]},{"type":"string","enum":[""]}]},"sepa_debit":{"description":"If paying by `sepa_debit`, this sub-hash contains details about the SEPA Debit payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference","reference_prefix"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session","on_session"]},"target_date":{"maxLength":5000,"type":"string","description":"Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."}},"x-stripeMostCommon":["mandate_options","setup_future_usage","target_date","verification_method"]},{"type":"string","enum":[""]}]},"sofort":{"description":"If paying by `sofort`, this sub-hash contains details about the Sofort payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"preferred_language":{"type":"string","description":"Language shown to the payer on redirect.","enum":["","de","en","es","fr","it","nl","pl"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["","none","off_session"]}},"x-stripeMostCommon":["preferred_language","setup_future_usage"]},{"type":"string","enum":[""]}]},"wechat_pay":{"description":"If paying by `wechat_pay`, this sub-hash contains details about the WeChat Pay payment method options to pass to the order's PaymentIntent.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"app_id":{"maxLength":5000,"type":"string","description":"The app ID registered with WeChat Pay. Only required when client is ios, android, or mini_program."},"client":{"type":"string","description":"The client type that the end customer will pay from","enum":["android","ios","web"],"x-stripeBypassValidation":true},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).\n\nIf you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.","enum":["none"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Use `none` if you do not intend to reuse this payment method and want to override the top-level `setup_future_usage` value for this payment method.","value":"none"}]}}},"x-stripeMostCommon":["app_id","buyer_id","client","setup_future_usage"]},{"type":"string","enum":[""]}]}},"description":"PaymentMethod-specific configuration to provide to the order's PaymentIntent.","x-stripeMostCommon":["acss_debit","afterpay_clearpay","alipay","bancontact","card","customer_balance","ideal","klarna","link","oxxo","p24","paypal","sepa_debit","sofort","wechat_pay"]},"payment_method_types":{"type":"array","description":"The list of [payment method types](https://docs.stripe.com/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).","items":{"type":"string","enum":["acss_debit","afterpay_clearpay","alipay","au_becs_debit","bacs_debit","bancontact","card","customer_balance","eps","fpx","giropay","grabpay","ideal","klarna","link","oxxo","p24","paypal","sepa_debit","sofort","wechat_pay"]}},"return_url":{"description":"The URL to redirect the customer to after they authenticate their payment.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"statement_descriptor":{"maxLength":22,"type":"string","description":"For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters."},"statement_descriptor_suffix":{"maxLength":22,"type":"string","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."},"transfer_data":{"description":"Provides configuration for completing a transfer for the order after it is paid.","anyOf":[{"title":"transfer_data","required":["destination"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field."},"destination":{"type":"string","description":"ID of the Connected account receiving the transfer."}},"x-stripeMostCommon":["amount","amount_percent","destination"]},{"type":"string","enum":[""]}]}},"description":"Settings describing how the order should configure generated PaymentIntents.","x-stripeMostCommon":["application_fee_amount","payment_method_options","payment_method_types","return_url","skip_payment_intent_creation","statement_descriptor","statement_descriptor_suffix","transfer_data","transfer_group"]}},"description":"Payment information associated with the order, including payment settings.","x-stripeMostCommon":["settings"]},"shipping_cost":{"description":"Settings for the customer cost of shipping for this order.","anyOf":[{"title":"shipping_cost","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the shipping rate to use for this order."},"shipping_rate_data":{"title":"create_params","required":["display_name"],"type":"object","properties":{"delivery_estimate":{"title":"delivery_estimate","type":"object","properties":{"maximum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.","x-stripeMostCommon":["unit","value"]},"minimum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The lower bound of the estimated range. If empty, represents no lower bound.","x-stripeMostCommon":["unit","value"]}},"description":"The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.","x-stripeMostCommon":["maximum","minimum"]},"display_name":{"maxLength":100,"type":"string","description":"The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."},"fixed_amount":{"title":"fixed_amount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"x-stripeMostCommon":["amount","tax_behavior"]},"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)."}},"description":"Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.","x-stripeMostCommon":["amount","currency","currency_options"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`."},"type":{"type":"string","description":"The type of calculation to use on the shipping rate.","enum":["fixed_amount"]}},"description":"Parameters to create a new ad-hoc shipping rate for this order.","x-stripeMostCommon":["display_name","fixed_amount","metadata","tax_behavior","tax_code","type"]}},"x-stripeMostCommon":["shipping_rate","shipping_rate_data"]},{"type":"string","enum":[""]}]},"shipping_details":{"description":"Shipping details for the order.","anyOf":[{"title":"shipping_details","required":["address","name"],"type":"object","properties":{"address":{"title":"validated_optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as \"NY\" or \"TX\"."}},"description":"The shipping address for the order.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient of the order."},"phone":{"description":"The phone number (including extension) for the recipient of the order.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["address","name","phone"]},{"type":"string","enum":[""]}]},"tax_details":{"title":"tax_details","type":"object","properties":{"tax_exempt":{"type":"string","description":"The purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.","enum":["","exempt","none","reverse"]},"tax_ids":{"type":"array","description":"The purchaser's tax IDs to be used for this order.","items":{"title":"data_params","required":["type","value"],"type":"object","properties":{"type":{"maxLength":5000,"type":"string","description":"Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `fo_vat`, `gb_vat`, `ge_vat`, `gi_tin`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `ic_nif`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `it_cf`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `py_ruc`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`","enum":["ad_nrt","ae_trn","al_tin","am_tin","ao_tin","ar_cuit","au_abn","au_arn","aw_tin","az_tin","ba_tin","bb_tin","bd_bin","bf_ifu","bg_uic","bh_vat","bj_ifu","bo_tin","br_cnpj","br_cpf","bs_tin","by_tin","ca_bn","ca_gst_hst","ca_pst_bc","ca_pst_mb","ca_pst_sk","ca_qst","cd_nif","ch_uid","ch_vat","cl_tin","cm_niu","cn_tin","co_nit","cr_tin","cv_nif","de_stn","do_rcn","ec_ruc","eg_tin","es_cif","et_tin","eu_oss_vat","eu_vat","fo_vat","gb_vat","ge_vat","gi_tin","gn_nif","hk_br","hr_oib","hu_tin","ic_nif","id_npwp","il_vat","in_gst","is_vat","it_cf","jp_cn","jp_rn","jp_trn","ke_pin","kg_tin","kh_tin","kr_brn","kz_bin","la_tin","li_uid","li_vat","lk_vat","ma_vat","md_vat","me_pib","mk_vat","mr_nif","mx_rfc","my_frp","my_itn","my_sst","ng_tin","no_vat","no_voec","np_pan","nz_gst","om_vat","pe_ruc","ph_tin","pl_nip","py_ruc","ro_tin","rs_pib","ru_inn","ru_kpp","sa_vat","sg_gst","sg_uen","si_tin","sn_ninea","sr_fin","sv_nit","th_vat","tj_tin","tr_tin","tw_vat","tz_vat","ua_vat","ug_tin","us_ein","uy_ruc","uz_tin","uz_vat","ve_rif","vn_tin","za_vat","zm_tin","zw_tin"],"x-stripeBypassValidation":true},"value":{"type":"string","description":"Value of the tax ID."}},"x-stripeMostCommon":["type","value"]}}},"description":"Additional tax details about the purchaser to be used for this order.","x-stripeMostCommon":["tax_exempt","tax_ids"]}},"additionalProperties":false,"x-stripeMostCommon":["currency","customer","description","line_items","metadata","payment"]},"encoding":{"automatic_tax":{"style":"deepObject","explode":true},"billing_details":{"style":"deepObject","explode":true},"description":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"line_items":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment":{"style":"deepObject","explode":true},"shipping_cost":{"style":"deepObject","explode":true},"shipping_details":{"style":"deepObject","explode":true},"tax_details":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/order"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/orders/{id}/submit":{"post":{"summary":"Submit an order","description":"Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the reopen method is called.
List all the Payment Attempt Records attached to the specified Payment Record.
","operationId":"GetPaymentAttemptRecords","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"payment_record","in":"query","description":"The ID of the Payment Record.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"Payment Attempt Record List","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_attempt_record"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"A list of PaymentAttemptRecords.","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_attempt_record"}},"/v1/payment_attempt_records/{id}":{"get":{"summary":"Retrieve a Payment Attempt Record","description":"Retrieves a Payment Attempt Record with the given ID
","operationId":"GetPaymentAttemptRecordsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The ID of the Payment Attempt Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_attempt_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_attempt_record"}},"/v1/payment_intents":{"get":{"summary":"List all PaymentIntents","description":"Returns a list of PaymentIntents.
","operationId":"GetPaymentIntents","parameters":[{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return PaymentIntents for the customer that this customer ID specifies.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"Only return PaymentIntents for the account representing the customer that this ID specifies.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentFlowsPaymentIntentList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_intent"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/payment_intents","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_intents"},"post":{"summary":"Create a PaymentIntent","description":"Creates a PaymentIntent object.
\n\nAfter the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. Learn more about the available payment flows\nwith the Payment Intents API.
\n\nWhen you use confirm=true during creation, it’s equivalent to creating\nand confirming the PaymentIntent in the same call. You can use any parameters\navailable in the confirm API when you supply\nconfirm=true.
Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetPaymentIntentsSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment intents](https://docs.stripe.com/search#query-fields-for-paymentintents).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_intent"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_payment_intents"}},"/v1/payment_intents/{intent}":{"get":{"summary":"Retrieve a PaymentIntent","description":"Retrieves the details of a PaymentIntent that has previously been created.
\n\nYou 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":[{"name":"client_secret","in":"query","description":"The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_intent_via_client_key"},"post":{"summary":"Update a PaymentIntent","description":"Updates properties on a PaymentIntent object without confirming.
\n\nDepending on which properties you update, you might need to confirm the\nPaymentIntent again. For example, updating the payment_method\nalways requires you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties through\nthe confirm API instead.
Lists all LineItems of a given PaymentIntent.
","operationId":"GetPaymentIntentsIntentAmountDetailsLineItems","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentFlowsAmountDetailsResourceLineItemsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/payment_intent_amount_details_line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"amount_details_line_items"}},"/v1/payment_intents/{intent}/apply_customer_balance":{"post":{"summary":"Reconcile a customer_balance PaymentIntent","description":"Manually reconcile the remaining amount for a customer_balance PaymentIntent.
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 directly cancel the PaymentIntent for a Checkout Session only when the PaymentIntent has a status of requires_capture. Otherwise, you must expire the Checkout Session.
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.
\n\nLearn more about separate authorization and capture.
","operationId":"PostPaymentIntentsIntentCapture","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount_details":{"title":"amount_details_param","type":"object","properties":{"discount_amount":{"description":"The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"enforce_arithmetic_validation":{"type":"boolean","description":"Set to `false` to return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.\n\nOmit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.\n\nFor card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error."},"line_items":{"description":"A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.","anyOf":[{"type":"array","items":{"title":"amount_details_line_item_param","required":["product_name","quantity","unit_cost"],"type":"object","properties":{"discount_amount":{"type":"integer","description":"The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[discount_amount]` field."},"payment_method_options":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"card":{"title":"payment_intent_amount_details_line_item_payment_method_options_param","type":"object","properties":{"commodity_code":{"maxLength":12,"type":"string","description":"Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on."}},"description":"This sub-hash contains line item details that are specific to the `card` payment method.","x-stripeMostCommon":["commodity_code","ev_charging","fleet_data"]},"card_present":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"commodity_code":{"maxLength":12,"type":"string","description":"Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on."}},"description":"This sub-hash contains line item details that are specific to the `card_present` payment method.","x-stripeMostCommon":["commodity_code"]},"klarna":{"title":"payment_intent_amount_details_line_item_payment_method_options_param","type":"object","properties":{"image_url":{"maxLength":4096,"type":"string","description":"URL to an image for the product. Max length, 4096 characters."},"product_url":{"maxLength":4096,"type":"string","description":"URL to the product page. Max length, 4096 characters."},"reference":{"maxLength":255,"type":"string","description":"Unique reference for this line item to correlate it with your system’s internal records. The field is displayed in the Klarna Consumer App if passed."},"subscription_reference":{"maxLength":255,"type":"string","description":"Reference for the subscription this line item is for."}},"description":"This sub-hash contains line item details that are specific to the `klarna` payment method.","x-stripeMostCommon":["image_url","product_url","reference","subscription_reference"]},"paypal":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"category":{"type":"string","description":"Type of the line item.","enum":["digital_goods","donation","physical_goods"]},"description":{"maxLength":127,"type":"string","description":"Description of the line item."},"sold_by":{"maxLength":127,"type":"string","description":"The Stripe account ID of the connected account that sells the item."}},"description":"This sub-hash contains line item details that are specific to the `paypal` payment method.","x-stripeMostCommon":["category","description","sold_by"]}},"description":"Payment method-specific information for line items.","x-stripeMostCommon":["card","card_present","dummy_auth_push","klarna","link","paypal"]},"product_code":{"maxLength":12,"type":"string","description":"The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long."},"product_name":{"maxLength":1024,"type":"string","description":"The product name of the line item. Required for L3 rates. At most 1024 characters long.\n\nFor Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters."},"quantity":{"type":"integer","description":"The quantity of items. Required for L3 rates. An integer greater than 0."},"tax":{"title":"amount_details_line_item_tax_param","required":["total_tax_amount"],"type":"object","properties":{"total_tax_amount":{"type":"integer","description":"The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field."}},"description":"Contains information about the tax on the item.","x-stripeMostCommon":["total_tax_amount"]},"unit_cost":{"type":"integer","description":"The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0."},"unit_of_measure":{"maxLength":12,"type":"string","description":"A unit of measure for the line item, such as gallons, feet, meters, etc."}},"x-stripeMostCommon":["discount_amount","payment_method_options","product_code","product_name","quantity","quantity_precision","tax","unit_cost","unit_cost_precision","unit_of_measure"]}},{"type":"string","enum":[""]}]},"shipping":{"description":"Contains information about the shipping portion of the amount.","anyOf":[{"title":"amount_details_shipping_param","type":"object","properties":{"amount":{"description":"If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"from_postal_code":{"description":"If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed.","anyOf":[{"maxLength":10,"type":"string"},{"type":"string","enum":[""]}]},"to_postal_code":{"description":"If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed.","anyOf":[{"maxLength":10,"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["amount","from_postal_code","to_postal_code"]},{"type":"string","enum":[""]}]},"surcharge":{"description":"Contains information about the surcharge portion of the amount.","anyOf":[{"title":"amount_details_surcharge_param","type":"object","properties":{"amount":{"description":"Portion of the amount that corresponds to a surcharge.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"enforce_validation":{"type":"string","description":"Indicate whether to enforce validations on the surcharge amount.","enum":["","automatic","disabled","enabled"]}},"x-stripeMostCommon":["amount","enforce_validation"]},{"type":"string","enum":[""]}]},"tax":{"description":"Contains information about the tax portion of the amount.","anyOf":[{"title":"amount_details_tax_param","required":["total_tax_amount"],"type":"object","properties":{"total_tax_amount":{"type":"integer","description":"The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."}},"x-stripeMostCommon":["total_tax_amount"]},{"type":"string","enum":[""]}]}},"description":"Provides industry-specific information about the amount.","x-stripeMostCommon":["discount_amount","enforce_arithmetic_validation","line_items","shipping","surcharge","tax","tip"]},"amount_to_capture":{"type":"integer","description":"The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided."},"application_fee_amount":{"type":"integer","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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"final_capture":{"type":"boolean","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://docs.stripe.com/payments/multicapture) is available for PaymentIntents."},"hooks":{"title":"async_workflows_param","type":"object","properties":{"inputs":{"title":"async_workflows_inputs_param","type":"object","properties":{"tax":{"title":"async_workflows_inputs_tax_param","required":["calculation"],"type":"object","properties":{"calculation":{"description":"The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax arguments for automations","x-stripeMostCommon":["calculation"]}},"description":"Arguments passed in automations","x-stripeMostCommon":["tax"]}},"description":"Automations to be run during the PaymentIntent lifecycle","x-stripeMostCommon":["inputs"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment_details":{"description":"Provides industry-specific information about the charge.","anyOf":[{"title":"payment_details_capture_params","type":"object","properties":{"car_rental":{"title":"car_rental","required":["booking_number","days_rented","pickup_at","return_at"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"booking_number":{"maxLength":100,"type":"string","description":"The booking number associated with the car rental."},"car_class_code":{"maxLength":4,"type":"string","description":"Class code of the car."},"car_make":{"maxLength":10,"type":"string","description":"Make of the car."},"car_model":{"maxLength":10,"type":"string","description":"Model of the car."},"company":{"maxLength":26,"type":"string","description":"The name of the rental car company."},"customer_service_phone_number":{"maxLength":16,"type":"string","description":"The customer service phone number of the car rental company."},"days_rented":{"type":"integer","description":"Number of days the car is being rented."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"distance":{"title":"car_rental_distance","type":"object","properties":{"amount":{"type":"integer","description":"Distance traveled."},"unit":{"type":"string","description":"Unit of measurement for the distance traveled. One of `miles` or `kilometers`.","enum":["kilometers","miles"]}},"description":"The details of the distance traveled during the rental period.","x-stripeMostCommon":["amount","unit"]},"drivers":{"type":"array","description":"The details of the passengers in the travel reservation","items":{"title":"car_rental_driver","required":["name"],"type":"object","properties":{"driver_identification_number":{"maxLength":20,"type":"string","description":"Driver's identification number."},"driver_tax_number":{"maxLength":20,"type":"string","description":"Driver's tax number."},"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the car reservation."}},"x-stripeMostCommon":["driver_identification_number","driver_tax_number","name"]}},"extra_charges":{"type":"array","description":"List of additional charges being billed.","items":{"type":"string","enum":["extra_mileage","gas","late_return","one_way_service","parking_violation"]}},"no_show":{"type":"boolean","description":"Indicates if the customer did not keep nor cancel their booking."},"pickup_address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Car pick-up address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"pickup_at":{"type":"integer","description":"Car pick-up time. Measured in seconds since the Unix epoch.","format":"unix-time"},"pickup_location_name":{"maxLength":38,"type":"string","description":"Name of the pickup location."},"rate_amount":{"type":"integer","description":"Rental rate."},"rate_interval":{"type":"string","description":"The frequency at which the rate amount is applied. One of `day`, `week` or `month`","enum":["day","month","week"]},"renter_name":{"maxLength":100,"type":"string","description":"The name of the person or entity renting the car."},"return_address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Car return address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"return_at":{"type":"integer","description":"Car return time. Measured in seconds since the Unix epoch.","format":"unix-time"},"return_location_name":{"maxLength":38,"type":"string","description":"Name of the return location."},"tax_exempt":{"type":"boolean","description":"Indicates whether the goods or services are tax-exempt or tax is not collected."},"vehicle_identification_number":{"maxLength":20,"type":"string","description":"The vehicle identification number."}},"description":"Car rental details for this PaymentIntent.","x-stripeMostCommon":["affiliate","booking_number","car_class_code","car_make","car_model","company","customer_service_phone_number","days_rented","delivery","distance","drivers","extra_charges","no_show","pickup_address","pickup_at","pickup_location_name","rate_amount","rate_interval","renter_name","return_address","return_at","return_location_name","tax_exempt","vehicle_identification_number"]},"car_rental_data":{"description":"Car rental data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"car_rental_data","required":["drop_off","pickup","total"],"type":"object","properties":{"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Name of affiliate partner."}},"description":"Affiliate (such as travel agency) details for the rental.","x-stripeMostCommon":["code","name"]},"booking_number":{"maxLength":255,"type":"string","description":"Booking confirmation number for the car rental."},"carrier_name":{"maxLength":255,"type":"string","description":"Name of the car rental company."},"customer_service_phone_number":{"type":"string","description":"Customer service phone number for the car rental company."},"days_rented":{"type":"integer","description":"Number of days the car is being rented."},"distance":{"title":"distance","required":["amount","unit"],"type":"object","properties":{"amount":{"type":"integer","description":"Distance traveled."},"unit":{"type":"string","description":"Unit of measurement for the distance traveled. One of `miles` or `kilometers`.","enum":["kilometers","miles"]}},"description":"Distance details for the rental.","x-stripeMostCommon":["amount","unit"]},"drivers":{"type":"array","description":"List of drivers for the rental.","items":{"title":"driver","required":["name"],"type":"object","properties":{"date_of_birth":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"Day of birth (1-31)."},"month":{"type":"integer","description":"Month of birth (1-12)."},"year":{"type":"integer","description":"Year of birth (must be greater than 1900)."}},"description":"Driver's date of birth.","x-stripeMostCommon":["day","month","year"]},"driver_identification_number":{"maxLength":20,"type":"string","description":"Driver's identification number."},"driver_tax_number":{"maxLength":20,"type":"string","description":"Driver's tax number."},"name":{"maxLength":198,"type":"string","description":"Driver's full name."}},"x-stripeMostCommon":["date_of_birth","driver_identification_number","driver_tax_number","name"]}},"drop_off":{"title":"location","required":["address","time"],"type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the rental location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"location_name":{"maxLength":38,"type":"string","description":"Location name."},"time":{"type":"integer","description":"Timestamp for the location.","format":"unix-time"}},"description":"Drop-off location details.","x-stripeMostCommon":["address","location_name","time"]},"insurances":{"type":"array","description":"Insurance details for the rental.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount of the insurance coverage in cents."},"currency":{"type":"string","description":"Currency of the insurance amount.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the insurance company."},"insurance_type":{"type":"string","description":"Type of insurance coverage.","enum":["liability_supplement","loss_damage_waiver","other","partial_damage_waiver","personal_accident","personal_effects"],"x-stripeEnum":{"kind":"open","values":[{"description":"Supplemental liability insurance coverage.","value":"liability_supplement"},{"description":"Agreement waiving responsibility for loss or damage to the vehicle.","value":"loss_damage_waiver"},{"description":"Other types of insurance coverage.","value":"other"},{"description":"Agreement limiting responsibility for loss or damage to the vehicle.","value":"partial_damage_waiver"},{"description":"Insurance covering personal accidents during the rental period.","value":"personal_accident"},{"description":"Insurance covering personal belongings during the rental period.","value":"personal_effects"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"no_show_indicator":{"type":"boolean","description":"Indicates if the customer was a no-show."},"pickup":{"title":"location","required":["address","time"],"type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the rental location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"location_name":{"maxLength":38,"type":"string","description":"Location name."},"time":{"type":"integer","description":"Timestamp for the location.","format":"unix-time"}},"description":"Pickup location details.","x-stripeMostCommon":["address","location_name","time"]},"renter_name":{"maxLength":198,"type":"string","description":"Name of the person renting the vehicle."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total amount in cents."},"currency":{"type":"string","description":"Currency of the amount.","format":"currency"},"discounts":{"title":"discounts","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."},"coupon":{"maxLength":25,"type":"string","description":"Coupon code applied to the rental."},"maximum_free_miles_or_kilometers":{"type":"integer","description":"Maximum number of free miles or kilometers included."}},"description":"Discount details for the rental.","x-stripeMostCommon":["corporate_client_code","coupon","maximum_free_miles_or_kilometers"]},"extra_charges":{"type":"array","description":"Additional charges for the rental.","items":{"title":"extra_charge","required":["amount","type"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount of the extra charge in cents."},"type":{"type":"string","description":"Type of extra charge.","enum":["extra_mileage","gas","gps","late_charge","one_way_drop_off","other","parking","phone","regular_mileage","towing"]}},"x-stripeMostCommon":["amount","type"]}},"rate_per_unit":{"type":"integer","description":"Rate per unit for the rental."},"rate_unit":{"type":"string","description":"Unit of measurement for the rate.","enum":["days","kilometers","miles","months","weeks"],"x-stripeEnum":{"kind":"open","values":[{"description":"Rental rate charged per day.","value":"days"},{"description":"Rental rate charged per kilometer.","value":"kilometers"},{"description":"Rental rate charged per mile.","value":"miles"},{"description":"Rental rate charged per month.","value":"months"},{"description":"Rental rate charged per week.","value":"weeks"}]}},"tax":{"title":"tax","type":"object","properties":{"tax_exempt_indicator":{"type":"boolean","description":"Indicates if the transaction is tax exempt."},"tax_items":{"type":"array","description":"Array of tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount."},"rate":{"type":"integer","description":"Tax rate applied."},"type":{"maxLength":40,"type":"string","description":"Type of tax applied."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown for the rental.","x-stripeMostCommon":["tax_exempt_indicator","tax_items"]}},"description":"Total cost breakdown for the rental.","x-stripeMostCommon":["amount","currency","discounts","extra_charges","rate_per_unit","rate_unit","tax"]},"vehicle":{"title":"vehicle","type":"object","properties":{"make":{"maxLength":40,"type":"string","description":"Make of the rental vehicle."},"model":{"maxLength":40,"type":"string","description":"Model of the rental vehicle."},"odometer":{"type":"integer","description":"Odometer reading at the time of rental."},"type":{"type":"string","description":"Type of the rental vehicle.","enum":["cargo_van","compact","economy","exotic","exotic_suv","fifteen_passenger_van","four_wheel_drive","full_size","intermediate","large_suv","large_truck","luxury","medium_suv","midsize","mini","minivan","miscellaneous","moped","moving_van","premium","regular","small_medium_truck","small_suv","special","standard","stretch","subcompact","taxi","twelve_foot_truck","twelve_passenger_van","twenty_foot_truck","twenty_four_foot_truck","twenty_six_foot_truck","unique"],"x-stripeEnum":{"kind":"open","values":[{"description":"Van designed for cargo transport.","value":"cargo_van"},{"description":"Compact car.","value":"compact"},{"description":"Economy-class car.","value":"economy"},{"description":"Exotic or high-performance vehicle.","value":"exotic"},{"description":"Exotic or luxury sport utility vehicle.","value":"exotic_suv"},{"description":"Van with capacity for fifteen passengers.","value":"fifteen_passenger_van"},{"description":"Four-wheel-drive vehicle.","value":"four_wheel_drive"},{"description":"Full-sized car.","value":"full_size"},{"description":"Intermediate-sized car.","value":"intermediate"},{"description":"Large sport utility vehicle.","value":"large_suv"},{"description":"Large truck.","value":"large_truck"},{"description":"Luxury car.","value":"luxury"},{"description":"Medium sport utility vehicle.","value":"medium_suv"},{"description":"Midsize car.","value":"midsize"},{"description":"Mini-sized car.","value":"mini"},{"description":"Minivan.","value":"minivan"},{"description":"Other miscellaneous vehicle types.","value":"miscellaneous"},{"description":"Moped or motorized scooter.","value":"moped"},{"description":"Van designed for moving goods.","value":"moving_van"},{"description":"Premium car.","value":"premium"},{"description":"Regular vehicle type.","value":"regular"},{"description":"Small to medium truck.","value":"small_medium_truck"},{"description":"Small sport utility vehicle.","value":"small_suv"},{"description":"Special vehicle type.","value":"special"},{"description":"Standard-sized car.","value":"standard"},{"description":"Stretch limousine.","value":"stretch"},{"description":"Subcompact car.","value":"subcompact"},{"description":"Taxi or for-hire vehicle.","value":"taxi"},{"description":"Truck with twelve-foot cargo space.","value":"twelve_foot_truck"},{"description":"Van with capacity for twelve passengers.","value":"twelve_passenger_van"},{"description":"Truck with twenty-foot cargo space.","value":"twenty_foot_truck"},{"description":"Truck with twenty-four-foot cargo space.","value":"twenty_four_foot_truck"},{"description":"Truck with twenty-six-foot cargo space.","value":"twenty_six_foot_truck"},{"description":"Unique or specialty vehicle.","value":"unique"}]}},"vehicle_class":{"type":"string","description":"Class of the rental vehicle.","enum":["business","economy","first_class","premium_economy"]},"vehicle_identification_number":{"maxLength":20,"type":"string","description":"Vehicle identification number (VIN)."}},"description":"Vehicle details for the rental.","x-stripeMostCommon":["make","model","odometer","type","vehicle_class","vehicle_identification_number"]}},"x-stripeMostCommon":["affiliate","booking_number","carrier_name","customer_service_phone_number","days_rented","distance","drivers","drop_off","insurances","no_show_indicator","pickup","renter_name","total","vehicle"]}},{"type":"string","enum":[""]}]},"customer_reference":{"description":"A unique value to identify the customer. This field is available only for card payments.\n\nThis field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"event_details":{"title":"event","required":["name"],"type":"object","properties":{"access_controlled_venue":{"type":"boolean","description":"Indicates if the tickets are digitally checked when entering the venue."},"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The event location's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"company":{"maxLength":5000,"type":"string","description":"The name of the company"},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"ends_at":{"type":"integer","description":"Event end time. Measured in seconds since the Unix epoch.","format":"unix-time"},"genre":{"maxLength":5000,"type":"string","description":"Type of the event entertainment (concert, sports event etc)"},"name":{"maxLength":5000,"type":"string","description":"The name of the event."},"starts_at":{"type":"integer","description":"Event start time. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Event details for this PaymentIntent","x-stripeMostCommon":["access_controlled_venue","address","affiliate","company","delivery","ends_at","genre","name","starts_at"]},"flight":{"title":"flight","required":["segments"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"agency_number":{"maxLength":8,"type":"string","description":"The agency number (i.e. International Air Transport Association (IATA) agency number) of the travel agency that made the booking."},"carrier":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) carrier code of the carrier that issued the ticket."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"passenger_name":{"maxLength":26,"type":"string","description":"The name of the person or entity on the reservation."},"passengers":{"type":"array","description":"The details of the passengers in the travel reservation.","items":{"title":"flight_passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the flight reservation."}},"x-stripeMostCommon":["name"]}},"segments":{"type":"array","description":"The individual flight segments associated with the trip.","items":{"title":"flight_segment","required":["departs_at"],"type":"object","properties":{"amount":{"type":"integer","description":"The flight segment amount."},"arrival_airport":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) airport code for the arrival airport."},"arrives_at":{"type":"integer","description":"The arrival time for the flight segment. Measured in seconds since the Unix epoch.","format":"unix-time"},"carrier":{"maxLength":2,"type":"string","description":"The International Air Transport Association (IATA) carrier code of the carrier operating the flight segment."},"departs_at":{"type":"integer","description":"The departure time for the flight segment. Measured in seconds since the Unix epoch.","format":"unix-time"},"departure_airport":{"maxLength":3,"type":"string","description":"The International Air Transport Association (IATA) airport code for the departure airport."},"flight_number":{"maxLength":4,"type":"string","description":"The flight number associated with the segment"},"service_class":{"type":"string","description":"The fare class for the segment.","enum":["business","economy","first","premium_economy"]}},"x-stripeMostCommon":["amount","arrival_airport","arrives_at","carrier","departs_at","departure_airport","flight_number","service_class"]}},"ticket_number":{"maxLength":14,"type":"string","description":"The ticket number associated with the travel reservation."}},"description":"Flight reservation details for this PaymentIntent","x-stripeMostCommon":["affiliate","agency_number","carrier","delivery","passenger_name","passengers","segments","ticket_number"]},"flight_data":{"description":"Flight data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"flight_data","required":["segments","total"],"type":"object","properties":{"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Name of affiliate partner."},"travel_authorization_code":{"maxLength":64,"type":"string","description":"Code provided by the company to a travel agent authorizing ticket issuance."}},"description":"Affiliate details if applicable.","x-stripeMostCommon":["code","name","travel_authorization_code"]},"booking_number":{"maxLength":255,"type":"string","description":"Reservation reference."},"computerized_reservation_system":{"maxLength":4,"type":"string","description":"Computerized reservation system used to make the reservation and purchase the ticket."},"endorsements_and_restrictions":{"maxLength":20,"type":"string","description":"Ticket restrictions."},"insurances":{"type":"array","description":"List of insurances.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Insurance cost."},"currency":{"type":"string","description":"Insurance currency.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Insurance company name."},"insurance_type":{"type":"string","description":"Type of insurance.","enum":["baggage","bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance covering lost, damaged, or delayed baggage.","value":"baggage"},{"description":"Insurance covering losses due to airline bankruptcy.","value":"bankruptcy"},{"description":"Insurance covering flight cancellation.","value":"cancelation"},{"description":"Insurance covering general emergency situations.","value":"emergency"},{"description":"Insurance covering medical emergencies during travel.","value":"medical"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"passengers":{"type":"array","description":"List of passengers.","items":{"title":"passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":198,"type":"string","description":"Passenger's full name."}},"x-stripeMostCommon":["name"]}},"segments":{"type":"array","description":"List of flight segments.","items":{"title":"segment","required":["arrival","carrier_code","departure","service_class"],"type":"object","properties":{"amount":{"type":"integer","description":"Segment fare amount."},"arrival":{"title":"arrival","required":["airport"],"type":"object","properties":{"airport":{"maxLength":5000,"type":"string","description":"Arrival airport IATA code."},"arrives_at":{"type":"integer","description":"Arrival date/time.","format":"unix-time"},"city":{"maxLength":99,"type":"string","description":"Arrival city."},"country":{"maxLength":5000,"type":"string","description":"Arrival country."}},"description":"Arrival details.","x-stripeMostCommon":["airport","arrives_at","city","country"]},"carrier_code":{"maxLength":5000,"type":"string","description":"Airline carrier code."},"carrier_name":{"maxLength":25,"type":"string","description":"Carrier name."},"currency":{"type":"string","description":"Segment currency.","format":"currency"},"departure":{"title":"departure","required":["airport","departs_at"],"type":"object","properties":{"airport":{"maxLength":5000,"type":"string","description":"Departure airport IATA code."},"city":{"maxLength":99,"type":"string","description":"Departure city."},"country":{"maxLength":5000,"type":"string","description":"Departure country."},"departs_at":{"type":"integer","description":"Departure date/time.","format":"unix-time"}},"description":"Departure details.","x-stripeMostCommon":["airport","city","country","departs_at"]},"exchange_ticket_number":{"maxLength":20,"type":"string","description":"Exchange ticket number."},"fare_basis_code":{"maxLength":20,"type":"string","description":"Fare basis code."},"fees":{"type":"integer","description":"Additional fees."},"flight_number":{"maxLength":20,"type":"string","description":"Flight number."},"is_stop_over_indicator":{"type":"boolean","description":"Stopover indicator."},"refundable":{"type":"boolean","description":"Refundable ticket indicator."},"service_class":{"type":"string","description":"Class of service.","enum":["business","economy","first_class","premium_economy"],"x-stripeEnum":{"kind":"open","values":[{"description":"Business class seating.","value":"business"},{"description":"Economy class seating.","value":"economy"},{"description":"First class seating with premium amenities.","value":"first_class"},{"description":"Premium economy class with enhanced seating and services.","value":"premium_economy"}]}},"tax_amount":{"type":"integer","description":"Tax amount for segment."},"ticket_number":{"maxLength":20,"type":"string","description":"Ticket number."}},"x-stripeMostCommon":["amount","arrival","carrier_code","carrier_name","currency","departure","exchange_ticket_number","fare_basis_code","fees","flight_number","is_stop_over_indicator","refundable","service_class","tax_amount","ticket_number"]}},"ticket_electronically_issued_indicator":{"type":"boolean","description":"Electronic ticket indicator."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total flight amount."},"credit_reason":{"type":"string","description":"Reason for credit.","enum":["other","partial_ticket_refund","passenger_transport_ancillary_cancellation","ticket_and_ancillary_cancellation","ticket_cancellation"],"x-stripeEnum":{"kind":"open","values":[{"description":"Other credit reasons.","value":"other"},{"description":"Partial refund of the ticket cost.","value":"partial_ticket_refund"},{"description":"Cancellation of passenger transport and ancillary services.","value":"passenger_transport_ancillary_cancellation"},{"description":"Cancellation of both ticket and ancillary services.","value":"ticket_and_ancillary_cancellation"},{"description":"Cancellation of the ticket only.","value":"ticket_cancellation"}]}},"currency":{"type":"string","description":"Total currency.","format":"currency"},"discounts":{"title":"discounts","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."}},"description":"Discount details.","x-stripeMostCommon":["corporate_client_code"]},"extra_charges":{"type":"array","description":"Additional charges.","items":{"title":"extra_charge","type":"object","properties":{"amount":{"type":"integer","description":"Amount of additional charges."},"type":{"type":"string","description":"Type of additional charges.","enum":["additional_fees","ancillary_service_charges","exchange_fee"],"x-stripeEnum":{"kind":"open","values":[{"description":"Additional fees charged for the flight.","value":"additional_fees"},{"description":"Charges for ancillary services such as baggage, seat selection, or meals.","value":"ancillary_service_charges"},{"description":"Fee charged for exchanging or changing the ticket.","value":"exchange_fee"}]}}},"x-stripeMostCommon":["amount","type"]}},"tax":{"title":"tax","type":"object","properties":{"tax_items":{"type":"array","description":"Array of tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount."},"rate":{"type":"integer","description":"Tax rate."},"type":{"maxLength":40,"type":"string","description":"Type of tax."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown.","x-stripeMostCommon":["tax_items"]}},"description":"Total cost breakdown.","x-stripeMostCommon":["amount","credit_reason","currency","discounts","extra_charges","tax"]},"transaction_type":{"type":"string","description":"Type of flight transaction.","enum":["exchange_ticket","miscellaneous","refund","ticket_purchase"],"x-stripeEnum":{"kind":"open","values":[{"description":"Exchange or modification of an existing ticket.","value":"exchange_ticket"},{"description":"Other miscellaneous flight-related transactions.","value":"miscellaneous"},{"description":"Refund for a canceled or unused ticket.","value":"refund"},{"description":"Purchase of a new flight ticket.","value":"ticket_purchase"}]}}},"x-stripeMostCommon":["affiliate","booking_number","computerized_reservation_system","endorsements_and_restrictions","insurances","passengers","segments","ticket_electronically_issued_indicator","total","transaction_type"]}},{"type":"string","enum":[""]}]},"lodging":{"title":"lodging","required":["checkin_at","checkout_at"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The lodging location's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"adults":{"type":"integer","description":"The number of adults on the booking"},"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"booking_number":{"maxLength":100,"type":"string","description":"The booking number associated with the lodging reservation."},"category":{"type":"string","description":"The lodging category","enum":["hotel","vacation_rental"]},"checkin_at":{"type":"integer","description":"Lodging check-in time. Measured in seconds since the Unix epoch.","format":"unix-time"},"checkout_at":{"type":"integer","description":"Lodging check-out time. Measured in seconds since the Unix epoch.","format":"unix-time"},"customer_service_phone_number":{"type":"string","description":"The customer service phone number of the lodging company."},"daily_room_rate_amount":{"type":"integer","description":"The daily lodging room rate."},"delivery":{"title":"delivery","type":"object","properties":{"mode":{"type":"string","description":"The delivery method for the payment","enum":["email","phone","pickup","post"]},"recipient":{"title":"delivery_recipient","type":"object","properties":{"email":{"maxLength":5000,"type":"string","description":"The email of the recipient the ticket is delivered to."},"name":{"maxLength":5000,"type":"string","description":"The name of the recipient the ticket is delivered to."},"phone":{"maxLength":5000,"type":"string","description":"The phone number of the recipient the ticket is delivered to."}},"description":"Details of the recipient.","x-stripeMostCommon":["email","name","phone"]}},"description":"Delivery details for this purchase.","x-stripeMostCommon":["mode","recipient"]},"extra_charges":{"type":"array","description":"List of additional charges being billed.","items":{"type":"string","enum":["gift_shop","laundry","mini_bar","other","restaurant","telephone"]}},"fire_safety_act_compliance":{"type":"boolean","description":"Indicates whether the lodging location is compliant with the Fire Safety Act."},"name":{"maxLength":100,"type":"string","description":"The name of the lodging location."},"no_show":{"type":"boolean","description":"Indicates if the customer did not keep their booking while failing to cancel the reservation."},"number_of_rooms":{"type":"integer","description":"The number of rooms on the booking"},"passengers":{"type":"array","description":"The details of the passengers in the travel reservation","items":{"title":"lodging_passenger","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"Full name of the person or entity on the lodging reservation."}},"x-stripeMostCommon":["name"]}},"property_phone_number":{"type":"string","description":"The phone number of the lodging location."},"room_class":{"maxLength":5000,"type":"string","description":"The room class for this purchase."},"room_nights":{"type":"integer","description":"The number of room nights"},"total_room_tax_amount":{"type":"integer","description":"The total tax amount associating with the room reservation."},"total_tax_amount":{"type":"integer","description":"The total tax amount"}},"description":"Lodging reservation details for this PaymentIntent","x-stripeMostCommon":["address","adults","affiliate","booking_number","category","checkin_at","checkout_at","customer_service_phone_number","daily_room_rate_amount","delivery","extra_charges","fire_safety_act_compliance","name","no_show","number_of_rooms","passengers","property_phone_number","room_class","room_nights","total_room_tax_amount","total_tax_amount"]},"lodging_data":{"description":"Lodging data for this PaymentIntent.","anyOf":[{"type":"array","items":{"title":"lodging_data","required":["checkin_at","checkout_at","total"],"type":"object","properties":{"accommodation":{"title":"accommodation","type":"object","properties":{"accommodation_type":{"type":"string","description":"Type of accommodation.","enum":["apartment","cabana","house","penthouse","room","standard","suite","villa"],"x-stripeEnum":{"kind":"open","values":[{"description":"A self-contained apartment unit.","value":"apartment"},{"description":"A cabana or small cabin.","value":"cabana"},{"description":"A standalone house.","value":"house"},{"description":"A penthouse or top-floor luxury accommodation.","value":"penthouse"},{"description":"A standard room.","value":"room"},{"description":"A standard accommodation type.","value":"standard"},{"description":"A suite with multiple rooms or enhanced amenities.","value":"suite"},{"description":"A villa or luxury residence.","value":"villa"}]}},"bed_type":{"maxLength":20,"type":"string","description":"Bed type."},"daily_rate_amount":{"type":"integer","description":"Daily accommodation rate in cents."},"nights":{"type":"integer","description":"Number of nights."},"number_of_rooms":{"type":"integer","description":"Number of rooms, cabanas, apartments, and so on."},"rate_type":{"maxLength":20,"type":"string","description":"Rate type."},"smoking_indicator":{"type":"boolean","description":"Whether smoking is allowed."}},"description":"Accommodation details for the lodging.","x-stripeMostCommon":["accommodation_type","bed_type","daily_rate_amount","nights","number_of_rooms","rate_type","smoking_indicator"]},"affiliate":{"title":"affiliate","type":"object","properties":{"code":{"maxLength":20,"type":"string","description":"Affiliate partner code."},"name":{"maxLength":255,"type":"string","description":"Affiliate partner name."}},"description":"Affiliate details if applicable.","x-stripeMostCommon":["code","name"]},"booking_number":{"maxLength":255,"type":"string","description":"Booking confirmation number for the lodging."},"checkin_at":{"type":"integer","description":"Check-in date.","format":"unix-time"},"checkout_at":{"type":"integer","description":"Check-out date.","format":"unix-time"},"customer_service_phone_number":{"type":"string","description":"Customer service phone number for the lodging company."},"fire_safety_act_compliance_indicator":{"type":"boolean","description":"Whether the lodging is compliant with any hotel fire safety regulations."},"guests":{"type":"array","description":"List of guests for the lodging.","items":{"title":"guest","required":["name"],"type":"object","properties":{"name":{"maxLength":198,"type":"string","description":"Guest's full name."}},"x-stripeMostCommon":["name"]}},"host":{"title":"host","type":"object","properties":{"address":{"title":"required_address","required":["city","country","line1","postal_code"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Address of the host.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"country_of_domicile":{"maxLength":5000,"type":"string","description":"Host's country of domicile."},"host_reference":{"maxLength":255,"type":"string","description":"Reference number for the host."},"host_type":{"type":"string","description":"Type of host.","enum":["hostel","hotel","owner","rental_agency"],"x-stripeEnum":{"kind":"open","values":[{"description":"A hostel or shared accommodation facility.","value":"hostel"},{"description":"A hotel or hotel chain.","value":"hotel"},{"description":"The property owner directly managing the rental.","value":"owner"},{"description":"A rental agency managing the property.","value":"rental_agency"}]}},"name":{"maxLength":255,"type":"string","description":"Name of the lodging property or host."},"number_of_reservations":{"type":"integer","description":"Total number of reservations for the host."},"property_phone_number":{"type":"string","description":"Property phone number."},"registered_at":{"type":"integer","description":"Host's registration date.","format":"unix-time"}},"description":"Host details for the lodging.","x-stripeMostCommon":["address","country_of_domicile","host_reference","host_type","name","number_of_reservations","property_phone_number","registered_at"]},"insurances":{"type":"array","description":"List of insurances for the lodging.","items":{"title":"insurance","required":["amount","insurance_type"],"type":"object","properties":{"amount":{"type":"integer","description":"Price of the insurance coverage in cents."},"currency":{"type":"string","description":"Currency of the insurance amount.","format":"currency"},"insurance_company_name":{"maxLength":255,"type":"string","description":"Name of the insurance company."},"insurance_type":{"type":"string","description":"Type of insurance coverage.","enum":["bankruptcy","cancelation","emergency","medical"],"x-stripeEnum":{"kind":"open","values":[{"description":"Insurance covering losses due to provider bankruptcy.","value":"bankruptcy"},{"description":"Insurance covering cancellation.","value":"cancelation"},{"description":"Insurance covering general emergency situations.","value":"emergency"},{"description":"Insurance covering medical emergencies during the stay.","value":"medical"}]}}},"x-stripeMostCommon":["amount","currency","insurance_company_name","insurance_type"]}},"no_show_indicator":{"type":"boolean","description":"Whether the renter is a no-show."},"renter_id_number":{"maxLength":25,"type":"string","description":"Renter ID number for the lodging."},"renter_name":{"maxLength":198,"type":"string","description":"Renter name for the lodging."},"total":{"title":"total","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"Total price of the lodging reservation in cents."},"cash_advances":{"type":"integer","description":"Cash advances in cents."},"currency":{"type":"string","description":"Currency of the total amount.","format":"currency"},"discounts":{"title":"discount","type":"object","properties":{"corporate_client_code":{"maxLength":20,"type":"string","description":"Corporate client discount code."},"coupon":{"maxLength":25,"type":"string","description":"Coupon code."}},"description":"Discount details for the lodging.","x-stripeMostCommon":["corporate_client_code","coupon"]},"extra_charges":{"type":"array","description":"Additional charges for the lodging.","items":{"title":"extra_charge","type":"object","properties":{"amount":{"type":"integer","description":"Amount of the extra charge in cents."},"type":{"type":"string","description":"Type of extra charge.","enum":["gift_shop","laundry","mini_bar","other","phone","restaurant"],"x-stripeEnum":{"kind":"open","values":[{"description":"Charges for gift shop purchases.","value":"gift_shop"},{"description":"Charges for laundry or cleaning services.","value":"laundry"},{"description":"Charges for mini bar consumption.","value":"mini_bar"},{"description":"Other miscellaneous charges.","value":"other"},{"description":"Charges for telephone services.","value":"phone"},{"description":"Charges for dining or food services.","value":"restaurant"}]}}},"x-stripeMostCommon":["amount","type"]}},"prepaid_amount":{"type":"integer","description":"Prepaid amount in cents."},"tax":{"title":"tax","type":"object","properties":{"tax_exempt_indicator":{"type":"boolean","description":"Indicates whether the transaction is tax exempt."},"tax_items":{"type":"array","description":"Tax details.","items":{"title":"tax_item","type":"object","properties":{"amount":{"type":"integer","description":"Tax amount in cents."},"rate":{"type":"integer","description":"Tax rate."},"type":{"maxLength":40,"type":"string","description":"Type of tax applied."}},"x-stripeMostCommon":["amount","rate","type"]}}},"description":"Tax breakdown for the lodging reservation.","x-stripeMostCommon":["tax_exempt_indicator","tax_items"]}},"description":"Total details for the lodging.","x-stripeMostCommon":["amount","cash_advances","currency","discounts","extra_charges","prepaid_amount","tax"]}},"x-stripeMostCommon":["accommodation","affiliate","booking_number","checkin_at","checkout_at","customer_service_phone_number","fire_safety_act_compliance_indicator","guests","host","insurances","no_show_indicator","renter_id_number","renter_name","total"]}},{"type":"string","enum":[""]}]},"order_reference":{"description":"A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.\n\nFor Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"subscription":{"title":"subscription","required":["name"],"type":"object","properties":{"affiliate":{"title":"affiliate","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The name of the affiliate that originated the purchase."}},"description":"Affiliate details for this purchase.","x-stripeMostCommon":["name"]},"auto_renewal":{"type":"boolean","description":"Info whether the subscription will be auto renewed upon expiry."},"billing_interval":{"title":"subscription_billing_interval","required":["count","interval"],"type":"object","properties":{"count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."},"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]}},"description":"Subscription billing details for this purchase.","x-stripeMostCommon":["count","interval"]},"ends_at":{"type":"integer","description":"Subscription end time. Measured in seconds since the Unix epoch.","format":"unix-time"},"name":{"maxLength":5000,"type":"string","description":"Name of the product on subscription. e.g. Apple Music Subscription"},"starts_at":{"type":"integer","description":"Subscription start time. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Subscription details for this PaymentIntent","x-stripeMostCommon":["affiliate","auto_renewal","billing_interval","ends_at","name","starts_at"]}},"x-stripeMostCommon":["car_rental","car_rental_data","event_details","fleet_data","flight","flight_data","healthcare","lodging","lodging_data","subscription"]},{"type":"string","enum":[""]}]},"statement_descriptor":{"maxLength":22,"type":"string","description":"Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."},"statement_descriptor_suffix":{"maxLength":22,"type":"string","description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."},"transfer_data":{"title":"transfer_data_capture_params","type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when a charge succeeds."}},"description":"The parameters that you can use to automatically create a transfer after the payment\nis captured. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).","x-stripeMostCommon":["amount"]}},"additionalProperties":false,"x-stripeMostCommon":["amount_to_capture","metadata"]},"encoding":{"amount_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"hooks":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"capture_payment_intent"}},"/v1/payment_intents/{intent}/confirm":{"post":{"summary":"Confirm a PaymentIntent","description":"Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.
\n\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled status if the confirmation limit is reached. If\npayment succeeds, the PaymentIntent will transition to the succeeded\nstatus (or requires_capture, if capture_method is set to manual).
If the confirmation_method is automatic, payment may be attempted\nusing our client SDKs\nand the PaymentIntent’s client_secret.\nAfter next_actions are handled by the client, no additional\nconfirmation is required to complete the payment.
If the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.
If any actions are required for the payment, the PaymentIntent will\nreturn to the requires_confirmation state\nafter those actions are completed. Your server needs to then\nexplicitly re-confirm the PaymentIntent to initiate the next payment\nattempt.
There is a variable upper limit on how many times a PaymentIntent can be confirmed.\nAfter this limit is reached, any further calls to this endpoint will\ntransition the PaymentIntent to the canceled state.
Perform a decremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\ndecremental_authorization.status\nmust be available.
Decremental authorizations decrease the authorized amount on your customer’s card\nto the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
After decrement, the PaymentIntent object\nreturns with the updated\namount.\nThe PaymentIntent will now be capturable up to the new authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.\nAfter it’s fully captured, a PaymentIntent can no longer be decremented.
","operationId":"PostPaymentIntentsIntentDecrementAuthorization","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The updated total amount that you intend to collect from the cardholder. This amount must be smaller than the currently authorized amount and greater than the already captured amount."},"amount_details":{"title":"amount_details_param","type":"object","properties":{"discount_amount":{"description":"The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"enforce_arithmetic_validation":{"type":"boolean","description":"Set to `false` to return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.\n\nOmit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.\n\nFor card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error."},"line_items":{"description":"A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.","anyOf":[{"type":"array","items":{"title":"amount_details_line_item_param","required":["product_name","quantity","unit_cost"],"type":"object","properties":{"discount_amount":{"type":"integer","description":"The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[discount_amount]` field."},"payment_method_options":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"card":{"title":"payment_intent_amount_details_line_item_payment_method_options_param","type":"object","properties":{"commodity_code":{"maxLength":12,"type":"string","description":"Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on."}},"description":"This sub-hash contains line item details that are specific to the `card` payment method.","x-stripeMostCommon":["commodity_code","ev_charging","fleet_data"]},"card_present":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"commodity_code":{"maxLength":12,"type":"string","description":"Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on."}},"description":"This sub-hash contains line item details that are specific to the `card_present` payment method.","x-stripeMostCommon":["commodity_code"]},"klarna":{"title":"payment_intent_amount_details_line_item_payment_method_options_param","type":"object","properties":{"image_url":{"maxLength":4096,"type":"string","description":"URL to an image for the product. Max length, 4096 characters."},"product_url":{"maxLength":4096,"type":"string","description":"URL to the product page. Max length, 4096 characters."},"reference":{"maxLength":255,"type":"string","description":"Unique reference for this line item to correlate it with your system’s internal records. The field is displayed in the Klarna Consumer App if passed."},"subscription_reference":{"maxLength":255,"type":"string","description":"Reference for the subscription this line item is for."}},"description":"This sub-hash contains line item details that are specific to the `klarna` payment method.","x-stripeMostCommon":["image_url","product_url","reference","subscription_reference"]},"paypal":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"category":{"type":"string","description":"Type of the line item.","enum":["digital_goods","donation","physical_goods"]},"description":{"maxLength":127,"type":"string","description":"Description of the line item."},"sold_by":{"maxLength":127,"type":"string","description":"The Stripe account ID of the connected account that sells the item."}},"description":"This sub-hash contains line item details that are specific to the `paypal` payment method.","x-stripeMostCommon":["category","description","sold_by"]}},"description":"Payment method-specific information for line items.","x-stripeMostCommon":["card","card_present","dummy_auth_push","klarna","link","paypal"]},"product_code":{"maxLength":12,"type":"string","description":"The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long."},"product_name":{"maxLength":1024,"type":"string","description":"The product name of the line item. Required for L3 rates. At most 1024 characters long.\n\nFor Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters."},"quantity":{"type":"integer","description":"The quantity of items. Required for L3 rates. An integer greater than 0."},"tax":{"title":"amount_details_line_item_tax_param","required":["total_tax_amount"],"type":"object","properties":{"total_tax_amount":{"type":"integer","description":"The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field."}},"description":"Contains information about the tax on the item.","x-stripeMostCommon":["total_tax_amount"]},"unit_cost":{"type":"integer","description":"The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0."},"unit_of_measure":{"maxLength":12,"type":"string","description":"A unit of measure for the line item, such as gallons, feet, meters, etc."}},"x-stripeMostCommon":["discount_amount","payment_method_options","product_code","product_name","quantity","quantity_precision","tax","unit_cost","unit_cost_precision","unit_of_measure"]}},{"type":"string","enum":[""]}]},"shipping":{"description":"Contains information about the shipping portion of the amount.","anyOf":[{"title":"amount_details_shipping_param","type":"object","properties":{"amount":{"description":"If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"from_postal_code":{"description":"If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed.","anyOf":[{"maxLength":10,"type":"string"},{"type":"string","enum":[""]}]},"to_postal_code":{"description":"If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed.","anyOf":[{"maxLength":10,"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["amount","from_postal_code","to_postal_code"]},{"type":"string","enum":[""]}]},"surcharge":{"description":"Contains information about the surcharge portion of the amount.","anyOf":[{"title":"amount_details_surcharge_param","type":"object","properties":{"amount":{"description":"Portion of the amount that corresponds to a surcharge.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"enforce_validation":{"type":"string","description":"Indicate whether to enforce validations on the surcharge amount.","enum":["","automatic","disabled","enabled"]}},"x-stripeMostCommon":["amount","enforce_validation"]},{"type":"string","enum":[""]}]},"tax":{"description":"Contains information about the tax portion of the amount.","anyOf":[{"title":"amount_details_tax_param","required":["total_tax_amount"],"type":"object","properties":{"total_tax_amount":{"type":"integer","description":"The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."}},"x-stripeMostCommon":["total_tax_amount"]},{"type":"string","enum":[""]}]}},"description":"Provides industry-specific information about the amount.","x-stripeMostCommon":["discount_amount","enforce_arithmetic_validation","line_items","shipping","surcharge","tax","tip"]},"application_fee_amount":{"type":"integer","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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."},"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"hooks":{"title":"async_workflows_param","type":"object","properties":{"inputs":{"title":"async_workflows_inputs_param","type":"object","properties":{"tax":{"title":"async_workflows_inputs_tax_param","required":["calculation"],"type":"object","properties":{"calculation":{"description":"The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax arguments for automations","x-stripeMostCommon":["calculation"]}},"description":"Arguments passed in automations","x-stripeMostCommon":["tax"]}},"description":"Automations to be run during the PaymentIntent lifecycle","x-stripeMostCommon":["inputs"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_details":{"title":"payment_details_order_customer_reference_param","type":"object","properties":{"customer_reference":{"description":"A unique value to identify the customer. This field is available only for card payments.\n\nThis field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"order_reference":{"description":"A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.\n\nFor Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Provides industry-specific information about the charge."},"transfer_data":{"title":"transfer_data_update_auth_params","type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when a charge succeeds."}},"description":"The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).","x-stripeMostCommon":["amount"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","description","metadata"]},"encoding":{"amount_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"hooks":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"decrement_authorization_on_payment_intent"}},"/v1/payment_intents/{intent}/increment_authorization":{"post":{"summary":"Increment an authorization","description":"Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.
Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.
If the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.
\n\nLearn more about incremental authorizations with\nin-person payments and\nonline payments.
","operationId":"PostPaymentIntentsIntentIncrementAuthorization","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount."},"amount_details":{"title":"amount_details_param","type":"object","properties":{"discount_amount":{"description":"The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"enforce_arithmetic_validation":{"type":"boolean","description":"Set to `false` to return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.\n\nOmit or set to `true` to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.\n\nFor card payments, Stripe doesn't send line item data to card networks if there's an arithmetic validation error."},"line_items":{"description":"A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.","anyOf":[{"type":"array","items":{"title":"amount_details_line_item_param","required":["product_name","quantity","unit_cost"],"type":"object","properties":{"discount_amount":{"type":"integer","description":"The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[discount_amount]` field."},"payment_method_options":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"card":{"title":"payment_intent_amount_details_line_item_payment_method_options_param","type":"object","properties":{"commodity_code":{"maxLength":12,"type":"string","description":"Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on."}},"description":"This sub-hash contains line item details that are specific to the `card` payment method.","x-stripeMostCommon":["commodity_code","ev_charging","fleet_data"]},"card_present":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"commodity_code":{"maxLength":12,"type":"string","description":"Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, and so on."}},"description":"This sub-hash contains line item details that are specific to the `card_present` payment method.","x-stripeMostCommon":["commodity_code"]},"klarna":{"title":"payment_intent_amount_details_line_item_payment_method_options_param","type":"object","properties":{"image_url":{"maxLength":4096,"type":"string","description":"URL to an image for the product. Max length, 4096 characters."},"product_url":{"maxLength":4096,"type":"string","description":"URL to the product page. Max length, 4096 characters."},"reference":{"maxLength":255,"type":"string","description":"Unique reference for this line item to correlate it with your system’s internal records. The field is displayed in the Klarna Consumer App if passed."},"subscription_reference":{"maxLength":255,"type":"string","description":"Reference for the subscription this line item is for."}},"description":"This sub-hash contains line item details that are specific to the `klarna` payment method.","x-stripeMostCommon":["image_url","product_url","reference","subscription_reference"]},"paypal":{"title":"amount_details_line_item_payment_method_options_param","type":"object","properties":{"category":{"type":"string","description":"Type of the line item.","enum":["digital_goods","donation","physical_goods"]},"description":{"maxLength":127,"type":"string","description":"Description of the line item."},"sold_by":{"maxLength":127,"type":"string","description":"The Stripe account ID of the connected account that sells the item."}},"description":"This sub-hash contains line item details that are specific to the `paypal` payment method.","x-stripeMostCommon":["category","description","sold_by"]}},"description":"Payment method-specific information for line items.","x-stripeMostCommon":["card","card_present","dummy_auth_push","klarna","link","paypal"]},"product_code":{"maxLength":12,"type":"string","description":"The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long."},"product_name":{"maxLength":1024,"type":"string","description":"The product name of the line item. Required for L3 rates. At most 1024 characters long.\n\nFor Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters."},"quantity":{"type":"integer","description":"The quantity of items. Required for L3 rates. An integer greater than 0."},"tax":{"title":"amount_details_line_item_tax_param","required":["total_tax_amount"],"type":"object","properties":{"total_tax_amount":{"type":"integer","description":"The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field."}},"description":"Contains information about the tax on the item.","x-stripeMostCommon":["total_tax_amount"]},"unit_cost":{"type":"integer","description":"The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0."},"unit_of_measure":{"maxLength":12,"type":"string","description":"A unit of measure for the line item, such as gallons, feet, meters, etc."}},"x-stripeMostCommon":["discount_amount","payment_method_options","product_code","product_name","quantity","quantity_precision","tax","unit_cost","unit_cost_precision","unit_of_measure"]}},{"type":"string","enum":[""]}]},"shipping":{"description":"Contains information about the shipping portion of the amount.","anyOf":[{"title":"amount_details_shipping_param","type":"object","properties":{"amount":{"description":"If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"from_postal_code":{"description":"If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed.","anyOf":[{"maxLength":10,"type":"string"},{"type":"string","enum":[""]}]},"to_postal_code":{"description":"If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed.","anyOf":[{"maxLength":10,"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["amount","from_postal_code","to_postal_code"]},{"type":"string","enum":[""]}]},"surcharge":{"description":"Contains information about the surcharge portion of the amount.","anyOf":[{"title":"amount_details_surcharge_param","type":"object","properties":{"amount":{"description":"Portion of the amount that corresponds to a surcharge.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"enforce_validation":{"type":"string","description":"Indicate whether to enforce validations on the surcharge amount.","enum":["","automatic","disabled","enabled"]}},"x-stripeMostCommon":["amount","enforce_validation"]},{"type":"string","enum":[""]}]},"tax":{"description":"Contains information about the tax portion of the amount.","anyOf":[{"title":"amount_details_tax_param","required":["total_tax_amount"],"type":"object","properties":{"total_tax_amount":{"type":"integer","description":"The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."}},"x-stripeMostCommon":["total_tax_amount"]},{"type":"string","enum":[""]}]}},"description":"Provides industry-specific information about the amount.","x-stripeMostCommon":["discount_amount","enforce_arithmetic_validation","line_items","shipping","surcharge","tax","tip"]},"application_fee_amount":{"type":"integer","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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."},"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"hooks":{"title":"async_workflows_param","type":"object","properties":{"inputs":{"title":"async_workflows_inputs_param","type":"object","properties":{"tax":{"title":"async_workflows_inputs_tax_param","required":["calculation"],"type":"object","properties":{"calculation":{"description":"The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax arguments for automations","x-stripeMostCommon":["calculation"]}},"description":"Arguments passed in automations","x-stripeMostCommon":["tax"]}},"description":"Automations to be run during the PaymentIntent lifecycle","x-stripeMostCommon":["inputs"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_details":{"title":"payment_details_order_customer_reference_param","type":"object","properties":{"customer_reference":{"description":"A unique value to identify the customer. This field is available only for card payments.\n\nThis field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"order_reference":{"description":"A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.\n\nFor Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Provides industry-specific information about the charge."},"payment_method_options":{"title":"payment_method_options_increment_authorization_param","type":"object","properties":{"card":{"title":"payment_intent_increment_authorization_param","type":"object","properties":{"request_partial_authorization":{"type":"string","description":"Request partial authorization on this PaymentIntent.","enum":["if_available","never"]}},"description":"Configuration for any card payments attempted on this PaymentIntent.","x-stripeMostCommon":["request_partial_authorization"]}},"description":"Payment method-specific configuration for this PaymentIntent.","x-stripeMostCommon":["card"]},"statement_descriptor":{"maxLength":22,"type":"string","description":"Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors)."},"transfer_data":{"title":"transfer_data_update_auth_params","type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when a charge succeeds."}},"description":"The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).","x-stripeMostCommon":["amount"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","description","metadata","statement_descriptor"]},"encoding":{"amount_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"hooks":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"increment_authorization_on_payment_intent"}},"/v1/payment_intents/{intent}/verify_microdeposits":{"post":{"summary":"Verify microdeposits on a PaymentIntent","description":"Verifies microdeposits on a PaymentIntent object.
","operationId":"PostPaymentIntentsIntentVerifyMicrodeposits","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amounts":{"type":"array","description":"Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.","items":{"type":"integer"}},"descriptor_code":{"maxLength":5000,"type":"string","description":"A six-character code starting with SM present in the microdeposit sent to the bank account."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["amounts","descriptor_code"]},"encoding":{"amounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"verify_payment_intent_microdeposits_via_secret_key"}},"/v1/payment_links":{"get":{"summary":"List all payment links","description":"Returns a list of your payment links.
","operationId":"GetPaymentLinks","parameters":[{"name":"active","in":"query","description":"Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentLinksResourcePaymentLinkList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_link"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/payment_links","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_links"},"post":{"summary":"Create a payment link","description":"Creates a payment link.
","operationId":"PostPaymentLinks","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["line_items"],"type":"object","properties":{"after_completion":{"title":"after_completion_params","required":["type"],"type":"object","properties":{"hosted_confirmation":{"title":"after_completion_confirmation_page_params","type":"object","properties":{"custom_message":{"maxLength":500,"type":"string","description":"A custom message to display to the customer after the purchase is complete."}},"description":"Configuration when `type=hosted_confirmation`.","x-stripeMostCommon":["custom_message"]},"redirect":{"title":"after_completion_redirect_params","required":["url"],"type":"object","properties":{"url":{"type":"string","description":"The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included."}},"description":"Configuration when `type=redirect`.","x-stripeMostCommon":["url"]},"type":{"type":"string","description":"The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.","enum":["hosted_confirmation","redirect"]}},"description":"Behavior after the purchase is complete.","x-stripeMostCommon":["hosted_confirmation","redirect","type"]},"allow_promotion_codes":{"type":"boolean","description":"Enables user redeemable promotion codes."},"application_fee_amount":{"type":"integer","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."},"application_fee_percent":{"type":"number","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":{"title":"automatic_tax_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes the payment link to collect any billing address information necessary for tax calculation."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Configuration for automatic tax collection.","x-stripeMostCommon":["enabled","liability"]},"billing_address_collection":{"type":"string","description":"Configuration for collecting the customer's billing address. Defaults to `auto`.","enum":["auto","required"]},"consent_collection":{"title":"consent_collection_params","type":"object","properties":{"payment_method_reuse_agreement":{"title":"payment_method_reuse_agreement_params","required":["position"],"type":"object","properties":{"position":{"type":"string","description":"Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.","enum":["auto","hidden"]}},"description":"Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.","x-stripeMostCommon":["position"]},"promotions":{"type":"string","description":"If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants and US customers.","enum":["auto","none"]},"terms_of_service":{"type":"string","description":"If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).","enum":["none","required"]}},"description":"Configure fields to gather active consent from customers.","x-stripeMostCommon":["payment_method_reuse_agreement","promotions","terms_of_service"]},"currency":{"type":"string","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.","format":"currency"},"custom_fields":{"type":"array","description":"Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `elements`.","items":{"title":"custom_field_param","required":["key","label","type"],"type":"object","properties":{"dropdown":{"title":"custom_field_dropdown_param","required":["options"],"type":"object","properties":{"default_value":{"maxLength":100,"type":"string","description":"The value that pre-fills the field on the payment page. Must match a `value` in the `options` array."},"options":{"type":"array","description":"The options available for the customer to select. Up to 200 options allowed.","items":{"title":"custom_field_option_param","required":["label","value"],"type":"object","properties":{"label":{"maxLength":100,"type":"string","description":"The label for the option, displayed to the customer. Up to 100 characters."},"value":{"maxLength":100,"type":"string","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."}},"x-stripeMostCommon":["label","value"]}}},"description":"Configuration for `type=dropdown` fields.","x-stripeMostCommon":["default_value","options"]},"key":{"maxLength":200,"type":"string","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."},"label":{"title":"custom_field_label_param","required":["custom","type"],"type":"object","properties":{"custom":{"maxLength":100,"type":"string","description":"Custom text for the label, displayed to the customer. Up to 100 characters."},"type":{"type":"string","description":"The type of the label.","enum":["custom"]}},"description":"The label for the field, displayed to the customer.","x-stripeMostCommon":["custom","type"]},"numeric":{"title":"custom_field_numeric_param","type":"object","properties":{"default_value":{"maxLength":255,"type":"string","description":"The value that pre-fills the field on the payment page."},"maximum_length":{"type":"integer","description":"The maximum character length constraint for the customer's input."},"minimum_length":{"type":"integer","description":"The minimum character length requirement for the customer's input."}},"description":"Configuration for `type=numeric` fields.","x-stripeMostCommon":["default_value","maximum_length","minimum_length"]},"optional":{"type":"boolean","description":"Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."},"text":{"title":"custom_field_text_param","type":"object","properties":{"default_value":{"maxLength":255,"type":"string","description":"The value that pre-fills the field on the payment page."},"maximum_length":{"type":"integer","description":"The maximum character length constraint for the customer's input."},"minimum_length":{"type":"integer","description":"The minimum character length requirement for the customer's input."}},"description":"Configuration for `type=text` fields.","x-stripeMostCommon":["default_value","maximum_length","minimum_length"]},"type":{"type":"string","description":"The type of the field.","enum":["dropdown","numeric","text"]}},"x-stripeMostCommon":["dropdown","key","label","numeric","optional","text","type"]}},"custom_text":{"title":"custom_text_param","type":"object","properties":{"after_submit":{"description":"Custom text that should be displayed after the payment confirmation button.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"shipping_address":{"description":"Custom text that should be displayed alongside shipping address collection.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"submit":{"description":"Custom text that should be displayed alongside the payment confirmation button.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"terms_of_service_acceptance":{"description":"Custom text that should be displayed in place of the default terms of service agreement text.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]}},"description":"Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `elements`.","x-stripeMostCommon":["after_submit","shipping_address","submit","terms_of_service_acceptance"]},"customer_creation":{"type":"string","description":"Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).","enum":["always","if_required"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"inactive_message":{"maxLength":500,"type":"string","description":"The custom message to be displayed to a customer when a payment link is no longer active."},"invoice_creation":{"title":"invoice_creation_create_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled"},"invoice_data":{"title":"invoice_settings_params","type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the invoice.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"description":"Default custom fields to be displayed on invoices for this customer.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"description":{"maxLength":1500,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"footer":{"maxLength":5000,"type":"string","description":"Default footer to be displayed on invoices for this customer."},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"rendering_options":{"description":"Default options for invoice PDF rendering for this customer.","anyOf":[{"title":"checkout_rendering_options_param","type":"object","properties":{"amount_tax_display":{"type":"string","description":"How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.","enum":["","exclude_tax","include_inclusive_tax"]},"template":{"maxLength":5000,"type":"string","description":"ID of the invoice rendering template to use for this invoice."}},"x-stripeMostCommon":["amount_tax_display","currency_display","invoice_title","template"]},{"type":"string","enum":[""]}]}},"description":"Invoice PDF configuration.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer","metadata","rendering_options"]}},"description":"Generate a post-purchase Invoice for one-time payments.","x-stripeMostCommon":["enabled","invoice_data"]},"line_items":{"type":"array","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":{"title":"line_items_create_params","required":["quantity"],"type":"object","properties":{"adjustable_quantity":{"title":"adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative Integer."},"maximum":{"type":"integer","description":"The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999."},"minimum":{"type":"integer","description":"The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0."}},"description":"When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.","x-stripeMostCommon":["enabled","maximum","minimum"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required."},"price_data":{"title":"custom_amount_price_data_with_product_data","required":["currency"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required."},"product_data":{"title":"product_data","required":["name"],"type":"object","properties":{"description":{"maxLength":40000,"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."},"images":{"type":"array","description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"description":"Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.","x-stripeMostCommon":["description","images","metadata","name","tax_code","tax_details","unit_label"]},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"The quantity of the line item being purchased."}},"x-stripeMostCommon":["adjustable_quantity","price","price_data","quantity"]}},"managed_payments":{"title":"managed_payments_params","type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session."}},"description":"Settings for Managed Payments for this Payment Link and resulting [CheckoutSessions](/api/checkout/sessions/object), [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object).","x-stripeMostCommon":["enabled"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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://docs.stripe.com/api/checkout/sessions) created by this payment link."},"name_collection":{"title":"name_collection_params","type":"object","properties":{"business":{"title":"name_collection_business_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable business name collection on the payment link. Defaults to `false`."},"optional":{"type":"boolean","description":"Whether the customer is required to provide their business name before checking out. Defaults to `false`."}},"description":"Controls settings applied for collecting the customer's business name.","x-stripeMostCommon":["enabled","optional"]},"individual":{"title":"name_collection_individual_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable individual name collection on the payment link. Defaults to `false`."},"optional":{"type":"boolean","description":"Whether the customer is required to provide their full name before checking out. Defaults to `false`."}},"description":"Controls settings applied for collecting the customer's individual name.","x-stripeMostCommon":["enabled","optional"]}},"description":"Controls settings applied for collecting the customer's name.","x-stripeMostCommon":["business","individual"]},"on_behalf_of":{"type":"string","description":"The account on behalf of which to charge."},"optional_items":{"type":"array","description":"A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).\nThere is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.\nThere is a maximum of 20 combined line items and optional items.","items":{"title":"optional_item_params","required":["price","quantity"],"type":"object","properties":{"adjustable_quantity":{"title":"optional_item_adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative integer."},"maximum":{"type":"integer","description":"The maximum quantity of this item the customer can purchase. By default this value is 99."},"minimum":{"type":"integer","description":"The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0."}},"description":"When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.","x-stripeMostCommon":["enabled","maximum","minimum"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object."},"quantity":{"type":"integer","description":"The initial quantity of the line item created when a customer chooses to add this optional item to their order."}},"x-stripeMostCommon":["adjustable_quantity","price","quantity"]}},"payment_intent_data":{"title":"payment_intent_data_params","type":"object","properties":{"capture_method":{"type":"string","description":"Controls when the funds will be captured from the customer's account.","enum":["automatic","automatic_async","manual"]},"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.","enum":["off_session","on_session"]},"statement_descriptor":{"maxLength":22,"type":"string","description":"Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."},"statement_descriptor_suffix":{"maxLength":22,"type":"string","description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."},"transfer_group":{"maxLength":5000,"type":"string","description":"A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details."}},"description":"A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.","x-stripeMostCommon":["capture_method","description","metadata","setup_future_usage","statement_descriptor","statement_descriptor_suffix","transfer_group"]},"payment_method_collection":{"type":"string","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.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf 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://docs.stripe.com/payments/checkout/free-trials).","enum":["always","if_required"],"x-stripeBypassValidation":true},"payment_method_options":{"title":"payment_method_options_params","type":"object","properties":{"card":{"title":"card_payment_method_options_params","type":"object","properties":{"restrictions":{"title":"card_restrictions_params","type":"object","properties":{"brands_blocked":{"type":"array","description":"The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.","items":{"type":"string","enum":["american_express","discover_global_network","mastercard","visa"]}}},"description":"Restrictions to apply to the card payment method. For example, you can block specific card brands.","x-stripeMostCommon":["brands_blocked"]}},"description":"Configuration for `card` payment methods.","x-stripeMostCommon":["restrictions"]}},"description":"Payment-method-specific configuration.","x-stripeMostCommon":["card"]},"payment_method_types":{"type":"array","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://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support)).","items":{"type":"string","enum":["affirm","afterpay_clearpay","alipay","alma","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","eps","fpx","giropay","gopay","grabpay","ideal","klarna","konbini","link","mb_way","mobilepay","multibanco","oxxo","p24","pay_by_bank","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","satispay","sepa_debit","sequra","shopeepay","sofort","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}},"phone_number_collection":{"title":"phone_number_collection_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable phone number collection."}},"description":"Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.","x-stripeMostCommon":["enabled"]},"restrictions":{"title":"restrictions_params","required":["completed_sessions"],"type":"object","properties":{"completed_sessions":{"title":"completed_sessions_params","required":["limit"],"type":"object","properties":{"limit":{"type":"integer","description":"The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met."}},"description":"Configuration for the `completed_sessions` restriction type.","x-stripeMostCommon":["limit"]}},"description":"Settings that restrict the usage of a payment link.","x-stripeMostCommon":["completed_sessions"]},"shipping_address_collection":{"title":"shipping_address_collection_params","required":["allowed_countries"],"type":"object","properties":{"allowed_countries":{"type":"array","description":"An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations.","items":{"type":"string","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","SD","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"]}}},"description":"Configuration for collecting the customer's shipping address.","x-stripeMostCommon":["allowed_countries"]},"shipping_options":{"type":"array","description":"The shipping rate options to apply to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.","items":{"title":"shipping_option_params","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the Shipping Rate to use for this shipping option."}},"x-stripeMostCommon":["shipping_rate"]}},"submit_type":{"type":"string","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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).","enum":["auto","book","donate","pay","subscribe"]},"subscription_data":{"title":"subscription_data_params","type":"object","properties":{"description":{"maxLength":500,"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."},"invoice_settings":{"title":"subscription_data_invoice_settings_params","type":"object","properties":{"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."},"trial_period_days":{"type":"integer","description":"Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1."},"trial_settings":{"title":"trial_settings_config","required":["end_behavior"],"type":"object","properties":{"end_behavior":{"title":"end_behavior","required":["missing_payment_method"],"type":"object","properties":{"missing_payment_method":{"type":"string","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"]}},"description":"Defines how the subscription should behave when the user's free trial ends.","x-stripeMostCommon":["billing_cycle_anchor","missing_payment_method"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"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`.","x-stripeMostCommon":["description","invoice_settings","metadata","trial_period_days","trial_settings"]},"tax_id_collection":{"title":"tax_id_collection_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable tax ID collection during checkout. Defaults to `false`."},"required":{"type":"string","description":"Describes whether a tax ID is required during checkout. Defaults to `never`. You can't set this parameter if `ui_mode` is `elements`.","enum":["if_supported","never"]}},"description":"Controls tax ID collection during checkout.","x-stripeMostCommon":["enabled","required"]},"transfer_data":{"title":"transfer_data_params","required":["destination"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when a charge succeeds."},"destination":{"type":"string","description":"If specified, successful charges will be attributed to the destination\naccount for tax reporting, and the funds from charges will be transferred\nto the destination account. The ID of the resulting transfer will be\nreturned on the successful charge's `transfer` field."}},"description":"The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.","x-stripeMostCommon":["amount","destination"]}},"additionalProperties":false,"x-stripeMostCommon":["line_items","metadata"]},"encoding":{"after_completion":{"style":"deepObject","explode":true},"automatic_tax":{"style":"deepObject","explode":true},"consent_collection":{"style":"deepObject","explode":true},"custom_fields":{"style":"deepObject","explode":true},"custom_text":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"invoice_creation":{"style":"deepObject","explode":true},"line_items":{"style":"deepObject","explode":true},"managed_payments":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"name_collection":{"style":"deepObject","explode":true},"optional_items":{"style":"deepObject","explode":true},"payment_intent_data":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true},"payment_method_types":{"style":"deepObject","explode":true},"phone_number_collection":{"style":"deepObject","explode":true},"restrictions":{"style":"deepObject","explode":true},"shipping_address_collection":{"style":"deepObject","explode":true},"shipping_options":{"style":"deepObject","explode":true},"subscription_data":{"style":"deepObject","explode":true},"tax_id_collection":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_payment_link"}},"/v1/payment_links/{payment_link}":{"get":{"summary":"Retrieve payment link","description":"Retrieve a payment link.
","operationId":"GetPaymentLinksPaymentLink","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"payment_link","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_link"},"post":{"summary":"Update a payment link","description":"Updates a payment link.
","operationId":"PostPaymentLinksPaymentLink","parameters":[{"name":"payment_link","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","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."},"after_completion":{"title":"after_completion_params","required":["type"],"type":"object","properties":{"hosted_confirmation":{"title":"after_completion_confirmation_page_params","type":"object","properties":{"custom_message":{"maxLength":500,"type":"string","description":"A custom message to display to the customer after the purchase is complete."}},"description":"Configuration when `type=hosted_confirmation`.","x-stripeMostCommon":["custom_message"]},"redirect":{"title":"after_completion_redirect_params","required":["url"],"type":"object","properties":{"url":{"type":"string","description":"The URL the customer will be redirected to after the purchase is complete. You can embed `{CHECKOUT_SESSION_ID}` into the URL to have the `id` of the completed [checkout session](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-id) included."}},"description":"Configuration when `type=redirect`.","x-stripeMostCommon":["url"]},"type":{"type":"string","description":"The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.","enum":["hosted_confirmation","redirect"]}},"description":"Behavior after the purchase is complete.","x-stripeMostCommon":["hosted_confirmation","redirect","type"]},"allow_promotion_codes":{"type":"boolean","description":"Enables user redeemable promotion codes."},"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.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"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.","anyOf":[{"type":"number"},{"type":"string","enum":[""]}]},"automatic_tax":{"title":"automatic_tax_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.\n\nEnabling this parameter causes the payment link to collect any billing address information necessary for tax calculation."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Configuration for automatic tax collection.","x-stripeMostCommon":["enabled","liability"]},"billing_address_collection":{"type":"string","description":"Configuration for collecting the customer's billing address. Defaults to `auto`.","enum":["auto","required"]},"consent_collection":{"title":"consent_collection_params","type":"object","properties":{"payment_method_reuse_agreement":{"title":"payment_method_reuse_agreement_params","required":["position"],"type":"object","properties":{"position":{"type":"string","description":"Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.","enum":["auto","hidden"]}},"description":"Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.","x-stripeMostCommon":["position"]},"promotions":{"type":"string","description":"If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants and US customers.","enum":["auto","none"]},"terms_of_service":{"type":"string","description":"If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.\nThere must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).","enum":["none","required"]}},"description":"Configure fields to gather active consent from customers.","x-stripeMostCommon":["payment_method_reuse_agreement","promotions","terms_of_service"]},"custom_fields":{"description":"Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `elements`.","anyOf":[{"type":"array","items":{"title":"custom_field_param","required":["key","label","type"],"type":"object","properties":{"dropdown":{"title":"custom_field_dropdown_param","required":["options"],"type":"object","properties":{"default_value":{"maxLength":100,"type":"string","description":"The value that pre-fills the field on the payment page. Must match a `value` in the `options` array."},"options":{"type":"array","description":"The options available for the customer to select. Up to 200 options allowed.","items":{"title":"custom_field_option_param","required":["label","value"],"type":"object","properties":{"label":{"maxLength":100,"type":"string","description":"The label for the option, displayed to the customer. Up to 100 characters."},"value":{"maxLength":100,"type":"string","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."}},"x-stripeMostCommon":["label","value"]}}},"description":"Configuration for `type=dropdown` fields.","x-stripeMostCommon":["default_value","options"]},"key":{"maxLength":200,"type":"string","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."},"label":{"title":"custom_field_label_param","required":["custom","type"],"type":"object","properties":{"custom":{"maxLength":100,"type":"string","description":"Custom text for the label, displayed to the customer. Up to 100 characters."},"type":{"type":"string","description":"The type of the label.","enum":["custom"]}},"description":"The label for the field, displayed to the customer.","x-stripeMostCommon":["custom","type"]},"numeric":{"title":"custom_field_numeric_param","type":"object","properties":{"default_value":{"maxLength":255,"type":"string","description":"The value that pre-fills the field on the payment page."},"maximum_length":{"type":"integer","description":"The maximum character length constraint for the customer's input."},"minimum_length":{"type":"integer","description":"The minimum character length requirement for the customer's input."}},"description":"Configuration for `type=numeric` fields.","x-stripeMostCommon":["default_value","maximum_length","minimum_length"]},"optional":{"type":"boolean","description":"Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."},"text":{"title":"custom_field_text_param","type":"object","properties":{"default_value":{"maxLength":255,"type":"string","description":"The value that pre-fills the field on the payment page."},"maximum_length":{"type":"integer","description":"The maximum character length constraint for the customer's input."},"minimum_length":{"type":"integer","description":"The minimum character length requirement for the customer's input."}},"description":"Configuration for `type=text` fields.","x-stripeMostCommon":["default_value","maximum_length","minimum_length"]},"type":{"type":"string","description":"The type of the field.","enum":["dropdown","numeric","text"]}},"x-stripeMostCommon":["dropdown","key","label","numeric","optional","text","type"]}},{"type":"string","enum":[""]}]},"custom_text":{"title":"custom_text_param","type":"object","properties":{"after_submit":{"description":"Custom text that should be displayed after the payment confirmation button.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"shipping_address":{"description":"Custom text that should be displayed alongside shipping address collection.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"submit":{"description":"Custom text that should be displayed alongside the payment confirmation button.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]},"terms_of_service_acceptance":{"description":"Custom text that should be displayed in place of the default terms of service agreement text.","anyOf":[{"title":"custom_text_position_param","required":["message"],"type":"object","properties":{"message":{"maxLength":1200,"type":"string","description":"Text can be up to 1200 characters in length."}},"x-stripeMostCommon":["message"]},{"type":"string","enum":[""]}]}},"description":"Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `elements`.","x-stripeMostCommon":["after_submit","shipping_address","submit","terms_of_service_acceptance"]},"customer_creation":{"type":"string","description":"Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers).","enum":["always","if_required"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"inactive_message":{"description":"The custom message to be displayed to a customer when a payment link is no longer active.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"invoice_creation":{"title":"invoice_creation_update_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the feature is enabled"},"invoice_data":{"title":"invoice_settings_params","type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the invoice.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"description":"Default custom fields to be displayed on invoices for this customer.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"description":{"maxLength":1500,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"footer":{"maxLength":5000,"type":"string","description":"Default footer to be displayed on invoices for this customer."},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"rendering_options":{"description":"Default options for invoice PDF rendering for this customer.","anyOf":[{"title":"checkout_rendering_options_param","type":"object","properties":{"amount_tax_display":{"type":"string","description":"How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.","enum":["","exclude_tax","include_inclusive_tax"]},"template":{"maxLength":5000,"type":"string","description":"ID of the invoice rendering template to use for this invoice."}},"x-stripeMostCommon":["amount_tax_display","currency_display","invoice_title","template"]},{"type":"string","enum":[""]}]}},"description":"Invoice PDF configuration.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer","metadata","rendering_options"]}},"description":"Generate a post-purchase Invoice for one-time payments.","x-stripeMostCommon":["enabled","invoice_data"]},"line_items":{"type":"array","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":{"title":"line_items_update_params","required":["id"],"type":"object","properties":{"adjustable_quantity":{"title":"adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative Integer."},"maximum":{"type":"integer","description":"The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999."},"minimum":{"type":"integer","description":"The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0."}},"description":"When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.","x-stripeMostCommon":["enabled","maximum","minimum"]},"id":{"maxLength":5000,"type":"string","description":"The ID of an existing line item on the payment link."},"quantity":{"type":"integer","description":"The quantity of the line item being purchased."}},"x-stripeMostCommon":["adjustable_quantity","id","price","quantity"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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://docs.stripe.com/api/checkout/sessions) created by this payment link."},"name_collection":{"description":"Controls settings applied for collecting the customer's name.","anyOf":[{"title":"name_collection_params","type":"object","properties":{"business":{"title":"name_collection_business_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable business name collection on the payment link. Defaults to `false`."},"optional":{"type":"boolean","description":"Whether the customer is required to provide their business name before checking out. Defaults to `false`."}},"description":"Controls settings applied for collecting the customer's business name.","x-stripeMostCommon":["enabled","optional"]},"individual":{"title":"name_collection_individual_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable individual name collection on the payment link. Defaults to `false`."},"optional":{"type":"boolean","description":"Whether the customer is required to provide their full name before checking out. Defaults to `false`."}},"description":"Controls settings applied for collecting the customer's individual name.","x-stripeMostCommon":["enabled","optional"]}},"x-stripeMostCommon":["business","individual"]},{"type":"string","enum":[""]}]},"on_behalf_of":{"description":"The account on behalf of which to charge.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"optional_items":{"description":"A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).\nThere is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.\nThere is a maximum of 20 combined line items and optional items.","anyOf":[{"type":"array","items":{"title":"optional_item_params","required":["price","quantity"],"type":"object","properties":{"adjustable_quantity":{"title":"optional_item_adjustable_quantity_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true if the quantity can be adjusted to any non-negative integer."},"maximum":{"type":"integer","description":"The maximum quantity of this item the customer can purchase. By default this value is 99."},"minimum":{"type":"integer","description":"The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0."}},"description":"When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.","x-stripeMostCommon":["enabled","maximum","minimum"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object."},"quantity":{"type":"integer","description":"The initial quantity of the line item created when a customer chooses to add this optional item to their order."}},"x-stripeMostCommon":["adjustable_quantity","price","quantity"]}},{"type":"string","enum":[""]}]},"payment_intent_data":{"title":"payment_intent_data_update_params","type":"object","properties":{"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":1000,"type":"string"},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.","enum":["","off_session","on_session"]},"statement_descriptor":{"description":"Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.","anyOf":[{"maxLength":22,"type":"string"},{"type":"string","enum":[""]}]},"statement_descriptor_suffix":{"description":"Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.","anyOf":[{"maxLength":22,"type":"string"},{"type":"string","enum":[""]}]},"transfer_group":{"description":"A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.","x-stripeMostCommon":["description","metadata","setup_future_usage","statement_descriptor","statement_descriptor_suffix","transfer_group"]},"payment_method_collection":{"type":"string","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.\n\nCan only be set in `subscription` mode. Defaults to `always`.\n\nIf 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://docs.stripe.com/payments/checkout/free-trials).","enum":["always","if_required"],"x-stripeBypassValidation":true},"payment_method_options":{"description":"Payment-method-specific configuration.","anyOf":[{"title":"payment_method_options_update_params","type":"object","properties":{"card":{"description":"Configuration for `card` payment methods.","anyOf":[{"title":"card_payment_method_options_update_params","type":"object","properties":{"restrictions":{"description":"Restrictions to apply to the card payment method. For example, you can block specific card brands.","anyOf":[{"title":"card_restrictions_update_params","type":"object","properties":{"brands_blocked":{"description":"The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.","anyOf":[{"type":"array","items":{"type":"string","enum":["american_express","discover_global_network","mastercard","visa"]}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["brands_blocked"]},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["restrictions"]},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["card"]},{"type":"string","enum":[""]}]},"payment_method_types":{"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).","anyOf":[{"type":"array","items":{"type":"string","enum":["affirm","afterpay_clearpay","alipay","alma","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","eps","fpx","giropay","gopay","grabpay","ideal","klarna","konbini","link","mb_way","mobilepay","multibanco","oxxo","p24","pay_by_bank","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","satispay","sepa_debit","sequra","shopeepay","sofort","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}},{"type":"string","enum":[""]}]},"phone_number_collection":{"title":"phone_number_collection_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Set to `true` to enable phone number collection."}},"description":"Controls phone number collection settings during checkout.\n\nWe recommend that you review your privacy policy and check with your legal contacts.","x-stripeMostCommon":["enabled"]},"restrictions":{"description":"Settings that restrict the usage of a payment link.","anyOf":[{"title":"restrictions_params","required":["completed_sessions"],"type":"object","properties":{"completed_sessions":{"title":"completed_sessions_params","required":["limit"],"type":"object","properties":{"limit":{"type":"integer","description":"The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met."}},"description":"Configuration for the `completed_sessions` restriction type.","x-stripeMostCommon":["limit"]}},"x-stripeMostCommon":["completed_sessions"]},{"type":"string","enum":[""]}]},"shipping_address_collection":{"description":"Configuration for collecting the customer's shipping address.","anyOf":[{"title":"shipping_address_collection_params","required":["allowed_countries"],"type":"object","properties":{"allowed_countries":{"type":"array","description":"An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations.","items":{"type":"string","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","SD","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"]}}},"x-stripeMostCommon":["allowed_countries"]},{"type":"string","enum":[""]}]},"shipping_options":{"description":"The shipping rate options to apply to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link.","anyOf":[{"type":"array","items":{"title":"shipping_option_params","type":"object","properties":{"shipping_rate":{"maxLength":5000,"type":"string","description":"The ID of the Shipping Rate to use for this shipping option."}},"x-stripeMostCommon":["shipping_rate"]}},{"type":"string","enum":[""]}]},"submit_type":{"type":"string","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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).","enum":["auto","book","donate","pay","subscribe"]},"subscription_data":{"title":"subscription_data_update_params","type":"object","properties":{"invoice_settings":{"title":"subscription_data_invoice_settings_params","type":"object","properties":{"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will declaratively set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"trial_period_days":{"description":"Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"trial_settings":{"description":"Settings related to subscription trials.","anyOf":[{"title":"trial_settings_config","required":["end_behavior"],"type":"object","properties":{"end_behavior":{"title":"end_behavior","required":["missing_payment_method"],"type":"object","properties":{"missing_payment_method":{"type":"string","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"]}},"description":"Defines how the subscription should behave when the user's free trial ends.","x-stripeMostCommon":["billing_cycle_anchor","missing_payment_method"]}},"x-stripeMostCommon":["end_behavior"]},{"type":"string","enum":[""]}]}},"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`.","x-stripeMostCommon":["invoice_settings","metadata","trial_period_days","trial_settings"]},"tax_id_collection":{"title":"tax_id_collection_params","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable tax ID collection during checkout. Defaults to `false`."},"required":{"type":"string","description":"Describes whether a tax ID is required during checkout. Defaults to `never`. You can't set this parameter if `ui_mode` is `elements`.","enum":["if_supported","never"]}},"description":"Controls tax ID collection during checkout.","x-stripeMostCommon":["enabled","required"]},"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.","anyOf":[{"title":"transfer_data_update_params","required":["destination"],"type":"object","properties":{"amount":{"description":"The amount that will be transferred automatically when a charge succeeds.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"destination":{"type":"string","description":"If specified, successful charges will be attributed to the destination\n account for tax reporting, and the funds from charges will be transferred\n to the destination account. The ID of the resulting transfer will be\n returned on the successful charge's `transfer` field."}},"x-stripeMostCommon":["amount","destination"]},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["active","line_items","metadata"]},"encoding":{"after_completion":{"style":"deepObject","explode":true},"application_fee_amount":{"style":"deepObject","explode":true},"application_fee_percent":{"style":"deepObject","explode":true},"automatic_tax":{"style":"deepObject","explode":true},"consent_collection":{"style":"deepObject","explode":true},"custom_fields":{"style":"deepObject","explode":true},"custom_text":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"inactive_message":{"style":"deepObject","explode":true},"invoice_creation":{"style":"deepObject","explode":true},"line_items":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"name_collection":{"style":"deepObject","explode":true},"on_behalf_of":{"style":"deepObject","explode":true},"optional_items":{"style":"deepObject","explode":true},"payment_intent_data":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true},"payment_method_types":{"style":"deepObject","explode":true},"phone_number_collection":{"style":"deepObject","explode":true},"restrictions":{"style":"deepObject","explode":true},"shipping_address_collection":{"style":"deepObject","explode":true},"shipping_options":{"style":"deepObject","explode":true},"subscription_data":{"style":"deepObject","explode":true},"tax_id_collection":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_link"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_payment_link"}},"/v1/payment_links/{payment_link}/line_items":{"get":{"summary":"Retrieve a payment link's line items","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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_link","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentLinksResourceListLineItems","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_link_line_items"}},"/v1/payment_method_configurations":{"get":{"summary":"List payment method configurations","description":"List payment method configurations
","operationId":"GetPaymentMethodConfigurations","parameters":[{"name":"active","in":"query","description":"Whether the configuration is active.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"application","in":"query","description":"The Connect application to filter by.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"string","enum":[""]}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentMethodConfigResourcePaymentMethodConfigurationsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_method_configuration"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/payment_method_configurations","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_method_configurations"},"post":{"summary":"Create a payment method configuration","description":"Creates a payment method configuration
","operationId":"PostPaymentMethodConfigurations","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"acss_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability.","x-stripeMostCommon":["display_preference"]},"affirm":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/affirm) for more details like country availability.","x-stripeMostCommon":["display_preference"]},"afterpay_clearpay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.","x-stripeMostCommon":["display_preference"]},"alipay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/alipay) for more details.","x-stripeMostCommon":["display_preference"]},"alma":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.","x-stripeMostCommon":["display_preference"]},"amazon_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.","x-stripeMostCommon":["display_preference"]},"apple_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users can accept [Apple Pay](https://stripe.com/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](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details.","x-stripeMostCommon":["display_preference"]},"apple_pay_later":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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.","x-stripeMostCommon":["display_preference"]},"au_becs_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/au-becs-debit) for more details.","x-stripeMostCommon":["display_preference"]},"bacs_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details.","x-stripeMostCommon":["display_preference"]},"bancontact":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/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://docs.stripe.com/payments/bancontact) for more details.","x-stripeMostCommon":["display_preference"]},"billie":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"bizum":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"To enable Bizum, buyers need a Spanish IBAN from a bank connected to Bizum. Within their banking app, they can enable Bizum and link their mobile number to their IBAN.","x-stripeMostCommon":["display_preference"]},"blik":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"BLIK is a [single use](https://docs.stripe.com/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://docs.stripe.com/payments/blik) for more details.","x-stripeMostCommon":["display_preference"]},"boleto":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details.","x-stripeMostCommon":["display_preference"]},"card":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.","x-stripeMostCommon":["display_preference"]},"cartes_bancaires":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/cartes-bancaires) for more details.","x-stripeMostCommon":["display_preference"]},"cashapp":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/cash-app-pay) for more details.","x-stripeMostCommon":["display_preference"]},"crypto":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"[Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask.","x-stripeMostCommon":["display_preference"]},"customer_balance":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Uses a customer’s [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details.","x-stripeMostCommon":["display_preference"]},"eps":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/eps) for more details.","x-stripeMostCommon":["display_preference"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fpx":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/fpx) for more details.","x-stripeMostCommon":["display_preference"]},"fr_meal_voucher_conecs":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) for more details.","x-stripeMostCommon":["display_preference"]},"giropay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/giropay) for more details.","x-stripeMostCommon":["display_preference"]},"google_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/google-pay) for more details.","x-stripeMostCommon":["display_preference"]},"gopay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"GoPay is a [single use](https://docs.stripe.com/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.","x-stripeMostCommon":["display_preference"]},"grabpay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/grabpay) for more details.","x-stripeMostCommon":["display_preference"]},"id_bank_transfer":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.","x-stripeMostCommon":["display_preference"]},"ideal":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/ideal) for more details.","x-stripeMostCommon":["display_preference"]},"jcb":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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.","x-stripeMostCommon":["display_preference"]},"kakao_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Kakao Pay is a popular local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"klarna":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Klarna gives customers a range of [payment options](https://docs.stripe.com/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://docs.stripe.com/payments/klarna) for more details.","x-stripeMostCommon":["display_preference"]},"konbini":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details.","x-stripeMostCommon":["display_preference"]},"kr_card":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Korean cards let users pay using locally issued cards from South Korea.","x-stripeMostCommon":["display_preference"]},"link":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"[Link](https://docs.stripe.com/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.","x-stripeMostCommon":["display_preference"]},"mb_way":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details.","x-stripeMostCommon":["display_preference"]},"mobilepay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details.","x-stripeMostCommon":["display_preference"]},"multibanco":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.","x-stripeMostCommon":["display_preference"]},"name":{"maxLength":100,"type":"string","description":"Configuration name."},"naver_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Naver Pay is a popular local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"nz_bank_account":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details.","x-stripeMostCommon":["display_preference"]},"oxxo":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/oxxo) for more details.","x-stripeMostCommon":["display_preference"]},"p24":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/p24) for more details.","x-stripeMostCommon":["display_preference"]},"parent":{"maxLength":100,"type":"string","description":"Configuration's parent configuration. Specify to create a child configuration."},"pay_by_bank":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.","x-stripeMostCommon":["display_preference"]},"payco":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"paynow":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/paynow) for more details.","x-stripeMostCommon":["display_preference"]},"paypal":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details.","x-stripeMostCommon":["display_preference"]},"paypay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Customers can pay with PayPay online or using the PayPay app.","x-stripeMostCommon":["display_preference"]},"payto":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.","x-stripeMostCommon":["display_preference"]},"pix":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.","x-stripeMostCommon":["display_preference"]},"promptpay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/promptpay) for more details.","x-stripeMostCommon":["display_preference"]},"qris":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.","x-stripeMostCommon":["display_preference"]},"revolut_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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.","x-stripeMostCommon":["display_preference"]},"samsung_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"satispay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Satispay is a [single-use](/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"scalapay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Scalapay is a [single-use](/payments/payment-methods#usage) payment method that lets customers pay in 3 or 4 installments. Customers are redirected from your website or app, authorize the payment with Scalapay, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"sepa_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/sepa-debit) for more details.","x-stripeMostCommon":["display_preference"]},"sequra":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"SeQura is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers customers payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with SeQura, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"shopeepay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"ShopeePay is a [single use](https://docs.stripe.com/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.","x-stripeMostCommon":["display_preference"]},"sofort":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/sofort) for more details.","x-stripeMostCommon":["display_preference"]},"sunbit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Sunbit is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers choose to pay in 3, 6, or 12 installments. Customers are redirected from your website or app, authorize the payment with Sunbit, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"swish":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details.","x-stripeMostCommon":["display_preference"]},"twint":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.","x-stripeMostCommon":["display_preference"]},"upi":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Unified Payment Interface (UPI) is India's leading payment method with exponential growth since it launched in 2016.","x-stripeMostCommon":["display_preference"]},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/ach-direct-debit) for more details.","x-stripeMostCommon":["display_preference"]},"wechat_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/wechat-pay) for more details.","x-stripeMostCommon":["display_preference"]},"zip":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability.","x-stripeMostCommon":["display_preference"]}},"additionalProperties":false,"x-stripeMostCommon":["name","parent"]},"encoding":{"acss_debit":{"style":"deepObject","explode":true},"affirm":{"style":"deepObject","explode":true},"afterpay_clearpay":{"style":"deepObject","explode":true},"alipay":{"style":"deepObject","explode":true},"alma":{"style":"deepObject","explode":true},"amazon_pay":{"style":"deepObject","explode":true},"apple_pay":{"style":"deepObject","explode":true},"apple_pay_later":{"style":"deepObject","explode":true},"au_becs_debit":{"style":"deepObject","explode":true},"bacs_debit":{"style":"deepObject","explode":true},"bancontact":{"style":"deepObject","explode":true},"billie":{"style":"deepObject","explode":true},"bizum":{"style":"deepObject","explode":true},"blik":{"style":"deepObject","explode":true},"boleto":{"style":"deepObject","explode":true},"card":{"style":"deepObject","explode":true},"cartes_bancaires":{"style":"deepObject","explode":true},"cashapp":{"style":"deepObject","explode":true},"crypto":{"style":"deepObject","explode":true},"customer_balance":{"style":"deepObject","explode":true},"eps":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"fpx":{"style":"deepObject","explode":true},"fr_meal_voucher_conecs":{"style":"deepObject","explode":true},"giropay":{"style":"deepObject","explode":true},"google_pay":{"style":"deepObject","explode":true},"gopay":{"style":"deepObject","explode":true},"grabpay":{"style":"deepObject","explode":true},"id_bank_transfer":{"style":"deepObject","explode":true},"ideal":{"style":"deepObject","explode":true},"jcb":{"style":"deepObject","explode":true},"kakao_pay":{"style":"deepObject","explode":true},"klarna":{"style":"deepObject","explode":true},"konbini":{"style":"deepObject","explode":true},"kr_card":{"style":"deepObject","explode":true},"link":{"style":"deepObject","explode":true},"mb_way":{"style":"deepObject","explode":true},"mobilepay":{"style":"deepObject","explode":true},"multibanco":{"style":"deepObject","explode":true},"naver_pay":{"style":"deepObject","explode":true},"nz_bank_account":{"style":"deepObject","explode":true},"oxxo":{"style":"deepObject","explode":true},"p24":{"style":"deepObject","explode":true},"pay_by_bank":{"style":"deepObject","explode":true},"payco":{"style":"deepObject","explode":true},"paynow":{"style":"deepObject","explode":true},"paypal":{"style":"deepObject","explode":true},"paypay":{"style":"deepObject","explode":true},"payto":{"style":"deepObject","explode":true},"pix":{"style":"deepObject","explode":true},"promptpay":{"style":"deepObject","explode":true},"qris":{"style":"deepObject","explode":true},"revolut_pay":{"style":"deepObject","explode":true},"samsung_pay":{"style":"deepObject","explode":true},"satispay":{"style":"deepObject","explode":true},"scalapay":{"style":"deepObject","explode":true},"sepa_debit":{"style":"deepObject","explode":true},"sequra":{"style":"deepObject","explode":true},"shopeepay":{"style":"deepObject","explode":true},"sofort":{"style":"deepObject","explode":true},"sunbit":{"style":"deepObject","explode":true},"swish":{"style":"deepObject","explode":true},"twint":{"style":"deepObject","explode":true},"upi":{"style":"deepObject","explode":true},"us_bank_account":{"style":"deepObject","explode":true},"wechat_pay":{"style":"deepObject","explode":true},"zip":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_configuration"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_payment_method_configuration"}},"/v1/payment_method_configurations/{configuration}":{"get":{"summary":"Retrieve payment method configuration","description":"Retrieve payment method configuration
","operationId":"GetPaymentMethodConfigurationsConfiguration","parameters":[{"name":"configuration","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_configuration"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_method_configuration"},"post":{"summary":"Update payment method configuration","description":"Update payment method configuration
","operationId":"PostPaymentMethodConfigurationsConfiguration","parameters":[{"name":"configuration","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"acss_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability.","x-stripeMostCommon":["display_preference"]},"active":{"type":"boolean","description":"Whether the configuration can be used for new payments."},"affirm":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/affirm) for more details like country availability.","x-stripeMostCommon":["display_preference"]},"afterpay_clearpay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.","x-stripeMostCommon":["display_preference"]},"alipay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/alipay) for more details.","x-stripeMostCommon":["display_preference"]},"alma":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.","x-stripeMostCommon":["display_preference"]},"amazon_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.","x-stripeMostCommon":["display_preference"]},"apple_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users can accept [Apple Pay](https://stripe.com/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](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details.","x-stripeMostCommon":["display_preference"]},"apple_pay_later":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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.","x-stripeMostCommon":["display_preference"]},"au_becs_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/au-becs-debit) for more details.","x-stripeMostCommon":["display_preference"]},"bacs_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details.","x-stripeMostCommon":["display_preference"]},"bancontact":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/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://docs.stripe.com/payments/bancontact) for more details.","x-stripeMostCommon":["display_preference"]},"billie":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"bizum":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"To enable Bizum, buyers need a Spanish IBAN from a bank connected to Bizum. Within their banking app, they can enable Bizum and link their mobile number to their IBAN.","x-stripeMostCommon":["display_preference"]},"blik":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"BLIK is a [single use](https://docs.stripe.com/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://docs.stripe.com/payments/blik) for more details.","x-stripeMostCommon":["display_preference"]},"boleto":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details.","x-stripeMostCommon":["display_preference"]},"card":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.","x-stripeMostCommon":["display_preference"]},"cartes_bancaires":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/cartes-bancaires) for more details.","x-stripeMostCommon":["display_preference"]},"cashapp":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/cash-app-pay) for more details.","x-stripeMostCommon":["display_preference"]},"crypto":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"[Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask.","x-stripeMostCommon":["display_preference"]},"customer_balance":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Uses a customer’s [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details.","x-stripeMostCommon":["display_preference"]},"eps":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/eps) for more details.","x-stripeMostCommon":["display_preference"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fpx":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/fpx) for more details.","x-stripeMostCommon":["display_preference"]},"fr_meal_voucher_conecs":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) for more details.","x-stripeMostCommon":["display_preference"]},"giropay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/giropay) for more details.","x-stripeMostCommon":["display_preference"]},"google_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/google-pay) for more details.","x-stripeMostCommon":["display_preference"]},"gopay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"GoPay is a [single use](https://docs.stripe.com/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Gojek app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Gojek app to confirm payment.","x-stripeMostCommon":["display_preference"]},"grabpay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/grabpay) for more details.","x-stripeMostCommon":["display_preference"]},"id_bank_transfer":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in Indonesia can receive bank transfers from customers in Indonesia. Bank transfers are a popular B2C and B2B payment method in Indonesia.","x-stripeMostCommon":["display_preference"]},"ideal":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/ideal) for more details.","x-stripeMostCommon":["display_preference"]},"jcb":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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.","x-stripeMostCommon":["display_preference"]},"kakao_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Kakao Pay is a popular local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"klarna":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Klarna gives customers a range of [payment options](https://docs.stripe.com/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://docs.stripe.com/payments/klarna) for more details.","x-stripeMostCommon":["display_preference"]},"konbini":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details.","x-stripeMostCommon":["display_preference"]},"kr_card":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Korean cards let users pay using locally issued cards from South Korea.","x-stripeMostCommon":["display_preference"]},"link":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"[Link](https://docs.stripe.com/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.","x-stripeMostCommon":["display_preference"]},"mb_way":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details.","x-stripeMostCommon":["display_preference"]},"mobilepay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details.","x-stripeMostCommon":["display_preference"]},"multibanco":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method.","x-stripeMostCommon":["display_preference"]},"name":{"maxLength":100,"type":"string","description":"Configuration name."},"naver_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Naver Pay is a popular local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"nz_bank_account":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details.","x-stripeMostCommon":["display_preference"]},"oxxo":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/oxxo) for more details.","x-stripeMostCommon":["display_preference"]},"p24":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/p24) for more details.","x-stripeMostCommon":["display_preference"]},"pay_by_bank":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments.","x-stripeMostCommon":["display_preference"]},"payco":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"paynow":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/paynow) for more details.","x-stripeMostCommon":["display_preference"]},"paypal":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details.","x-stripeMostCommon":["display_preference"]},"paypay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Customers can pay with PayPay online or using the PayPay app.","x-stripeMostCommon":["display_preference"]},"payto":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.","x-stripeMostCommon":["display_preference"]},"pix":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.","x-stripeMostCommon":["display_preference"]},"promptpay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/promptpay) for more details.","x-stripeMostCommon":["display_preference"]},"qris":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"QRIS is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Indonesia. When paying with QRIS, customers authenticate and approve payments by scanning a QR code in their preferred digital wallet app.","x-stripeMostCommon":["display_preference"]},"revolut_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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.","x-stripeMostCommon":["display_preference"]},"samsung_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea.","x-stripeMostCommon":["display_preference"]},"satispay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Satispay is a [single-use](/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"scalapay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Scalapay is a [single-use](/payments/payment-methods#usage) payment method that lets customers pay in 3 or 4 installments. Customers are redirected from your website or app, authorize the payment with Scalapay, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"sepa_debit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/sepa-debit) for more details.","x-stripeMostCommon":["display_preference"]},"sequra":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"SeQura is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers customers payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with SeQura, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"shopeepay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"ShopeePay is a [single use](https://docs.stripe.com/payments/payment-methods#usage) digital wallet payment method popular in Indonesia. When paying with GoPay, customers authenticate and approve payments using the Shopee app. Desktop checkout is performed by scanning a QR code. When checking out on mobile, customers are redirected to the Shopee app to confirm payment.","x-stripeMostCommon":["display_preference"]},"sofort":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/sofort) for more details.","x-stripeMostCommon":["display_preference"]},"sunbit":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Sunbit is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers choose to pay in 3, 6, or 12 installments. Customers are redirected from your website or app, authorize the payment with Sunbit, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.","x-stripeMostCommon":["display_preference"]},"swish":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details.","x-stripeMostCommon":["display_preference"]},"twint":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details.","x-stripeMostCommon":["display_preference"]},"upi":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Unified Payment Interface (UPI) is India's leading payment method with exponential growth since it launched in 2016.","x-stripeMostCommon":["display_preference"]},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/ach-direct-debit) for more details.","x-stripeMostCommon":["display_preference"]},"wechat_pay":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"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://docs.stripe.com/payments/wechat-pay) for more details.","x-stripeMostCommon":["display_preference"]},"zip":{"title":"payment_method_param","type":"object","properties":{"display_preference":{"title":"display_preference_param","type":"object","properties":{"preference":{"type":"string","description":"The account's preference for whether or not to display this payment method.","enum":["none","off","on"]}},"description":"Whether or not the payment method should be displayed.","x-stripeMostCommon":["preference"]}},"description":"Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability.","x-stripeMostCommon":["display_preference"]}},"additionalProperties":false,"x-stripeMostCommon":["active","name"]},"encoding":{"acss_debit":{"style":"deepObject","explode":true},"affirm":{"style":"deepObject","explode":true},"afterpay_clearpay":{"style":"deepObject","explode":true},"alipay":{"style":"deepObject","explode":true},"alma":{"style":"deepObject","explode":true},"amazon_pay":{"style":"deepObject","explode":true},"apple_pay":{"style":"deepObject","explode":true},"apple_pay_later":{"style":"deepObject","explode":true},"au_becs_debit":{"style":"deepObject","explode":true},"bacs_debit":{"style":"deepObject","explode":true},"bancontact":{"style":"deepObject","explode":true},"billie":{"style":"deepObject","explode":true},"bizum":{"style":"deepObject","explode":true},"blik":{"style":"deepObject","explode":true},"boleto":{"style":"deepObject","explode":true},"card":{"style":"deepObject","explode":true},"cartes_bancaires":{"style":"deepObject","explode":true},"cashapp":{"style":"deepObject","explode":true},"crypto":{"style":"deepObject","explode":true},"customer_balance":{"style":"deepObject","explode":true},"eps":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"fpx":{"style":"deepObject","explode":true},"fr_meal_voucher_conecs":{"style":"deepObject","explode":true},"giropay":{"style":"deepObject","explode":true},"google_pay":{"style":"deepObject","explode":true},"gopay":{"style":"deepObject","explode":true},"grabpay":{"style":"deepObject","explode":true},"id_bank_transfer":{"style":"deepObject","explode":true},"ideal":{"style":"deepObject","explode":true},"jcb":{"style":"deepObject","explode":true},"kakao_pay":{"style":"deepObject","explode":true},"klarna":{"style":"deepObject","explode":true},"konbini":{"style":"deepObject","explode":true},"kr_card":{"style":"deepObject","explode":true},"link":{"style":"deepObject","explode":true},"mb_way":{"style":"deepObject","explode":true},"mobilepay":{"style":"deepObject","explode":true},"multibanco":{"style":"deepObject","explode":true},"naver_pay":{"style":"deepObject","explode":true},"nz_bank_account":{"style":"deepObject","explode":true},"oxxo":{"style":"deepObject","explode":true},"p24":{"style":"deepObject","explode":true},"pay_by_bank":{"style":"deepObject","explode":true},"payco":{"style":"deepObject","explode":true},"paynow":{"style":"deepObject","explode":true},"paypal":{"style":"deepObject","explode":true},"paypay":{"style":"deepObject","explode":true},"payto":{"style":"deepObject","explode":true},"pix":{"style":"deepObject","explode":true},"promptpay":{"style":"deepObject","explode":true},"qris":{"style":"deepObject","explode":true},"revolut_pay":{"style":"deepObject","explode":true},"samsung_pay":{"style":"deepObject","explode":true},"satispay":{"style":"deepObject","explode":true},"scalapay":{"style":"deepObject","explode":true},"sepa_debit":{"style":"deepObject","explode":true},"sequra":{"style":"deepObject","explode":true},"shopeepay":{"style":"deepObject","explode":true},"sofort":{"style":"deepObject","explode":true},"sunbit":{"style":"deepObject","explode":true},"swish":{"style":"deepObject","explode":true},"twint":{"style":"deepObject","explode":true},"upi":{"style":"deepObject","explode":true},"us_bank_account":{"style":"deepObject","explode":true},"wechat_pay":{"style":"deepObject","explode":true},"zip":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_configuration"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_payment_method_configuration"}},"/v1/payment_method_domains":{"get":{"summary":"List payment method domains","description":"Lists the details of existing payment method domains.
","operationId":"GetPaymentMethodDomains","parameters":[{"name":"domain_name","in":"query","description":"The domain name that this payment method domain object represents.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"enabled","in":"query","description":"Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentMethodDomainResourcePaymentMethodDomainList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_method_domain"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/payment_method_domains","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_method_domain"},"post":{"summary":"Create a payment method domain","description":"Creates a payment method domain.
","operationId":"PostPaymentMethodDomains","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["domain_name"],"type":"object","properties":{"domain_name":{"maxLength":5000,"type":"string","description":"The domain name that this payment method domain object represents."},"enabled":{"type":"boolean","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 or Embedded Checkout."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["domain_name","enabled"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_payment_method_domain"}},"/v1/payment_method_domains/{payment_method_domain}":{"get":{"summary":"Retrieve a payment method domain","description":"Retrieves the details of an existing payment method domain.
","operationId":"GetPaymentMethodDomainsPaymentMethodDomain","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"payment_method_domain","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_method_domain"},"post":{"summary":"Update a payment method domain","description":"Updates an existing payment method domain.
","operationId":"PostPaymentMethodDomainsPaymentMethodDomain","parameters":[{"name":"payment_method_domain","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","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 or Embedded Checkout."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["enabled"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_payment_method_domain"}},"/v1/payment_method_domains/{payment_method_domain}/validate":{"post":{"summary":"Validate an existing payment method domain","description":"Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.\nThe payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active.
\n\nTo activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
\n\nRelated guides: Payment method domains.
","operationId":"PostPaymentMethodDomainsPaymentMethodDomainValidate","parameters":[{"name":"payment_method_domain","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method_domain"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"validate_payment_method_domain"}},"/v1/payment_methods":{"get":{"summary":"List PaymentMethods","description":"Returns a list of all PaymentMethods.
","operationId":"GetPaymentMethods","parameters":[{"name":"allow_redisplay","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["always","limited","unspecified"]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"The ID of the customer whose PaymentMethods will be retrieved.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"customer_account","in":"query","description":"The ID of the Account whose PaymentMethods will be retrieved.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"type","in":"query","description":"Filters the list by the object `type` field. Unfiltered, the list returns all payment method types except `custom`. If your integration expects only one type of payment method in the response, specify that type value in the request to reduce your payload.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","custom","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentFlowsPaymentMethodList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_method"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/payment_methods","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_methods"},"post":{"summary":"Create a PaymentMethod","description":"Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.
\n\nInstead 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":{"schema":{"type":"object","properties":{"acss_debit":{"title":"payment_method_param","required":["account_number","institution_number","transit_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Customer's bank account number."},"institution_number":{"maxLength":5000,"type":"string","description":"Institution number of the customer's bank."},"transit_number":{"maxLength":5000,"type":"string","description":"Transit number of the customer's bank."}},"description":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","x-stripeMostCommon":["account_number","financial_connections_account","institution_number","transit_number"]},"affirm":{"title":"param","type":"object","properties":{},"description":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method."},"afterpay_clearpay":{"title":"param","type":"object","properties":{},"description":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"alipay":{"title":"param","type":"object","properties":{},"description":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method."},"allow_redisplay":{"type":"string","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"]},"alma":{"title":"param","type":"object","properties":{},"description":"If this is an Alma PaymentMethod, this hash contains details about the Alma payment method."},"amazon_pay":{"title":"param","type":"object","properties":{},"description":"If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method."},"au_becs_debit":{"title":"param","required":["account_number","bsb_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."}},"description":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","x-stripeMostCommon":["account_number","bsb_number"]},"bacs_debit":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account that the funds will be debited from."},"sort_code":{"maxLength":5000,"type":"string","description":"Sort code of the bank account. (e.g., `10-20-30`)"}},"description":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","x-stripeMostCommon":["account_number","sort_code"]},"bancontact":{"title":"param","type":"object","properties":{},"description":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method."},"billie":{"title":"param","type":"object","properties":{},"description":"If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method."},"billing_details":{"title":"billing_details_inner_params","type":"object","properties":{"address":{"description":"Billing address.","anyOf":[{"title":"billing_details_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"email":{"description":"Email address.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"name":{"description":"Full name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"phone":{"description":"Billing phone number (including extension).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"tax_id":{"maxLength":5000,"type":"string","description":"Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone","tax_id"]},"bizum":{"title":"param","type":"object","properties":{},"description":"If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method."},"blik":{"title":"param","type":"object","properties":{},"description":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method."},"boleto":{"title":"param","required":["tax_id"],"type":"object","properties":{"tax_id":{"maxLength":5000,"type":"string","description":"The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)"}},"description":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","x-stripeMostCommon":["tax_id"]},"card":{"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.","anyOf":[{"title":"card_details_params","required":["exp_month","exp_year","number"],"type":"object","properties":{"cvc":{"maxLength":5000,"type":"string","description":"The card's CVC. It is highly recommended to always include this value."},"exp_month":{"type":"integer","description":"Two-digit number representing the card's expiration month."},"exp_year":{"type":"integer","description":"Four-digit number representing the card's expiration year."},"networks":{"title":"networks_params","type":"object","properties":{"preferred":{"type":"string","description":"The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.","enum":["cartes_bancaires","mastercard","visa"]}},"description":"Contains information about card networks used to process the payment.","x-stripeMostCommon":["preferred"]},"number":{"maxLength":5000,"type":"string","description":"The card number, as a string without any separators."}},"x-stripeMostCommon":["cvc","exp_month","exp_year","funding_options","networks","number","request_card_art_and_program_name","request_network_token"],"x-stripeParam":{"class_name":"CardDetails"}},{"title":"token_params","required":["token"],"type":"object","properties":{"token":{"maxLength":5000,"type":"string","description":"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\"}."}},"x-stripeMostCommon":["request_card_art_and_program_name","token"],"x-stripeParam":{"class_name":"Token"}}],"x-stripeBypassValidation":true},"cashapp":{"title":"param","type":"object","properties":{},"description":"If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method."},"crypto":{"title":"param","type":"object","properties":{},"description":"If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method."},"custom":{"title":"create_param","required":["type"],"type":"object","properties":{"type":{"maxLength":5000,"type":"string","description":"ID of the Dashboard-only CustomPaymentMethodType. This field is used by Stripe products' internal code to support CPMs."}},"description":"If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method.","x-stripeMostCommon":["type"]},"customer":{"maxLength":5000,"type":"string","description":"The `Customer` to whom the original PaymentMethod is attached."},"customer_balance":{"title":"param","type":"object","properties":{},"description":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method."},"eps":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's 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"]}},"description":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","x-stripeMostCommon":["bank"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fpx":{"title":"param","required":["bank"],"type":"object","properties":{"account_holder_type":{"maxLength":5000,"type":"string","description":"Account holder type for FPX transaction","enum":["company","individual"]},"bank":{"maxLength":5000,"type":"string","description":"The customer's bank.","enum":["affin_bank","agrobank","alliance_bank","ambank","bank_islam","bank_muamalat","bank_of_china","bank_rakyat","bnp_paribas","bsn","cimb","citibank","deutsche_bank","hong_leong_bank","hsbc","kfh","maybank2e","maybank2u","mbsb_bank","ocbc","pb_enterprise","public_bank","rhb","standard_chartered","uob"],"x-stripeBypassValidation":true}},"description":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","x-stripeMostCommon":["account_holder_type","bank"]},"giropay":{"title":"param","type":"object","properties":{},"description":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method."},"gopay":{"title":"param","type":"object","properties":{},"description":"If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method."},"grabpay":{"title":"param","type":"object","properties":{},"description":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method."},"id_bank_transfer":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"Bank where the account is held.","enum":["bca","bni","bri","cimb","permata"],"x-stripeBypassValidation":true}},"description":"If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.","x-stripeMostCommon":["bank"]},"ideal":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.","enum":["abn_amro","adyen","asn_bank","bunq","buut","finom","handelsbanken","ing","knab","mollie","moneyou","n26","nn","rabobank","regiobank","revolut","sns_bank","triodos_bank","van_lanschot","yoursafe"]}},"description":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","x-stripeMostCommon":["bank"]},"interac_present":{"title":"param","type":"object","properties":{},"description":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","x-stripeMostCommon":["device_identifier","device_type","emv","location"]},"kakao_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method."},"klarna":{"title":"param","type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","x-stripeMostCommon":["dob"]},"konbini":{"title":"param","type":"object","properties":{},"description":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method."},"kr_card":{"title":"param","type":"object","properties":{},"description":"If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method."},"link":{"title":"param","type":"object","properties":{},"description":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK)."},"mb_way":{"title":"param","type":"object","properties":{},"description":"If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"mobilepay":{"title":"param","type":"object","properties":{},"description":"If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method."},"multibanco":{"title":"param","type":"object","properties":{},"description":"If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method."},"naver_pay":{"title":"param","type":"object","properties":{"funding":{"type":"string","description":"Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.","enum":["card","points"],"x-stripeBypassValidation":true}},"description":"If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.","x-stripeMostCommon":["funding"]},"nz_bank_account":{"title":"param","required":["account_number","bank_code","branch_code","suffix"],"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."},"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bank_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank."},"branch_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank branch."},"reference":{"maxLength":128,"type":"string"},"suffix":{"maxLength":5000,"type":"string","description":"The suffix of the bank account number."}},"description":"If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.","x-stripeMostCommon":["account_holder_name","account_number","bank_code","branch_code","reference","suffix"]},"oxxo":{"title":"param","type":"object","properties":{},"description":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method."},"p24":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"The customer's 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"],"x-stripeBypassValidation":true}},"description":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","x-stripeMostCommon":["bank"]},"pay_by_bank":{"title":"param","type":"object","properties":{},"description":"If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method."},"payco":{"title":"param","type":"object","properties":{},"description":"If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method."},"payment_method":{"maxLength":5000,"type":"string","description":"The PaymentMethod to share."},"paynow":{"title":"param","type":"object","properties":{},"description":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method."},"paypal":{"title":"param","type":"object","properties":{},"description":"If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method."},"paypay":{"title":"param","type":"object","properties":{},"description":"If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method."},"payto":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."},"pay_id":{"maxLength":5000,"type":"string","description":"The PayID alias for the bank account."}},"description":"If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.","x-stripeMostCommon":["account_number","bsb_number","pay_id"]},"pix":{"title":"param","type":"object","properties":{},"description":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","x-stripeMostCommon":["tax_id"]},"promptpay":{"title":"param","type":"object","properties":{},"description":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method."},"qris":{"title":"param","type":"object","properties":{},"description":"If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method."},"radar_options":{"title":"radar_options_with_hidden_options","type":"object","properties":{"session":{"maxLength":5000,"type":"string","description":"A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."}},"description":"Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.","x-stripeMostCommon":["session","skip_rules"]},"rechnung":{"title":"param","required":["dob"],"type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.","x-stripeMostCommon":["dob"]},"revolut_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method."},"samsung_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method."},"satispay":{"title":"param","type":"object","properties":{},"description":"If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method."},"scalapay":{"title":"param","type":"object","properties":{},"description":"If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method."},"sepa_debit":{"title":"param","required":["iban"],"type":"object","properties":{"iban":{"maxLength":5000,"type":"string","description":"IBAN of the bank account."}},"description":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","x-stripeMostCommon":["iban"]},"sequra":{"title":"param","type":"object","properties":{},"description":"If this is a SeQura PaymentMethod, this hash contains details about the SeQura payment method."},"shopeepay":{"title":"param","type":"object","properties":{},"description":"If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method."},"sofort":{"title":"param","required":["country"],"type":"object","properties":{"country":{"type":"string","description":"Two-letter ISO code representing the country the bank account is located in.","enum":["AT","BE","DE","ES","IT","NL"]}},"description":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","x-stripeMostCommon":["country"]},"stripe_balance":{"title":"param","type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"The connected account ID whose Stripe balance to use as the source of payment"}},"description":"This hash contains details about the Stripe balance payment method.","x-stripeMostCommon":["account","financial_account"]},"sunbit":{"title":"param","type":"object","properties":{},"description":"If this is a `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method."},"swish":{"title":"param","type":"object","properties":{},"description":"If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method."},"twint":{"title":"param","type":"object","properties":{},"description":"If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method."},"type":{"type":"string","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","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","custom","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true},"upi":{"title":"param","type":"object","properties":{"mandate_options":{"title":"mandate_options","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]}},"description":"If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.","x-stripeMostCommon":["mandate_options","vpa"]},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"account_holder_type":{"type":"string","description":"Account holder type: individual or company.","enum":["company","individual"]},"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account."},"account_type":{"type":"string","description":"Account type: checkings or savings. Defaults to checking if omitted.","enum":["checking","savings"]},"financial_connections_account":{"maxLength":5000,"type":"string","description":"The ID of a Financial Connections Account to use as a payment method."},"routing_number":{"maxLength":5000,"type":"string","description":"Routing number of the bank account."}},"description":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","x-stripeMostCommon":["account_holder_type","account_number","account_type","financial_connections_account","routing_number","token"]},"wechat_pay":{"title":"param","type":"object","properties":{},"description":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method."},"zip":{"title":"param","type":"object","properties":{},"description":"If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method."}},"additionalProperties":false,"x-stripeMostCommon":["billing_details","customer","metadata","payment_method","type"]},"encoding":{"acss_debit":{"style":"deepObject","explode":true},"affirm":{"style":"deepObject","explode":true},"afterpay_clearpay":{"style":"deepObject","explode":true},"alipay":{"style":"deepObject","explode":true},"alma":{"style":"deepObject","explode":true},"amazon_pay":{"style":"deepObject","explode":true},"au_becs_debit":{"style":"deepObject","explode":true},"bacs_debit":{"style":"deepObject","explode":true},"bancontact":{"style":"deepObject","explode":true},"billie":{"style":"deepObject","explode":true},"billing_details":{"style":"deepObject","explode":true},"bizum":{"style":"deepObject","explode":true},"blik":{"style":"deepObject","explode":true},"boleto":{"style":"deepObject","explode":true},"card":{"style":"deepObject","explode":true},"cashapp":{"style":"deepObject","explode":true},"crypto":{"style":"deepObject","explode":true},"custom":{"style":"deepObject","explode":true},"customer_balance":{"style":"deepObject","explode":true},"eps":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"fpx":{"style":"deepObject","explode":true},"giropay":{"style":"deepObject","explode":true},"gopay":{"style":"deepObject","explode":true},"grabpay":{"style":"deepObject","explode":true},"id_bank_transfer":{"style":"deepObject","explode":true},"ideal":{"style":"deepObject","explode":true},"interac_present":{"style":"deepObject","explode":true},"kakao_pay":{"style":"deepObject","explode":true},"klarna":{"style":"deepObject","explode":true},"konbini":{"style":"deepObject","explode":true},"kr_card":{"style":"deepObject","explode":true},"link":{"style":"deepObject","explode":true},"mb_way":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"mobilepay":{"style":"deepObject","explode":true},"multibanco":{"style":"deepObject","explode":true},"naver_pay":{"style":"deepObject","explode":true},"nz_bank_account":{"style":"deepObject","explode":true},"oxxo":{"style":"deepObject","explode":true},"p24":{"style":"deepObject","explode":true},"pay_by_bank":{"style":"deepObject","explode":true},"payco":{"style":"deepObject","explode":true},"paynow":{"style":"deepObject","explode":true},"paypal":{"style":"deepObject","explode":true},"paypay":{"style":"deepObject","explode":true},"payto":{"style":"deepObject","explode":true},"pix":{"style":"deepObject","explode":true},"promptpay":{"style":"deepObject","explode":true},"qris":{"style":"deepObject","explode":true},"radar_options":{"style":"deepObject","explode":true},"rechnung":{"style":"deepObject","explode":true},"revolut_pay":{"style":"deepObject","explode":true},"samsung_pay":{"style":"deepObject","explode":true},"satispay":{"style":"deepObject","explode":true},"scalapay":{"style":"deepObject","explode":true},"sepa_debit":{"style":"deepObject","explode":true},"sequra":{"style":"deepObject","explode":true},"shopeepay":{"style":"deepObject","explode":true},"sofort":{"style":"deepObject","explode":true},"stripe_balance":{"style":"deepObject","explode":true},"sunbit":{"style":"deepObject","explode":true},"swish":{"style":"deepObject","explode":true},"twint":{"style":"deepObject","explode":true},"upi":{"style":"deepObject","explode":true},"us_bank_account":{"style":"deepObject","explode":true},"wechat_pay":{"style":"deepObject","explode":true},"zip":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_payment_method"}},"/v1/payment_methods/{payment_method}":{"get":{"summary":"Retrieve a PaymentMethod","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"payment_method","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_method"},"post":{"summary":"Update a PaymentMethod","description":"Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.
","operationId":"PostPaymentMethodsPaymentMethod","parameters":[{"name":"payment_method","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"allow_redisplay":{"type":"string","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"]},"billing_details":{"title":"billing_details_inner_params","type":"object","properties":{"address":{"description":"Billing address.","anyOf":[{"title":"billing_details_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"email":{"description":"Email address.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"name":{"description":"Full name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"phone":{"description":"Billing phone number (including extension).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"tax_id":{"maxLength":5000,"type":"string","description":"Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone","tax_id"]},"card":{"title":"update_api_param","type":"object","properties":{"exp_month":{"type":"integer","description":"Two-digit number representing the card's expiration month."},"exp_year":{"type":"integer","description":"Four-digit number representing the card's expiration year."},"networks":{"title":"networks_update_api_param","type":"object","properties":{"preferred":{"type":"string","description":"The customer's preferred card network for co-branded cards. Supports `cartes_bancaires`, `mastercard`, or `visa`. Selection of a network that does not apply to the card will be stored as `invalid_preference` on the card.","enum":["","cartes_bancaires","mastercard","visa"]}},"description":"Contains information about card networks used to process the payment.","x-stripeMostCommon":["preferred"]}},"description":"If this is a `card` PaymentMethod, this hash contains the user's card details.","x-stripeMostCommon":["exp_month","exp_year","networks","request_card_art_and_program_name","request_network_token"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"us_bank_account":{"title":"update_param","type":"object","properties":{"account_holder_type":{"type":"string","description":"Bank account holder type.","enum":["company","individual"]},"account_type":{"type":"string","description":"Bank account type.","enum":["checking","savings"]}},"description":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","x-stripeMostCommon":["account_holder_type","account_type"]}},"additionalProperties":false,"x-stripeMostCommon":["billing_details","metadata"]},"encoding":{"billing_details":{"style":"deepObject","explode":true},"card":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"us_bank_account":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_payment_method"}},"/v1/payment_methods/{payment_method}/attach":{"post":{"summary":"Attach a PaymentMethod to a Customer","description":"Attaches a PaymentMethod object to a Customer.
\n\nTo attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent\nor a PaymentIntent with setup_future_usage.\nThese approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach\nendpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for\nfuture use, which makes later declines and payment friction more likely.\nSee Optimizing cards for future payments for more information about setting up\nfuture payments.
To use this PaymentMethod as the default for invoice or subscription payments,\nset invoice_settings.default_payment_method,\non the Customer to the PaymentMethod’s ID.
Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.
","operationId":"PostPaymentMethodsPaymentMethodDetach","parameters":[{"name":"payment_method","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_method"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"detach_payment_method"}},"/v1/payment_records":{"get":{"summary":"List Payment Records","description":"List all the Payment Records for a given merchant.
","operationId":"GetPaymentRecords","parameters":[{"name":"created_after","in":"query","description":"Only return Payment Records that were created after this unix timestamp.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"}},{"name":"created_before","in":"query","description":"Only return Payment Records that were created before this unix timestamp.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"unix-time"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"Payment Record List","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payment_record"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"A list of PaymentRecords.","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payment_record"}},"/v1/payment_records/report_payment":{"post":{"summary":"Report a payment","description":"Report a new Payment Record. You may report a Payment Record as it is\n initialized and later report updates through the other report_* methods, or report Payment\n Records in a terminal state directly, through this method.
","operationId":"PostPaymentRecordsReportPayment","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount_requested","initiated_at","payment_method_details"],"type":"object","properties":{"amount_requested":{"title":"amount","required":["currency","value"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"value":{"type":"integer","description":"A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY."}},"description":"The amount you initially requested for this payment.","x-stripeMostCommon":["currency","value"]},"canceled":{"title":"canceled","required":["canceled_at"],"type":"object","properties":{"canceled_at":{"type":"integer","description":"When the reported payment was canceled. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt cancelation.","x-stripeMostCommon":["canceled_at","payment_evaluations","reason"]},"customer_details":{"title":"customer_details","type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"The customer who made the payment."},"email":{"type":"string","description":"The customer's email address."},"name":{"maxLength":5000,"type":"string","description":"The customer's name."},"phone":{"type":"string","description":"The customer's phone number."}},"description":"Customer information for this payment.","x-stripeMostCommon":["customer","email","name","phone"]},"customer_presence":{"type":"string","description":"Indicates whether the customer was present in your checkout flow during this payment.","enum":["off_session","on_session"]},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"failed":{"title":"failed","required":["failed_at"],"type":"object","properties":{"failed_at":{"type":"integer","description":"When the reported payment failed. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt failure.","x-stripeMostCommon":["failed_at","failure_code","payment_evaluations","processor_details"]},"guaranteed":{"title":"guaranteed","required":["guaranteed_at"],"type":"object","properties":{"guaranteed_at":{"type":"integer","description":"When the reported payment was guaranteed. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt guarantee.","x-stripeMostCommon":["amount","final_capture","guaranteed_at","payment_evaluations","processor_details"]},"initiated_at":{"type":"integer","description":"When the reported payment was initiated. Measured in seconds since the Unix epoch.","format":"unix-time"},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"outcome":{"type":"string","description":"The outcome of the reported payment.","enum":["canceled","failed","guaranteed"]},"payment_method_details":{"title":"payment_method_details","type":"object","properties":{"billing_details":{"title":"billing_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The billing address associated with the method of payment.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"The billing email associated with the method of payment."},"name":{"maxLength":5000,"type":"string","description":"The billing name associated with the method of payment."},"phone":{"type":"string","description":"The billing phone number associated with the method of payment."}},"description":"The billing details associated with the method of payment.","x-stripeMostCommon":["address","email","name","phone"]},"custom":{"title":"custom","type":"object","properties":{"display_name":{"maxLength":5000,"type":"string","description":"Display name for the custom (user-defined) payment method type used to make this payment."},"type":{"maxLength":5000,"type":"string","description":"The custom payment method type associated with this payment."}},"description":"Information about the custom (user-defined) payment method used to make this payment.","x-stripeMostCommon":["display_name","type"]},"payment_method":{"maxLength":5000,"type":"string","description":"ID of the Stripe Payment Method used to make this payment."},"type":{"type":"string","description":"The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.","enum":["custom"],"x-stripeBypassValidation":true}},"description":"Information about the Payment Method debited for this payment.","x-stripeMostCommon":["billing_details","card","custom","payment_method","shared_payment_granted_token","type"]},"processor_details":{"title":"processor_details","required":["type"],"type":"object","properties":{"custom":{"title":"custom","required":["payment_reference"],"type":"object","properties":{"payment_reference":{"maxLength":5000,"type":"string","description":"An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID."}},"description":"Information about the custom processor used to make this payment.","x-stripeMostCommon":["payment_reference"]},"type":{"type":"string","description":"The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.","enum":["custom"]}},"description":"Processor information for this payment.","x-stripeMostCommon":["custom","type"]},"shipping_details":{"title":"shipping_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The physical shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"The shipping recipient's name."},"phone":{"type":"string","description":"The shipping recipient's phone number."}},"description":"Shipping information for this payment.","x-stripeMostCommon":["address","name","phone"]}},"additionalProperties":false,"x-stripeMostCommon":["amount_requested","canceled","customer_details","customer_presence","description","failed","guaranteed","initiated_at","metadata","outcome","payment_method_details","processor_details","shipping_details"]},"encoding":{"amount_requested":{"style":"deepObject","explode":true},"canceled":{"style":"deepObject","explode":true},"customer_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"failed":{"style":"deepObject","explode":true},"guaranteed":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_method_details":{"style":"deepObject","explode":true},"processor_details":{"style":"deepObject","explode":true},"shipping_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_payment"}},"/v1/payment_records/{id}":{"get":{"summary":"Retrieve a Payment Record","description":"Retrieves a Payment Record with the given ID
","operationId":"GetPaymentRecordsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payment_record"}},"/v1/payment_records/{id}/report_payment_attempt":{"post":{"summary":"Report a payment attempt","description":"Report a new payment attempt on the specified Payment Record. A new payment\n attempt can only be specified if all other payment attempts are canceled or failed.
","operationId":"PostPaymentRecordsIdReportPaymentAttempt","parameters":[{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["initiated_at"],"type":"object","properties":{"canceled":{"title":"canceled","required":["canceled_at"],"type":"object","properties":{"canceled_at":{"type":"integer","description":"When the reported payment was canceled. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt cancelation.","x-stripeMostCommon":["canceled_at","payment_evaluations","reason"]},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"failed":{"title":"failed","required":["failed_at"],"type":"object","properties":{"failed_at":{"type":"integer","description":"When the reported payment failed. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt failure.","x-stripeMostCommon":["failed_at","failure_code","payment_evaluations","processor_details"]},"guaranteed":{"title":"guaranteed","required":["guaranteed_at"],"type":"object","properties":{"guaranteed_at":{"type":"integer","description":"When the reported payment was guaranteed. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt guarantee.","x-stripeMostCommon":["amount","final_capture","guaranteed_at","payment_evaluations","processor_details"]},"initiated_at":{"type":"integer","description":"When the reported payment was initiated. Measured in seconds since the Unix epoch.","format":"unix-time"},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"outcome":{"type":"string","description":"The outcome of the reported payment.","enum":["canceled","failed","guaranteed"]},"payment_method_details":{"title":"payment_method_details","type":"object","properties":{"billing_details":{"title":"billing_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The billing address associated with the method of payment.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"The billing email associated with the method of payment."},"name":{"maxLength":5000,"type":"string","description":"The billing name associated with the method of payment."},"phone":{"type":"string","description":"The billing phone number associated with the method of payment."}},"description":"The billing details associated with the method of payment.","x-stripeMostCommon":["address","email","name","phone"]},"custom":{"title":"custom","type":"object","properties":{"display_name":{"maxLength":5000,"type":"string","description":"Display name for the custom (user-defined) payment method type used to make this payment."},"type":{"maxLength":5000,"type":"string","description":"The custom payment method type associated with this payment."}},"description":"Information about the custom (user-defined) payment method used to make this payment.","x-stripeMostCommon":["display_name","type"]},"payment_method":{"maxLength":5000,"type":"string","description":"ID of the Stripe Payment Method used to make this payment."},"type":{"type":"string","description":"The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.","enum":["custom"],"x-stripeBypassValidation":true}},"description":"Information about the Payment Method debited for this payment.","x-stripeMostCommon":["billing_details","card","custom","payment_method","shared_payment_granted_token","type"]},"shipping_details":{"title":"shipping_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The physical shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"The shipping recipient's name."},"phone":{"type":"string","description":"The shipping recipient's phone number."}},"description":"Shipping information for this payment.","x-stripeMostCommon":["address","name","phone"]}},"additionalProperties":false,"x-stripeMostCommon":["canceled","description","failed","guaranteed","initiated_at","metadata","outcome","payment_method_details","shipping_details"]},"encoding":{"canceled":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"failed":{"style":"deepObject","explode":true},"guaranteed":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_method_details":{"style":"deepObject","explode":true},"shipping_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_payment_attempt"}},"/v1/payment_records/{id}/report_payment_attempt_canceled":{"post":{"summary":"Report payment attempt canceled","description":"Report that the most recent payment attempt on the specified Payment Record\n was canceled.
","operationId":"PostPaymentRecordsIdReportPaymentAttemptCanceled","parameters":[{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["canceled_at"],"type":"object","properties":{"canceled_at":{"type":"integer","description":"When the reported payment was canceled. Measured in seconds since the Unix epoch.","format":"unix-time"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["canceled_at","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_payment_attempt_canceled"}},"/v1/payment_records/{id}/report_payment_attempt_failed":{"post":{"summary":"Report payment attempt failed","description":"Report that the most recent payment attempt on the specified Payment Record\n failed or errored.
","operationId":"PostPaymentRecordsIdReportPaymentAttemptFailed","parameters":[{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["failed_at"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"failed_at":{"type":"integer","description":"When the reported payment failed. Measured in seconds since the Unix epoch.","format":"unix-time"},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["failed_at","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_payment_attempt_failed"}},"/v1/payment_records/{id}/report_payment_attempt_guaranteed":{"post":{"summary":"Report payment attempt guaranteed","description":"Report that the most recent payment attempt on the specified Payment Record\n was guaranteed.
","operationId":"PostPaymentRecordsIdReportPaymentAttemptGuaranteed","parameters":[{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["guaranteed_at"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"guaranteed_at":{"type":"integer","description":"When the reported payment was guaranteed. Measured in seconds since the Unix epoch.","format":"unix-time"},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["guaranteed_at","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_payment_attempt_guaranteed"}},"/v1/payment_records/{id}/report_payment_attempt_informational":{"post":{"summary":"Report payment attempt informational","description":"Report informational updates on the specified Payment Record.
","operationId":"PostPaymentRecordsIdReportPaymentAttemptInformational","parameters":[{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"customer_details":{"title":"customer_details","type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"The customer who made the payment."},"email":{"type":"string","description":"The customer's email address."},"name":{"maxLength":5000,"type":"string","description":"The customer's name."},"phone":{"type":"string","description":"The customer's phone number."}},"description":"Customer information for this payment.","x-stripeMostCommon":["customer","email","name","phone"]},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"shipping_details":{"description":"Shipping information for this payment.","anyOf":[{"title":"shipping_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"The physical shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"The shipping recipient's name."},"phone":{"type":"string","description":"The shipping recipient's phone number."}},"x-stripeMostCommon":["address","name","phone"]},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["customer_details","description","metadata","shipping_details"]},"encoding":{"customer_details":{"style":"deepObject","explode":true},"description":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"shipping_details":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_payment_attempt_informational"}},"/v1/payment_records/{id}/report_refund":{"post":{"summary":"Report a refund","description":"Report that the most recent payment attempt on the specified Payment Record\n was refunded.
","operationId":"PostPaymentRecordsIdReportRefund","parameters":[{"name":"id","in":"path","description":"The ID of the Payment Record.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["outcome","processor_details"],"type":"object","properties":{"amount":{"title":"amount","required":["currency","value"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"value":{"type":"integer","description":"A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY."}},"description":"A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment.","x-stripeMostCommon":["currency","value"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"initiated_at":{"type":"integer","description":"When the reported refund was initiated. Measured in seconds since the Unix epoch.","format":"unix-time"},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"outcome":{"type":"string","description":"The outcome of the reported refund.","enum":["refunded"],"x-stripeBypassValidation":true},"processor_details":{"title":"processor_details","required":["type"],"type":"object","properties":{"custom":{"title":"custom","required":["refund_reference"],"type":"object","properties":{"refund_reference":{"maxLength":5000,"type":"string","description":"A reference to the external refund. This field must be unique across all refunds."}},"description":"Information about the custom processor used to make this refund.","x-stripeMostCommon":["refund_reference"]},"type":{"type":"string","description":"The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.","enum":["custom"]}},"description":"Processor information for this refund.","x-stripeMostCommon":["custom","type"]},"refunded":{"title":"refunded","required":["refunded_at"],"type":"object","properties":{"refunded_at":{"type":"integer","description":"When the reported refund completed. Measured in seconds since the Unix epoch.","format":"unix-time"}},"description":"Information about the payment attempt refund.","x-stripeMostCommon":["refunded_at"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","initiated_at","metadata","outcome","processor_details","refunded"]},"encoding":{"amount":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"processor_details":{"style":"deepObject","explode":true},"refunded":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_record"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"report_refund"}},"/v1/payouts":{"get":{"summary":"List all payouts","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":[{"name":"arrival_date","in":"query","description":"Only return payouts that are expected to arrive during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"created","in":"query","description":"Only return payouts that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"destination","in":"query","description":"The ID of an external account - only return payouts sent to this external account.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PayoutList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/payout"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/payouts","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_payouts"},"post":{"summary":"Create a payout","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.
\n\nIf 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.
\n\nIf 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":{"schema":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A positive integer in cents representing how much to pay out."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"destination":{"type":"string","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"method":{"maxLength":5000,"type":"string","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"],"x-stripeBypassValidation":true},"payout_method":{"type":"string","description":"The ID of a v2 FinancialAccount to send funds to."},"source_type":{"maxLength":5000,"type":"string","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"],"x-stripeBypassValidation":true},"statement_descriptor":{"maxLength":22,"type":"string","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. For US ACH payouts, this maps to the ACH Company Entry Description field, which the NACHA standard limits to 10 characters. Stripe truncates descriptors longer than 10 characters for US ACH payouts.","x-stripeBypassValidation":true}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","metadata","statement_descriptor"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payout"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_payout"}},"/v1/payouts/{payout}":{"get":{"summary":"Retrieve a payout","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"payout","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payout"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_payout"},"post":{"summary":"Update a payout","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":[{"name":"payout","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payout"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_payout"}},"/v1/payouts/{payout}/cancel":{"post":{"summary":"Cancel a payout","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.
Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US and Canadian 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.
Returns a list of your plans.
","operationId":"GetPlans","parameters":[{"name":"active","in":"query","description":"Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"product","in":"query","description":"Only return plans for the given product.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PlanList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/plan"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/plans","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_plans"},"post":{"summary":"Create a plan","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":{"schema":{"required":["currency","interval"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the plan is currently available for new subscriptions. Defaults to `true`."},"amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis."},"amount_decimal":{"type":"string","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"},"billing_scheme":{"type":"string","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"]},"currency":{"type":"string","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).","format":"currency"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"id":{"maxLength":5000,"type":"string","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 use the same plan ID in live mode and in your sandboxes."},"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"meter":{"maxLength":5000,"type":"string","description":"The meter tracking the usage of a metered price"},"nickname":{"maxLength":5000,"type":"string","description":"A brief description of the plan, hidden from customers."},"product":{"anyOf":[{"title":"inline_product_params","required":["name"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the product is currently available for purchase. Defaults to `true`."},"id":{"maxLength":5000,"type":"string","description":"The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.","deprecated":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"statement_descriptor":{"maxLength":22,"type":"string","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.\n\nThis 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."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"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://docs.stripe.com/api#product_object-type).","x-stripeMostCommon":["active","id","images","metadata","name","statement_descriptor","tax_code","tax_details","unit_label"]},{"maxLength":5000,"type":"string","description":"The ID of the product whose pricing the created plan will represent."}]},"tiers":{"type":"array","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":{"title":"tier","required":["up_to"],"type":"object","properties":{"flat_amount":{"type":"integer","description":"The flat billing amount for an entire tier, regardless of the number of units in the tier."},"flat_amount_decimal":{"type":"string","description":"Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.","format":"decimal"},"unit_amount":{"type":"integer","description":"The per unit billing amount for each individual unit for which this tier applies."},"unit_amount_decimal":{"type":"string","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"},"up_to":{"description":"Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.","anyOf":[{"maxLength":5000,"type":"string","enum":["inf"]},{"type":"integer"}]}},"x-stripeMostCommon":["flat_amount","flat_amount_decimal","unit_amount","unit_amount_decimal","up_to"]}},"tiers_mode":{"type":"string","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"]},"transform_usage":{"title":"transform_usage_param","required":["divide_by","round"],"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide usage by this number."},"round":{"type":"string","description":"After division, either round the result `up` or `down`.","enum":["down","up"]}},"description":"Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.","x-stripeMostCommon":["divide_by","round"]},"trial_period_days":{"type":"integer","description":"Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan)."},"usage_type":{"type":"string","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"]}},"additionalProperties":false,"x-stripeMostCommon":["active","amount","currency","interval","metadata","nickname","product"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"product":{"style":"deepObject","explode":true},"tiers":{"style":"deepObject","explode":true},"transform_usage":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plan"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_plan"}},"/v1/plans/{plan}":{"get":{"summary":"Retrieve a plan","description":"Retrieves the plan with the given ID.
","operationId":"GetPlansPlan","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"plan","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plan"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_plan"},"post":{"summary":"Update a plan","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":[{"name":"plan","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the plan is currently available for new subscriptions."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"nickname":{"maxLength":5000,"type":"string","description":"A brief description of the plan, hidden from customers."},"product":{"maxLength":5000,"type":"string","description":"The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule."},"trial_period_days":{"type":"integer","description":"Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan)."}},"additionalProperties":false,"x-stripeMostCommon":["active","metadata","nickname"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/plan"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_plan"},"delete":{"summary":"Delete a plan","description":"Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.
","operationId":"DeletePlansPlan","parameters":[{"name":"plan","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_plan"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_billing_plan"}},"/v1/prices":{"get":{"summary":"List all prices","description":"Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.
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":{"schema":{"required":["currency"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the price can be used for new purchases. Defaults to `true`."},"billing_scheme":{"type":"string","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"]},"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","type":"object","properties":{"custom_unit_amount":{"title":"custom_unit_amount","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`."},"maximum":{"type":"integer","description":"The maximum unit amount the customer can specify for this item."},"minimum":{"type":"integer","description":"The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."},"preset":{"type":"integer","description":"The starting unit amount which can be updated by the customer."}},"description":"When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.","x-stripeMostCommon":["enabled","preset"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tiers":{"type":"array","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":{"title":"tier","required":["up_to"],"type":"object","properties":{"flat_amount":{"type":"integer","description":"The flat billing amount for an entire tier, regardless of the number of units in the tier."},"flat_amount_decimal":{"type":"string","description":"Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.","format":"decimal"},"unit_amount":{"type":"integer","description":"The per unit billing amount for each individual unit for which this tier applies."},"unit_amount_decimal":{"type":"string","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"},"up_to":{"description":"Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.","anyOf":[{"maxLength":5000,"type":"string","enum":["inf"]},{"type":"integer"}]}},"x-stripeMostCommon":["flat_amount","flat_amount_decimal","unit_amount","unit_amount_decimal","up_to"]}},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["unit_amount"]},"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)."},"custom_unit_amount":{"title":"custom_unit_amount","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`."},"maximum":{"type":"integer","description":"The maximum unit amount the customer can specify for this item."},"minimum":{"type":"integer","description":"The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."},"preset":{"type":"integer","description":"The starting unit amount which can be updated by the customer."}},"description":"When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.","x-stripeMostCommon":["enabled","preset"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"lookup_key":{"maxLength":200,"type":"string","description":"A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"A brief description of the price, hidden from customers."},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"product_data":{"title":"inline_product_params","required":["name"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the product is currently available for purchase. Defaults to `true`."},"id":{"maxLength":5000,"type":"string","description":"The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.","deprecated":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"statement_descriptor":{"maxLength":22,"type":"string","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.\n\nThis 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."},"tax_code":{"maxLength":5000,"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"unit_label":{"maxLength":12,"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."}},"description":"These fields can be used to create a new product that this price will belong to.","x-stripeMostCommon":["active","id","images","metadata","name","statement_descriptor","tax_code","tax_details","unit_label"]},"recurring":{"title":"recurring","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."},"meter":{"maxLength":5000,"type":"string","description":"The meter tracking the usage of a metered price"},"trial_period_days":{"type":"integer","description":"Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan)."},"usage_type":{"type":"string","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"]}},"description":"The recurring components of a price such as `interval` and `usage_type`.","x-stripeMostCommon":["interval","meter","trial_period_days","usage_type"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tiers":{"type":"array","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":{"title":"tier","required":["up_to"],"type":"object","properties":{"flat_amount":{"type":"integer","description":"The flat billing amount for an entire tier, regardless of the number of units in the tier."},"flat_amount_decimal":{"type":"string","description":"Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.","format":"decimal"},"unit_amount":{"type":"integer","description":"The per unit billing amount for each individual unit for which this tier applies."},"unit_amount_decimal":{"type":"string","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"},"up_to":{"description":"Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.","anyOf":[{"maxLength":5000,"type":"string","enum":["inf"]},{"type":"integer"}]}},"x-stripeMostCommon":["flat_amount","flat_amount_decimal","unit_amount","unit_amount_decimal","up_to"]}},"tiers_mode":{"type":"string","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"]},"transfer_lookup_key":{"type":"boolean","description":"If set to true, will atomically remove the lookup key from the existing price, and assign it to this price."},"transform_quantity":{"title":"transform_usage_param","required":["divide_by","round"],"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide usage by this number."},"round":{"type":"string","description":"After division, either round the result `up` or `down`.","enum":["down","up"]}},"description":"Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.","x-stripeMostCommon":["divide_by","round"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`."},"unit_amount_decimal":{"type":"string","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"}},"additionalProperties":false,"x-stripeMostCommon":["active","currency","metadata","nickname","product","recurring","tax_behavior","unit_amount"]},"encoding":{"currency_options":{"style":"deepObject","explode":true},"custom_unit_amount":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"product_data":{"style":"deepObject","explode":true},"recurring":{"style":"deepObject","explode":true},"tiers":{"style":"deepObject","explode":true},"transform_quantity":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/price"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_price"}},"/v1/prices/search":{"get":{"summary":"Search prices","description":"Search for prices you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetPricesSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for prices](https://docs.stripe.com/search#query-fields-for-prices).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/price"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_prices"}},"/v1/prices/{price}":{"get":{"summary":"Retrieve a price","description":"Retrieves the price with the given ID.
","operationId":"GetPricesPrice","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"price","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/price"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_price"},"post":{"summary":"Update a price","description":"Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
","operationId":"PostPricesPrice","parameters":[{"name":"price","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the price can be used for new purchases. Defaults to `true`."},"currency_options":{"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).","anyOf":[{"type":"object","additionalProperties":{"title":"currency_option","type":"object","properties":{"custom_unit_amount":{"title":"custom_unit_amount","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`."},"maximum":{"type":"integer","description":"The maximum unit amount the customer can specify for this item."},"minimum":{"type":"integer","description":"The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."},"preset":{"type":"integer","description":"The starting unit amount which can be updated by the customer."}},"description":"When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.","x-stripeMostCommon":["enabled","preset"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tiers":{"type":"array","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":{"title":"tier","required":["up_to"],"type":"object","properties":{"flat_amount":{"type":"integer","description":"The flat billing amount for an entire tier, regardless of the number of units in the tier."},"flat_amount_decimal":{"type":"string","description":"Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.","format":"decimal"},"unit_amount":{"type":"integer","description":"The per unit billing amount for each individual unit for which this tier applies."},"unit_amount_decimal":{"type":"string","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"},"up_to":{"description":"Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.","anyOf":[{"maxLength":5000,"type":"string","enum":["inf"]},{"type":"integer"}]}},"x-stripeMostCommon":["flat_amount","flat_amount_decimal","unit_amount","unit_amount_decimal","up_to"]}},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["unit_amount"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"lookup_key":{"maxLength":200,"type":"string","description":"A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"migrate_to":{"description":"If specified, subscriptions using this price will be updated to use the new referenced price.","anyOf":[{"title":"migrate_to_specs","required":["behavior","price"],"type":"object","properties":{"behavior":{"type":"string","description":"The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.","enum":["at_cycle_end"]},"effective_after":{"type":"integer","description":"The time after which subscriptions should start using the new price.","format":"unix-time"},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."}},"x-stripeMostCommon":["behavior","effective_after","price"]},{"type":"string","enum":[""]}]},"nickname":{"maxLength":5000,"type":"string","description":"A brief description of the price, hidden from customers."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"transfer_lookup_key":{"type":"boolean","description":"If set to true, will atomically remove the lookup key from the existing price, and assign it to this price."}},"additionalProperties":false,"x-stripeMostCommon":["active","metadata","nickname","tax_behavior"]},"encoding":{"currency_options":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"migrate_to":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/price"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_price"}},"/v1/privacy/redaction_jobs":{"get":{"summary":"List all redaction jobs","description":"Returns a list of redaction jobs.
","operationId":"GetPrivacyRedactionJobs","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"If provided, only RedactionJob objects with the given status will be returned.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","canceling","created","failed","ready","redacting","succeeded","validating"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"RedactionResourceRedactionJobList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/privacy.redaction_job"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/privacy/redaction_jobs","type":"string","description":"The URL where this list can be accessed."}},"description":"A list of redaction jobs","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"privacy_redaction_jobs_list_method"},"post":{"summary":"Create a redaction job","description":"Creates a redaction job. When a job is created, it will start to validate.
","operationId":"PostPrivacyRedactionJobs","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["objects"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"objects":{"title":"root_object_params","type":"object","properties":{"charges":{"type":"array","items":{"maxLength":5000,"type":"string"}},"checkout_sessions":{"type":"array","items":{"maxLength":5000,"type":"string"}},"customers":{"type":"array","items":{"maxLength":5000,"type":"string"}},"identity_verification_sessions":{"type":"array","items":{"maxLength":5000,"type":"string"}},"invoices":{"type":"array","items":{"maxLength":5000,"type":"string"}},"issuing_cardholders":{"type":"array","items":{"maxLength":5000,"type":"string"}},"issuing_cards":{"type":"array","items":{"maxLength":5000,"type":"string"}},"payment_intents":{"type":"array","items":{"maxLength":5000,"type":"string"}},"radar_value_list_items":{"type":"array","items":{"maxLength":5000,"type":"string"}},"setup_intents":{"type":"array","items":{"maxLength":5000,"type":"string"}}},"description":"The objects to redact. These root objects and their related ones will be validated for redaction.","x-stripeMostCommon":["charges","checkout_sessions","customers","identity_verification_sessions","invoices","issuing_cardholders","issuing_cards","payment_intents","radar_value_list_items","setup_intents"]},"validation_behavior":{"type":"string","description":"Determines the validation behavior of the job. Default is `error`.","enum":["error","fix"]}},"additionalProperties":false,"x-stripeMostCommon":["objects","validation_behavior"]},"encoding":{"expand":{"style":"deepObject","explode":true},"objects":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privacy.redaction_job"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"privacy_redaction_jobs_create_method"}},"/v1/privacy/redaction_jobs/{job}":{"get":{"summary":"Retrieve a redaction job","description":"Retrieves the details of a previously created redaction job.
","operationId":"GetPrivacyRedactionJobsJob","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"job","in":"path","description":"RedactionJob object identifier","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privacy.redaction_job"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"privacy_redaction_jobs_retrieve_method"},"post":{"summary":"Update a redaction job","description":"Updates the properties of a redaction job without running or canceling the job.
\n\nIf the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
You can cancel a redaction job when it’s in one of these statuses: ready, failed.
Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
","operationId":"PostPrivacyRedactionJobsJobCancel","parameters":[{"name":"job","in":"path","description":"RedactionJob object identifier","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privacy.redaction_job"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"privacy_redaction_jobs_cancel_method"}},"/v1/privacy/redaction_jobs/{job}/run":{"post":{"summary":"Run a redaction job","description":"Run a redaction job in a ready status.
When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
\n\nThe status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job’s validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
Validate a redaction job when it is in a failed status.
When a job is created, it automatically begins to validate on the configured objects’ eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job’s validation_behavior is changed.
The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
Returns a list of validation errors for the specified redaction job.
","operationId":"GetPrivacyRedactionJobsJobValidationErrors","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"job","in":"path","description":"RedactionJob object identifier","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"RedactionResourceValidationErrorList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/privacy.redaction_job_validation_error"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/privacy/redaction_jobs/[^/]+/validation_errors","type":"string","description":"The URL where this list can be accessed."}},"description":"A list of redaction job validation errors","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"privacy_redaction_jobs_list_validation_errors_method"}},"/v1/product_catalog/trial_offers":{"get":{"summary":"List trial offers","description":"Returns a list of trial offers.
","operationId":"GetProductCatalogTrialOffers","parameters":[{"name":"active","in":"query","description":"Only return trial offers that are active (`true`) or archived (`false`). If omitted, both active and archived trial offers are returned.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"created","in":"query","description":"Only return trial offers that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"prices","in":"query","description":"Only return trial offers that reference these prices (during the trial period).","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TrialOfferList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/product_catalog.trial_offer"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_trial_offers"},"post":{"summary":"Create a trial offer","description":"Creates a trial offer.
","operationId":"PostProductCatalogTrialOffers","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["duration","end_behavior","price"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the trial offer can be used for new subscriptions. Defaults to true."},"duration":{"title":"trial_offer_duration_param","required":["type"],"type":"object","properties":{"relative":{"title":"trial_offer_duration_relative_param","required":["iterations"],"type":"object","properties":{"iterations":{"type":"integer","description":"The number of recurring price's interval to apply for the trial period."}},"description":"The relative duration of the trial period computed as the number of recurring price intervals.","x-stripeMostCommon":["iterations"]},"type":{"type":"string","description":"Specifies how the trial offer duration is determined.","enum":["relative","timestamp"],"x-stripeEnum":{"kind":"open","values":[{"description":"The duration of trials created from this offer are determined relative to the trial start date.","value":"relative"},{"description":"The duration of trials created from this offer are determined by a specific timestamp.","value":"timestamp"}]}}},"description":"Duration of one service period of the trial.","x-stripeMostCommon":["relative","type"]},"end_behavior":{"title":"trial_offer_end_behavior_param","required":["transition"],"type":"object","properties":{"transition":{"title":"trial_offer_end_behavior_transition_param","required":["price"],"type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The price to transition the recurring item to when the trial offer ends."}},"description":"The transition to apply when the trial offer ends.","x-stripeMostCommon":["price"]}},"description":"Define behavior that occurs at the end of the trial.","x-stripeMostCommon":["transition"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"nickname":{"maxLength":255,"type":"string","description":"A brief description of the trial offer, hidden from customers."},"price":{"maxLength":5000,"type":"string","description":"Price configuration during the trial period (amount, billing scheme, etc)."}},"additionalProperties":false,"x-stripeMostCommon":["active","duration","end_behavior","nickname","price"]},"encoding":{"duration":{"style":"deepObject","explode":true},"end_behavior":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_catalog.trial_offer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_trial_offer"}},"/v1/product_catalog/trial_offers/{id}":{"get":{"summary":"Retrieve a trial offer","description":"Retrieves the trial offer with the given ID.
","operationId":"GetProductCatalogTrialOffersId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_catalog.trial_offer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_trial_offer"},"post":{"summary":"Update a trial offer","description":"Updates the specified trial offer by setting the values of the parameters passed. Any parameters not provided are left unchanged.
","operationId":"PostProductCatalogTrialOffersId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the trial offer can be used for new purchases."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["active"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_catalog.trial_offer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_trial_offer"}},"/v1/products":{"get":{"summary":"List all products","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":[{"name":"active","in":"query","description":"Only return products that are active or inactive (e.g., pass `false` to list all inactive products).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"created","in":"query","description":"Only return products that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"ids","in":"query","description":"Only return products with the given IDs. Cannot be used with [starting_after](https://docs.stripe.com/api#list_products-starting_after) or [ending_before](https://docs.stripe.com/api#list_products-ending_before).","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"shippable","in":"query","description":"Only return products that can be shipped (i.e., physical, not digital products).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"type","in":"query","description":"Only return products of this type.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["good","service"]},"x-stripeLessCommon":true},{"name":"url","in":"query","description":"Only return products with the given url.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ProductList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/product"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/products","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_products"},"post":{"summary":"Create a product","description":"Creates a new product object.
","operationId":"PostProducts","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the product is currently available for purchase. Defaults to `true`."},"default_price_data":{"title":"price_data_without_product_with_metadata","required":["currency"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","type":"object","properties":{"custom_unit_amount":{"title":"custom_unit_amount","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`."},"maximum":{"type":"integer","description":"The maximum unit amount the customer can specify for this item."},"minimum":{"type":"integer","description":"The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."},"preset":{"type":"integer","description":"The starting unit amount which can be updated by the customer."}},"description":"When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.","x-stripeMostCommon":["enabled","preset"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"tiers":{"type":"array","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":{"title":"tier","required":["up_to"],"type":"object","properties":{"flat_amount":{"type":"integer","description":"The flat billing amount for an entire tier, regardless of the number of units in the tier."},"flat_amount_decimal":{"type":"string","description":"Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.","format":"decimal"},"unit_amount":{"type":"integer","description":"The per unit billing amount for each individual unit for which this tier applies."},"unit_amount_decimal":{"type":"string","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"},"up_to":{"description":"Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.","anyOf":[{"maxLength":5000,"type":"string","enum":["inf"]},{"type":"integer"}]}},"x-stripeMostCommon":["flat_amount","flat_amount_decimal","unit_amount","unit_amount_decimal","up_to"]}},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"x-stripeMostCommon":["unit_amount"]},"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)."},"custom_unit_amount":{"title":"custom_unit_amount","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`."},"maximum":{"type":"integer","description":"The maximum unit amount the customer can specify for this item."},"minimum":{"type":"integer","description":"The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."},"preset":{"type":"integer","description":"The starting unit amount which can be updated by the customer."}},"description":"When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.","x-stripeMostCommon":["enabled","preset"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object. This Price will be set as the default price for this product.","x-stripeMostCommon":["currency","unit_amount"]},"description":{"maxLength":40000,"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":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"id":{"maxLength":5000,"type":"string","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."},"images":{"type":"array","description":"A list of up to 8 URLs of images for this product, meant to be displayable to the customer.","items":{"type":"string"}},"marketing_features":{"type":"array","description":"A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).","items":{"title":"features","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The marketing feature name. Up to 80 characters long."}},"x-stripeMostCommon":["name"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"package_dimensions":{"title":"package_dimensions_specs","required":["height","length","weight","width"],"type":"object","properties":{"height":{"type":"number","description":"Height, in inches. Maximum precision is 2 decimal places."},"length":{"type":"number","description":"Length, in inches. Maximum precision is 2 decimal places."},"weight":{"type":"number","description":"Weight, in ounces. Maximum precision is 2 decimal places."},"width":{"type":"number","description":"Width, in inches. Maximum precision is 2 decimal places."}},"description":"The dimensions of this product for shipping purposes.","x-stripeMostCommon":["height","length","weight","width"]},"shippable":{"type":"boolean","description":"Whether this product is shipped (i.e., physical goods)."},"statement_descriptor":{"maxLength":22,"type":"string","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.\n\nThis 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.\n It must contain at least one letter. Only used for subscription payments."},"tax_code":{"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID."},"tax_details":{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","x-stripeMostCommon":["performance_location","provider_options","tax_code"]},"type":{"type":"string","description":"The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.","enum":["good","service"]},"unit_label":{"maxLength":12,"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."},"url":{"maxLength":5000,"type":"string","description":"A URL of a publicly-accessible webpage for this product."}},"additionalProperties":false,"x-stripeMostCommon":["active","description","id","metadata","name","tax_code","tax_details"]},"encoding":{"default_price_data":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"images":{"style":"deepObject","explode":true},"marketing_features":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"package_dimensions":{"style":"deepObject","explode":true},"tax_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_product"}},"/v1/products/search":{"get":{"summary":"Search products","description":"Search for products you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetProductsSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for products](https://docs.stripe.com/search#query-fields-for-products).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/product"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_products"}},"/v1/products/{id}":{"get":{"summary":"Retrieve a product","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_product"},"post":{"summary":"Update a product","description":"Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
","operationId":"PostProductsId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the product is available for purchase."},"default_price":{"maxLength":5000,"type":"string","description":"The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product."},"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.","anyOf":[{"maxLength":40000,"type":"string"},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"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.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":[""]}]},"marketing_features":{"description":"A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).","anyOf":[{"type":"array","items":{"title":"features","required":["name"],"type":"object","properties":{"name":{"maxLength":5000,"type":"string","description":"The marketing feature name. Up to 80 characters long."}},"x-stripeMostCommon":["name"]}},{"type":"string","enum":[""]}]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"name":{"maxLength":5000,"type":"string","description":"The product's name, meant to be displayable to the customer."},"package_dimensions":{"description":"The dimensions of this product for shipping purposes.","anyOf":[{"title":"package_dimensions_specs","required":["height","length","weight","width"],"type":"object","properties":{"height":{"type":"number","description":"Height, in inches. Maximum precision is 2 decimal places."},"length":{"type":"number","description":"Length, in inches. Maximum precision is 2 decimal places."},"weight":{"type":"number","description":"Weight, in ounces. Maximum precision is 2 decimal places."},"width":{"type":"number","description":"Width, in inches. Maximum precision is 2 decimal places."}},"x-stripeMostCommon":["height","length","weight","width"]},{"type":"string","enum":[""]}]},"shippable":{"type":"boolean","description":"Whether this product is shipped (i.e., physical goods)."},"statement_descriptor":{"maxLength":22,"type":"string","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.\n\nThis 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.\n It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"tax_details":{"description":"Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.","anyOf":[{"title":"tax_details","type":"object","properties":{"performance_location":{"maxLength":5000,"type":"string","description":"A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported."},"tax_code":{"description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["performance_location","provider_options","tax_code"]},{"type":"string","enum":[""]}]},"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. May only be set if `type=service`.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]},"url":{"description":"A URL of a publicly-accessible webpage for this product.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["active","default_price","description","metadata","name","tax_code","tax_details"]},"encoding":{"description":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"images":{"style":"deepObject","explode":true},"marketing_features":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"package_dimensions":{"style":"deepObject","explode":true},"tax_code":{"style":"deepObject","explode":true},"tax_details":{"style":"deepObject","explode":true},"unit_label":{"style":"deepObject","explode":true},"url":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_product"},"delete":{"summary":"Delete a product","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.
Retrieve a list of features for a product
","operationId":"GetProductsProductFeatures","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"product","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"EntitlementsResourceProductFeatureList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/product_feature"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_list_product_features"},"post":{"summary":"Attach a feature to a product","description":"Creates a product_feature, which represents a feature attachment to a product
","operationId":"PostProductsProductFeatures","parameters":[{"name":"product","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["entitlement_feature"],"type":"object","properties":{"entitlement_feature":{"maxLength":5000,"type":"string","description":"The ID of the [Feature](https://docs.stripe.com/api/entitlements/feature) object attached to this product."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["entitlement_feature"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_feature"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_create_product_feature"}},"/v1/products/{product}/features/{id}":{"get":{"summary":"Retrieve a product_feature","description":"Retrieves a product_feature, which represents a feature attachment to a product
","operationId":"GetProductsProductFeaturesId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The ID of the product_feature.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"product","in":"path","description":"The ID of the product.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/product_feature"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_get_product_feature"},"delete":{"summary":"Remove a feature from a product","description":"Deletes the feature attachment to a product
","operationId":"DeleteProductsProductFeaturesId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"product","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_product_feature"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"entitlements_product_feature_delete"}},"/v1/promotion_codes":{"get":{"summary":"List all promotion codes","description":"Returns a list of your promotion codes.
","operationId":"GetPromotionCodes","parameters":[{"name":"active","in":"query","description":"Filter promotion codes by whether they are active.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"code","in":"query","description":"Only return promotion codes that have this case-insensitive code.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"coupon","in":"query","description":"Only return promotion codes for this coupon.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return promotion codes that are restricted to this customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"customer_account","in":"query","description":"Only return promotion codes that are restricted to this account representing the customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PromotionCodesResourcePromotionCodeList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/promotion_code"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/promotion_codes","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_promotion_codes"},"post":{"summary":"Create a promotion code","description":"A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
","operationId":"PostPromotionCodes","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["promotion"],"type":"object","properties":{"active":{"type":"boolean","description":"Whether the promotion code is currently active."},"code":{"maxLength":500,"type":"string","description":"The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).\n\nIf left blank, we will generate one automatically."},"customer":{"maxLength":5000,"type":"string","description":"The customer who can use this promotion code. If not set, all customers can use the promotion code."},"customer_account":{"maxLength":5000,"type":"string","description":"The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","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"},"max_redemptions":{"type":"integer","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`."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"promotion":{"title":"promotion","required":["type"],"type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"If promotion `type` is `coupon`, the coupon for this promotion code."},"type":{"type":"string","description":"Specifies the type of promotion.","enum":["coupon"]}},"description":"The promotion referenced by this promotion code.","x-stripeMostCommon":["coupon","type"]},"restrictions":{"title":"restrictions_params","type":"object","properties":{"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","type":"object","properties":{"minimum_amount":{"type":"integer","description":"Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."}},"x-stripeMostCommon":["minimum_amount"]},"description":"Promotion codes 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). Each currency must be different from the `minimum_amount_currency` set on the promotion code."},"first_time_transaction":{"type":"boolean","description":"A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices"},"minimum_amount":{"type":"integer","description":"Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."},"minimum_amount_currency":{"type":"string","description":"Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount","format":"currency"}},"description":"Settings that restrict the redemption of the promotion code.","x-stripeMostCommon":["currency_options","first_time_transaction","minimum_amount","minimum_amount_currency"]}},"additionalProperties":false,"x-stripeMostCommon":["code","metadata","promotion"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"promotion":{"style":"deepObject","explode":true},"restrictions":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/promotion_code"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_promotion_code"}},"/v1/promotion_codes/{promotion_code}":{"get":{"summary":"Retrieve a promotion code","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.
Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
","operationId":"PostPromotionCodesPromotionCode","parameters":[{"name":"promotion_code","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","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."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"restrictions":{"title":"restrictions_params","type":"object","properties":{"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","type":"object","properties":{"minimum_amount":{"type":"integer","description":"Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."}},"x-stripeMostCommon":["minimum_amount"]},"description":"Promotion codes 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). Each currency must be different from the `minimum_amount_currency` set on the promotion code."}},"description":"Settings that restrict the redemption of the promotion code.","x-stripeMostCommon":["currency_options"]}},"additionalProperties":false,"x-stripeMostCommon":["metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"restrictions":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/promotion_code"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_promotion_code"}},"/v1/quotes":{"get":{"summary":"List all quotes","description":"Returns a list of your quotes.
","operationId":"GetQuotes","parameters":[{"name":"customer","in":"query","description":"The ID of the customer whose quotes you're retrieving.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"The ID of the account representing the customer whose quotes you're retrieving.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"from_subscription","in":"query","description":"The subscription which the quote updates.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"The status of the quote.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["accepted","accepting","canceled","draft","open","stale"]}},{"name":"test_clock","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourceQuoteList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/quote"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/quotes","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_quotes"},"post":{"summary":"Create a quote","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.
Retrieves the quote with the given ID.
","operationId":"GetQuotesQuote","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_quote"},"post":{"summary":"Update a quote","description":"A quote models prices and services for a customer.
","operationId":"PostQuotesQuote","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"allow_backdated_lines":{"type":"boolean","description":"Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now."},"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. There cannot be any line items with recurring prices when using this field.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"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.","anyOf":[{"type":"number"},{"type":"string","enum":[""]}]},"automatic_tax":{"title":"automatic_tax_param","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.","x-stripeMostCommon":["enabled","liability"]},"collection_method":{"type":"string","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"]},"customer":{"maxLength":5000,"type":"string","description":"The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed."},"customer_account":{"maxLength":5000,"type":"string","description":"The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed."},"default_tax_rates":{"description":"The tax rates that will apply to any line item that does not have `tax_rates` set.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"description":{"description":"A description that will be displayed on the quote PDF.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"discounts":{"description":"The discounts applied to the quote.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","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"},"footer":{"description":"A footer that will be displayed on the quote PDF.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"header":{"description":"A header that will be displayed on the quote PDF.","anyOf":[{"maxLength":50,"type":"string"},{"type":"string","enum":[""]}]},"invoice_settings":{"title":"quote_param","type":"object","properties":{"custom_fields":{"description":"A list of up to 4 custom fields to be displayed on the invoice.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"days_until_due":{"type":"integer","description":"Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`."},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"footer":{"description":"Footer to be displayed on the invoice.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["custom_fields","days_until_due","description","footer","issuer"]},"line_items":{"type":"array","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":{"title":"line_item_update_params","type":"object","properties":{"discounts":{"description":"The discounts applied to this line item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},{"type":"string","enum":[""]}]},"id":{"maxLength":5000,"type":"string","description":"The ID of an existing line item on the quote."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. One of `price` or `price_data` is required."},"price_data":{"title":"price_data","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"The quantity of the line item."},"tax_rates":{"description":"The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["id","price","quantity"]}},"lines":{"type":"array","description":"A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.","items":{"title":"quote_line_update_specs","type":"object","properties":{"actions":{"type":"array","description":"An array of operations the quote line performs.","items":{"title":"action_specs","required":["type"],"type":"object","properties":{"add_discount":{"title":"add_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to redeem."},"discount":{"maxLength":5000,"type":"string","description":"An ID of an existing discount for a coupon that was already redeemed."},"discount_end":{"title":"line_discount_end_specs","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["line_ends_at"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["type"]},"index":{"type":"integer","description":"The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array."},"promotion_code":{"maxLength":5000,"type":"string","description":"The promotion code to redeem."}},"description":"Details for the `add_discount` type.","x-stripeMostCommon":["coupon","discount","discount_end","index","promotion_code","settings"]},"add_item":{"title":"add_item_specs","required":["price"],"type":"object","properties":{"discounts":{"type":"array","description":"The discounts applied to the item. Subscription item discounts are applied before subscription discounts.","items":{"title":"quote_lines_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"quantity":{"type":"integer","description":"Quantity for this item."},"tax_rates":{"type":"array","description":"The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.","items":{"maxLength":5000,"type":"string"}},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"description":"Details for the `add_item` type.","x-stripeMostCommon":["discounts","metadata","price","quantity","tax_rates","trial","trial_offer"]},"add_metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Details for the `add_metadata` type: specify a hash of key-value pairs."},"remove_discount":{"title":"remove_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to remove from the `discounts` array."},"discount":{"maxLength":5000,"type":"string","description":"The ID of a discount to remove from the `discounts` array."},"promotion_code":{"maxLength":5000,"type":"string","description":"The ID of a promotion code to remove from the `discounts` array."}},"description":"Details for the `remove_discount` type.","x-stripeMostCommon":["coupon","discount","promotion_code"]},"remove_item":{"title":"remove_item_specs","required":["price"],"type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"ID of a price to remove."}},"description":"Details for the `remove_item` type.","x-stripeMostCommon":["price"]},"remove_metadata":{"type":"array","description":"Details for the `remove_metadata` type: specify an array of metadata keys.","items":{"maxLength":5000,"type":"string"}},"set_discounts":{"type":"array","description":"Details for the `set_discounts` type.","items":{"title":"set_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to replace the `discounts` array with."},"discount":{"maxLength":5000,"type":"string","description":"An ID of an existing discount to replace the `discounts` array with."},"promotion_code":{"maxLength":5000,"type":"string","description":"An ID of an existing promotion code to replace the `discounts` array with."}},"x-stripeMostCommon":["coupon","discount","promotion_code","settings"]}},"set_items":{"type":"array","description":"Details for the `set_items` type.","items":{"title":"set_item_specs","required":["price"],"type":"object","properties":{"discounts":{"type":"array","description":"If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.","items":{"title":"quote_lines_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"quantity":{"type":"integer","description":"If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`."},"tax_rates":{"type":"array","description":"If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.","items":{"maxLength":5000,"type":"string"}},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"x-stripeMostCommon":["discounts","metadata","price","quantity","tax_rates","trial","trial_offer"]}},"set_metadata":{"description":"Details for the `set_metadata` type: specify an array of key-value pairs.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"type":{"type":"string","description":"The type of action the quote line performs.","enum":["add_discount","add_item","add_metadata","clear_discounts","clear_metadata","remove_discount","remove_item","remove_metadata","set_discounts","set_items","set_metadata"]}},"x-stripeMostCommon":["add_discount","add_item","add_metadata","remove_discount","remove_item","remove_metadata","set_discounts","set_items","set_metadata","type"]}},"applies_to":{"title":"applies_to_specs","required":["type"],"type":"object","properties":{"new_reference":{"maxLength":50,"type":"string","description":"A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule."},"subscription_schedule":{"maxLength":5000,"type":"string","description":"The ID of the schedule the line applies to."},"type":{"type":"string","description":"Describes whether the quote line is affecting a new schedule or an existing schedule.","enum":["new_reference","subscription_schedule"]}},"description":"Details to identify the subscription schedule the quote line applies to.","x-stripeMostCommon":["new_reference","subscription_schedule","type"]},"billing_cycle_anchor":{"type":"string","description":"For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp. For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.","enum":["automatic","line_starts_at"]},"cancel_subscription_schedule":{"title":"cancel_subscription_schedule_specs","required":["cancel_at"],"type":"object","properties":{"cancel_at":{"type":"string","description":"Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.","enum":["line_starts_at"]},"invoice_now":{"type":"boolean","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. Boolean that defaults to `true`."},"prorate":{"type":"boolean","description":"If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`."}},"description":"A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.","x-stripeMostCommon":["cancel_at","invoice_now","prorate"]},"ends_at":{"title":"ends_at_specs","required":["type"],"type":"object","properties":{"discount_end":{"title":"discount_end_specs","required":["discount"],"type":"object","properties":{"discount":{"maxLength":5000,"type":"string","description":"The ID of a specific discount."}},"description":"Use the `end` time of a given discount.","x-stripeMostCommon":["discount"]},"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the quote line starting from the `starts_at` date.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp.","format":"unix-time"},"type":{"type":"string","description":"Select a way to pass in `ends_at`.","enum":["billing_period_end","discount_end","duration","quote_acceptance_date","schedule_end","timestamp","upcoming_invoice"]}},"description":"Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.","x-stripeMostCommon":["discount_end","duration","timestamp","type"]},"id":{"maxLength":5000,"type":"string","description":"The ID of an existing line on the quote."},"proration_behavior":{"type":"string","description":"Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.","enum":["always_invoice","create_prorations","none"]},"set_pause_collection":{"title":"specs","required":["type"],"type":"object","properties":{"set":{"title":"pause_collection_params","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}}},"description":"Details of the pause_collection behavior to apply to the amendment.","x-stripeMostCommon":["behavior"]},"type":{"type":"string","description":"Determines the type of the pause_collection amendment.","enum":["remove","set"]}},"description":"Defines how to pause collection for the underlying subscription throughout the duration of the amendment.","x-stripeMostCommon":["set","type"]},"set_schedule_end":{"type":"string","description":"Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.","enum":["line_ends_at","line_starts_at"]},"starts_at":{"title":"starts_at_specs","required":["type"],"type":"object","properties":{"discount_end":{"title":"discount_end_specs","required":["discount"],"type":"object","properties":{"discount":{"maxLength":5000,"type":"string","description":"The ID of a specific discount."}},"description":"Use the `end` time of a given discount.","x-stripeMostCommon":["discount"]},"line_ends_at":{"title":"line_index_id_specs","type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The ID of a quote line."},"index":{"type":"integer","description":"The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array."}},"description":"The timestamp the given line ends at.","x-stripeMostCommon":["id","index"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp.","format":"unix-time"},"type":{"type":"string","description":"Select a way to pass in `starts_at`.","enum":["discount_end","line_ends_at","now","quote_acceptance_date","schedule_end","timestamp","upcoming_invoice"]}},"description":"Details to identify the earliest timestamp where the proposed change should take effect.","x-stripeMostCommon":["discount_end","line_ends_at","timestamp","type"]},"trial_settings":{"title":"trial_settings_specs","type":"object","properties":{"end_behavior":{"title":"end_behavior_specs","type":"object","properties":{"prorate_up_front":{"type":"string","description":"Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.","enum":["defer","include"]}},"description":"Defines how the subscription should behave when a trial ends.","x-stripeMostCommon":["prorate_up_front"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"x-stripeMostCommon":["actions","applies_to","billing_cycle_anchor","cancel_subscription_schedule","effective_at","ends_at","id","proration_behavior","set_pause_collection","set_schedule_end","starts_at","trial_settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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 account on behalf of which to charge.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"subscription_data":{"title":"subscription_data_update_params","type":"object","properties":{"bill_on_acceptance":{"description":"Describes the period to bill for upon accepting the quote.","anyOf":[{"title":"bill_on_acceptance_specs","type":"object","properties":{"bill_from":{"title":"bill_from_specs","required":["type"],"type":"object","properties":{"line_starts_at":{"title":"line_index_id_specs","type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The ID of a quote line."},"index":{"type":"integer","description":"The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array."}},"description":"Details of a Quote line to start the bill period from.","x-stripeMostCommon":["id","index"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp.","format":"unix-time"},"type":{"type":"string","description":"The type of method to specify the `bill_from` time.","enum":["line_starts_at","now","pause_collection_start","quote_acceptance_date","timestamp"]}},"description":"The start of the period to bill from when the Quote is accepted.","x-stripeMostCommon":["line_starts_at","timestamp","type"]},"bill_until":{"title":"bill_until_specs","required":["type"],"type":"object","properties":{"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Details of the duration over which to bill.","x-stripeMostCommon":["interval","interval_count"]},"line_ends_at":{"title":"line_index_id_specs","type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The ID of a quote line."},"index":{"type":"integer","description":"The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array."}},"description":"Details of a Quote line item from which to bill until.","x-stripeMostCommon":["id","index"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp.","format":"unix-time"},"type":{"type":"string","description":"The type of method to specify the `bill_until` time.","enum":["duration","line_ends_at","schedule_end","timestamp","upcoming_invoice"]}},"description":"The end of the period to bill until when the Quote is accepted.","x-stripeMostCommon":["duration","line_ends_at","timestamp","type"]}},"x-stripeMostCommon":["bill_from","bill_until"]},{"type":"string","enum":[""]}]},"billing_behavior":{"type":"string","description":"Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.","enum":["prorate_on_next_phase","prorate_up_front"]},"billing_cycle_anchor":{"type":"string","description":"When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.","enum":["","reset"]},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"effective_date":{"description":"When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.","anyOf":[{"maxLength":5000,"type":"string","enum":["current_period_end"]},{"type":"integer","format":"unix-time"},{"type":"string","enum":[""]}]},"end_behavior":{"type":"string","description":"Behavior of the subscription schedule and underlying subscription when it ends.","enum":["cancel","release"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/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."},"prebilling":{"description":"If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.","anyOf":[{"title":"prebilling_preview_params","required":["iterations"],"type":"object","properties":{"iterations":{"type":"integer","description":"This is used to determine the number of billing cycles to prebill."}},"x-stripeMostCommon":["iterations"]},{"type":"string","enum":[""]}]},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.","enum":["always_invoice","create_prorations","none"]},"trial_period_days":{"description":"Integer representing the number of trial period days before the customer is charged for the first time.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]}},"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.","x-stripeMostCommon":["bill_on_acceptance","billing_behavior","billing_cycle_anchor","billing_schedules","description","effective_date","end_behavior","metadata","phase_effective_at","prebilling","proration_behavior","trial_period_days"]},"subscription_data_overrides":{"description":"List representing overrides for `subscription_data` configurations for specific subscription schedules.","anyOf":[{"type":"array","items":{"title":"update_specs","required":["applies_to"],"type":"object","properties":{"applies_to":{"title":"applies_to_specs","required":["type"],"type":"object","properties":{"new_reference":{"maxLength":50,"type":"string","description":"A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule."},"subscription_schedule":{"maxLength":5000,"type":"string","description":"The ID of the schedule the line applies to."},"type":{"type":"string","description":"Describes whether the quote line is affecting a new schedule or an existing schedule.","enum":["new_reference","subscription_schedule"]}},"description":"Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.","x-stripeMostCommon":["new_reference","subscription_schedule","type"]},"bill_on_acceptance":{"description":"Describes the period to bill for upon accepting the quote.","anyOf":[{"title":"bill_on_acceptance_specs","type":"object","properties":{"bill_from":{"title":"bill_from_specs","required":["type"],"type":"object","properties":{"line_starts_at":{"title":"line_index_id_specs","type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The ID of a quote line."},"index":{"type":"integer","description":"The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array."}},"description":"Details of a Quote line to start the bill period from.","x-stripeMostCommon":["id","index"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp.","format":"unix-time"},"type":{"type":"string","description":"The type of method to specify the `bill_from` time.","enum":["line_starts_at","now","pause_collection_start","quote_acceptance_date","timestamp"]}},"description":"The start of the period to bill from when the Quote is accepted.","x-stripeMostCommon":["line_starts_at","timestamp","type"]},"bill_until":{"title":"bill_until_specs","required":["type"],"type":"object","properties":{"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Details of the duration over which to bill.","x-stripeMostCommon":["interval","interval_count"]},"line_ends_at":{"title":"line_index_id_specs","type":"object","properties":{"id":{"maxLength":5000,"type":"string","description":"The ID of a quote line."},"index":{"type":"integer","description":"The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array."}},"description":"Details of a Quote line item from which to bill until.","x-stripeMostCommon":["id","index"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp.","format":"unix-time"},"type":{"type":"string","description":"The type of method to specify the `bill_until` time.","enum":["duration","line_ends_at","schedule_end","timestamp","upcoming_invoice"]}},"description":"The end of the period to bill until when the Quote is accepted.","x-stripeMostCommon":["duration","line_ends_at","timestamp","type"]}},"x-stripeMostCommon":["bill_from","bill_until"]},{"type":"string","enum":[""]}]},"billing_behavior":{"type":"string","description":"Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.","enum":["prorate_on_next_phase","prorate_up_front"]},"customer":{"maxLength":5000,"type":"string","description":"The customer the Subscription Data override applies to."},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"end_behavior":{"type":"string","description":"Behavior of the subscription schedule and underlying subscription when it ends.","enum":["cancel","release"]},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.\n\nWhen updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.\n\nPassing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.\n\nProrations can be disabled by passing `none`.","enum":["always_invoice","create_prorations","none"]}},"x-stripeMostCommon":["applies_to","bill_on_acceptance","billing_behavior","billing_schedules","customer","description","end_behavior","phase_effective_at","proration_behavior"]}},{"type":"string","enum":[""]}]},"transfer_data":{"description":"The data with which to automatically create a Transfer for each of the invoices.","anyOf":[{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field."},"amount_percent":{"type":"number","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. There must be at least 1 line item with a recurring price to use this field."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"x-stripeMostCommon":["amount","amount_percent","destination"]},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["line_items","metadata"]},"encoding":{"application_fee_amount":{"style":"deepObject","explode":true},"application_fee_percent":{"style":"deepObject","explode":true},"automatic_tax":{"style":"deepObject","explode":true},"default_tax_rates":{"style":"deepObject","explode":true},"description":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"footer":{"style":"deepObject","explode":true},"header":{"style":"deepObject","explode":true},"invoice_settings":{"style":"deepObject","explode":true},"line_items":{"style":"deepObject","explode":true},"lines":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"on_behalf_of":{"style":"deepObject","explode":true},"subscription_data":{"style":"deepObject","explode":true},"subscription_data_overrides":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_quote"}},"/v1/quotes/{quote}/accept":{"post":{"summary":"Accept a quote","description":"Accepts the specified quote.
","operationId":"PostQuotesQuoteAccept","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"accept_billing_quote"}},"/v1/quotes/{quote}/cancel":{"post":{"summary":"Cancel a quote","description":"Cancels the quote.
","operationId":"PostQuotesQuoteCancel","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_billing_quote"}},"/v1/quotes/{quote}/computed_upfront_line_items":{"get":{"summary":"Retrieve a quote's upfront line items","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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourceListLineItems","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_upfront_line_items_billing_quote"}},"/v1/quotes/{quote}/finalize":{"post":{"summary":"Finalize a quote","description":"Finalizes the quote.
","operationId":"PostQuotesQuoteFinalize","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"expires_at":{"type":"integer","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"}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"finalize_billing_quote"}},"/v1/quotes/{quote}/line_items":{"get":{"summary":"Retrieve a quote's line items","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":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourceListLineItems","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_quote_line_items"}},"/v1/quotes/{quote}/lines":{"get":{"summary":"Retrieve a quote's lines","description":"Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
","operationId":"GetQuotesQuoteLines","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourceListLines","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/quote_line"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_quote_lines"}},"/v1/quotes/{quote}/mark_draft":{"post":{"summary":"Convert a quote to draft","description":"Converts a stale quote to draft.
","operationId":"PostQuotesQuoteMarkDraft","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"mark_draft_billing_quote"}},"/v1/quotes/{quote}/mark_stale":{"post":{"summary":"Convert a quote to stale","description":"Converts a draft or open quote to stale.
","operationId":"PostQuotesQuoteMarkStale","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"reason":{"maxLength":500,"type":"string","description":"Reason the Quote is being marked stale."}},"additionalProperties":false,"x-stripeMostCommon":["reason"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"mark_stale_billing_quote"}},"/v1/quotes/{quote}/pdf":{"get":{"summary":"Download quote PDF","description":"Download the PDF for a finalized quote. Explanation for special handling can be found here
","operationId":"GetQuotesQuotePdf","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"servers":[{"url":"https://files.stripe.com/"}],"x-stableId":"download_pdf_billing_quote"}},"/v1/quotes/{quote}/preview_invoices":{"get":{"summary":"Retrieve a quote's preview invoices","description":"Preview the invoices that would be generated by accepting the quote.
","operationId":"GetQuotesQuotePreviewInvoices","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourcePreviewInvoiceList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/quote_preview_invoice"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_preview_invoices_billing_quote"}},"/v1/quotes/{quote}/preview_invoices/{preview_invoice}/lines":{"get":{"summary":"Retrieve a quote's preview invoice line items","description":"Preview the invoice line items that would be generated by accepting the quote.
","operationId":"GetQuotesQuotePreviewInvoicesPreviewInvoiceLines","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"preview_invoice","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourcePreviewInvoiceLineItemsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_preview_invoice_line_items_billing_quote"}},"/v1/quotes/{quote}/preview_subscription_schedules":{"get":{"summary":"Retrieve a quote's preview schedules","description":"Preview the schedules that would be generated by accepting the quote
","operationId":"GetQuotesQuotePreviewSubscriptionSchedules","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"QuotesResourcePreviewsSchedulesScheduleList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/quote_preview_subscription_schedule"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"preview_subscription_schedules_billing_quote"}},"/v1/quotes/{quote}/reestimate":{"post":{"summary":"Reestimate a quote","description":"Recompute the upcoming invoice estimate for the quote.
","operationId":"PostQuotesQuoteReestimate","parameters":[{"name":"quote","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/quote"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"reestimate_billing_quote"}},"/v1/radar/billing_evaluations":{"post":{"summary":"Create a Billing Evaluation","description":"Request Stripe Radar’s assessment of the non-payment abuse risk of an upcoming charge, before the payment is attempted.
","operationId":"PostRadarBillingEvaluations","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["customer_details","payment_details"],"type":"object","properties":{"client_device_metadata_details":{"title":"client_device_metadata_wrapper_api_params","required":["radar_session"],"type":"object","properties":{"radar_session":{"maxLength":5000,"type":"string","description":"ID for the Radar Session to associate with the billing evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions about the customer behind the upcoming payment."}},"description":"Details about the client device to associate with the billing evaluation.","x-stripeMostCommon":["radar_session"]},"customer_details":{"title":"customer_details_api_params","type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"The ID of the customer whose upcoming payment is being evaluated."},"customer_account":{"maxLength":5000,"type":"string","description":"The ID of the Account representing the customer whose upcoming payment is being evaluated."},"data":{"title":"customer_details_data_api_params","type":"object","properties":{"email":{"type":"string","description":"The email address of the customer being evaluated."},"name":{"maxLength":5000,"type":"string","description":"The full name or business name of the customer being evaluated."},"phone":{"type":"string","description":"The phone number of the customer being evaluated."}},"description":"Attributes of the customer being evaluated. Exactly one of `customer`, `customer_account`, and `data` must be supplied: use `data` when the customer isn't represented by a Customer or an Account.","x-stripeMostCommon":["email","name","phone"]}},"description":"Details about the customer whose upcoming payment is being evaluated.","x-stripeMostCommon":["customer","customer_account","data"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_details":{"title":"payment_details_api_params","required":["amount","currency","payment_method_details"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount that the upcoming payment collects. A positive integer representing how much is charged in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary description of the upcoming payment."},"money_movement_details":{"title":"money_movement_details_api_params","required":["money_movement_type"],"type":"object","properties":{"card":{"title":"money_movement_card_additional_data","type":"object","properties":{"customer_presence":{"type":"string","description":"Describes the presence of the customer during the payment.","enum":["off_session","on_session"]},"payment_type":{"type":"string","description":"Describes the type of payment.","enum":["one_off","recurring","setup_one_off","setup_recurring"]}},"description":"Describes card money movement details.","x-stripeMostCommon":["customer_presence","payment_type"]},"money_movement_type":{"type":"string","description":"Describes the type of money movement. Currently only `card` is supported.","enum":["card"],"x-stripeEnum":{"kind":"open","values":[{"description":"The money movement details for a card payment.","value":"card"}]}}},"description":"Details about how the money for the upcoming payment moves.","x-stripeMostCommon":["card","money_movement_type"]},"payment_method_details":{"title":"payment_method_details_api_params","required":["payment_method"],"type":"object","properties":{"billing_details":{"title":"billing_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Billing address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"Email address."},"name":{"maxLength":5000,"type":"string","description":"Full name."},"phone":{"type":"string","description":"Billing phone number (including extension)."}},"description":"Billing information associated with the payment method used for the upcoming payment.","x-stripeMostCommon":["address","email","name","phone"]},"payment_method":{"maxLength":5000,"type":"string","description":"ID of the payment method that the upcoming payment is charged to."}},"description":"Details about the payment method that the upcoming payment is charged to.","x-stripeMostCommon":["billing_details","payment_method"]},"shipping_details":{"title":"shipping_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Shipping name."},"phone":{"type":"string","description":"Shipping phone number."}},"description":"Shipping details for the goods or services covered by the upcoming payment.","x-stripeMostCommon":["address","name","phone"]},"statement_descriptor":{"maxLength":5000,"type":"string","description":"The statement descriptor that appears on the customer's statement for the upcoming payment."}},"description":"Details about the upcoming payment being evaluated.","x-stripeMostCommon":["amount","currency","description","money_movement_details","payment_method_details","shipping_details","statement_descriptor"]}},"additionalProperties":false,"x-stripeMostCommon":["client_device_metadata_details","customer_details","metadata","payment_details"]},"encoding":{"client_device_metadata_details":{"style":"deepObject","explode":true},"customer_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/radar.billing_evaluation"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"billing_evaluations_create_method"}},"/v1/radar/early_fraud_warnings":{"get":{"summary":"List all early fraud warnings","description":"Returns a list of early fraud warnings.
","operationId":"GetRadarEarlyFraudWarnings","parameters":[{"name":"charge","in":"query","description":"Only return early fraud warnings for the charge specified by this charge ID.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"created","in":"query","description":"Only return early fraud warnings that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_intent","in":"query","description":"Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"RadarEarlyFraudWarningList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/radar.early_fraud_warning"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/radar/early_fraud_warnings","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_radar_early_fraud_warnings"}},"/v1/radar/early_fraud_warnings/{early_fraud_warning}":{"get":{"summary":"Retrieve an early fraud warning","description":"Retrieves the details of an early fraud warning that has previously been created.
\n\nPlease refer to the early fraud warning object reference for more details.
","operationId":"GetRadarEarlyFraudWarningsEarlyFraudWarning","parameters":[{"name":"early_fraud_warning","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/radar.early_fraud_warning"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_radar_early_fraud_warning"}},"/v1/radar/payment_evaluations":{"post":{"summary":"Create a Payment Evaluation","description":"Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.
","operationId":"PostRadarPaymentEvaluations","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["customer_details","payment_details"],"type":"object","properties":{"client_device_metadata_details":{"title":"client_device_metadata_wrapper","required":["radar_session"],"type":"object","properties":{"radar_session":{"maxLength":5000,"type":"string","description":"ID for the Radar Session to associate with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."}},"description":"Details about the Client Device Metadata to associate with the payment evaluation.","x-stripeMostCommon":["data","radar_session"]},"customer_details":{"title":"customer_details","type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"The ID of the customer associated with the payment evaluation."},"customer_account":{"maxLength":5000,"type":"string","description":"The ID of the Account representing the customer associated with the payment evaluation."},"email":{"type":"string","description":"The customer's email address."},"name":{"maxLength":5000,"type":"string","description":"The customer's full name or business name."},"phone":{"type":"string","description":"The customer's phone number."}},"description":"Details about the customer associated with the payment evaluation.","x-stripeMostCommon":["customer","customer_account","email","name","phone"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_details":{"title":"payment_details","required":["amount","currency","payment_method_details"],"type":"object","properties":{"amount":{"type":"integer","description":"The intended amount to collect with this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"money_movement_details":{"title":"money_movement_details","required":["money_movement_type"],"type":"object","properties":{"card":{"title":"money_movement_card_additional_data","type":"object","properties":{"customer_presence":{"type":"string","description":"Describes the presence of the customer during the payment.","enum":["off_session","on_session"]},"payment_type":{"type":"string","description":"Describes the type of payment.","enum":["one_off","recurring","setup_one_off","setup_recurring"]}},"description":"Describes card money movement details.","x-stripeMostCommon":["customer_presence","payment_type"]},"money_movement_type":{"type":"string","description":"Describes the type of money movement.","enum":["card"],"x-stripeBypassValidation":true}},"description":"Details about the payment's customer presence and type.","x-stripeMostCommon":["card","money_movement_type","us_bank_account"]},"payment_method_details":{"title":"payment_method_details","required":["payment_method"],"type":"object","properties":{"billing_details":{"title":"billing_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Billing address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"Email address."},"name":{"maxLength":5000,"type":"string","description":"Full name."},"phone":{"type":"string","description":"Billing phone number (including extension)."}},"description":"Billing information associated with the payment evaluation.","x-stripeMostCommon":["address","email","name","phone"]},"payment_method":{"maxLength":5000,"type":"string","description":"ID of the payment method used in this payment evaluation."}},"description":"Details about the payment method to use for the payment.","x-stripeMostCommon":["billing_details","card","payment_method"]},"shipping_details":{"title":"shipping_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Shipping name."},"phone":{"type":"string","description":"Shipping phone number."}},"description":"Shipping details for the payment evaluation.","x-stripeMostCommon":["address","name","phone"]},"statement_descriptor":{"maxLength":5000,"type":"string","description":"Payment statement descriptor."}},"description":"Details about the payment.","x-stripeMostCommon":["amount","currency","description","money_movement_details","payment_method_details","shipping_details","statement_descriptor"]}},"additionalProperties":false,"x-stripeMostCommon":["client_device_metadata_details","customer_details","metadata","payment_details"]},"encoding":{"client_device_metadata_details":{"style":"deepObject","explode":true},"customer_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/radar.payment_evaluation"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"payment_evaluations_create_method"}},"/v1/radar/value_list_items":{"get":{"summary":"List all value list items","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.
Creates a new ValueListItem object, which is added to the specified parent value list.
Retrieves a ValueListItem object.
Deletes a ValueListItem object, removing it from its parent value list.
Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Creates a new ValueList object, which can then be referenced in rules.
Retrieves a ValueList object.
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.
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.
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":[{"name":"charge","in":"query","description":"Only return refunds for the charge specified by this charge ID.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"created","in":"query","description":"Only return refunds that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_intent","in":"query","description":"Only return refunds for the PaymentIntent specified by this ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"APIMethodRefundList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/refund"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/refunds","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_refunds"},"post":{"summary":"Create a refund","description":"When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
\n\nCreating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.
\n\nYou can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.
\n\nOnce entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.
","operationId":"PostRefunds","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer"},"charge":{"maxLength":5000,"type":"string","description":"The identifier of the charge to refund."},"currency":{"type":"string","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).","format":"currency"},"customer":{"maxLength":5000,"type":"string","description":"Customer whose customer balance to refund from."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"instructions_email":{"type":"string","description":"For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"origin":{"type":"string","description":"Origin of the refund","enum":["customer_balance"]},"payment_intent":{"maxLength":5000,"type":"string","description":"The identifier of the PaymentIntent to refund."},"reason":{"maxLength":5000,"type":"string","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://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms.","enum":["duplicate","fraudulent","requested_by_customer"]},"refund_application_fee":{"type":"boolean","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."},"reverse_transfer":{"type":"boolean","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).Retrieves the details of an existing refund.
","operationId":"GetRefundsRefund","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"refund","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/refund"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_refund"},"post":{"summary":"Update a refund","description":"Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.
\n\nThis request only accepts metadata as an argument.
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.
Returns a list of Report Runs, with the most recent appearing first.
","operationId":"GetReportingReportRuns","parameters":[{"name":"created","in":"query","description":"Only return Report Runs that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"FinancialReportingFinanceReportRunList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reporting.report_run"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/reporting/report_runs","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_report_runs"},"post":{"summary":"Create a Report Run","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":{"schema":{"required":["report_type"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"parameters":{"title":"run_parameter_specs","type":"object","properties":{"columns":{"type":"array","description":"The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set.","items":{"maxLength":5000,"type":"string"}},"connected_account":{"type":"string","description":"Connected account ID to filter for in the report run."},"currency":{"type":"string","description":"Currency of objects to be included in the report run.","format":"currency"},"interval_end":{"type":"integer","description":"Ending timestamp of data to be included in the report run (exclusive).","format":"unix-time"},"interval_start":{"type":"integer","description":"Starting timestamp of data to be included in the report run.","format":"unix-time"},"payout":{"type":"string","description":"Payout ID by which to filter the report run."},"reporting_category":{"maxLength":5000,"type":"string","description":"Category of balance transactions to be included in the report run.","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"],"x-stripeBypassValidation":true},"timezone":{"maxLength":5000,"type":"string","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`.","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/Coyhaique","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"]}},"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://docs.stripe.com/reporting/statements/api) documentation.","x-stripeMostCommon":["abuse_reasons","abuse_score","accessed_livemode_secret_api_keys","account","account_status","account_type","account_types","accounts","acquirer_bin","acquirer_mid","action","actions","activation_days","active","active_levy","active_lien","adoption_type","age_bucket","agent","aggregate","aggregation_formula","aggregation_type","all","amount","amount_due","amount_filter","amount_max","amount_min","amount_total","api_version","apple_subscriber","application_id","arrival_date","async_fees","attempt_count","attempted","authentication_outcome_detailed","auto_advance","automatic_tax_enabled","automatically_finalizes_at","balance_source_types","balance_types","bank_failure_category","bank_failure_raw_code","beneficiary_reference","billable_item_ids","billing_analytics_metric","billing_cadence","billing_reason","brand","browser_fingerprinting","bucket_seconds","bucket_size","business_type","buyer_country","calculation_type","campaign","campaign_id","campaign_id_missing","campaigns","capability","capability_status_card_payments","capability_status_issuing","capability_status_payouts","capability_status_treasury","capability_type","capability_types","card_bin","card_brand","card_brands","card_category","card_country","card_fingerprint","card_funding","card_input_methods","card_network","card_number","card_present_device_identifier","card_present_device_type","card_type","card_types","cards_last_4","categories","cau_correction_factor","channel","charge","cluster_table_suffix","cof","cohort","cohort_file","collection_method","collection_statuses","columns","compare_to_end","compare_to_start","compartment_ids","compliance_charge_pause_at_ms","compliance_payout_pause_at_ms","configurations","connect_account_country","connect_charge_type","connect_merchant_pv_180d","connect_merchant_pv_30d","connect_merchant_pv_35d","connect_merchant_pv_365d","connect_merchant_pv_90d","connected_account","connected_account_countries","connected_account_country","connected_account_id","connected_accounts","connected_on_filter","contract","conversion_currency","convert_to_arr","counterparty_name","countries","country","coupon","created","credit_ids","currencies","currency","cursor","cursor_created_at","cursor_forward_direction","cursor_payment_attempt_id","custom_payment_method_type","customer","customer_countries","customer_coupon_ids","customer_created","customer_dispute_volume","customer_email","customer_filters","customer_first_payment","customer_has_remaining_balance","customer_id","customer_last_payment","customer_metadata","customer_mrr","customer_name","customer_net_volume","customer_outstanding_balance","customer_payment_count","customer_query","customer_refund_volume","customer_type","customers","cutoff_date","dashboard_type","dataset_id","date_format","days_to_use","debit_negative_balances","decimal_separator","decline_reason","delinquent","description","digital_only_countries","digital_wallet","direction","display_date","display_mode","display_name","dispute_amount","dispute_reason","dispute_reasons","dispute_status","dispute_volume","disputed_on","distribution_type","download","due_date","dynamic_reporting_params","earliest_due_on","email","enabled","end_payer_country","endpoint_url","entity_type","entry_type","event_name","event_time_window","event_type","evidence_due_by","evidence_submitted_at","exchange_rate","exchange_rates","exclude_meter_ids","excluded_countries","experiment_id","experiment_statuses","external_sanctions_status","fee_category","fee_rows","fees_payer","fields","filter_active_accounts","filter_column","filter_columns","filter_currency","filter_product_adopted","filter_topics","filter_value","filter_values","filters","filters_by_meter","finalized_at","financial_account","financial_account_currency_pairs","financial_account_types","financial_accounts","first_day_of_week_offset","first_payment","flow_granted","flow_ids","flow_preference","flow_types","fraud_risk_score","gateway_conversation_avs_outcome","gateway_conversation_cvc_outcome","gateway_country","gl_code","google_order","grain","grams","granularity","gross_amount","group_by","group_by_key","group_by_keys","group_by_keys_by_meter","group_id","group_type","grouped_column","grouped_columns","grouped_metadata_column","groups","guest_customer_id","has_app_fee_refunds","has_app_fees","has_charge_last_30d","has_charge_last_365d","has_charge_last_60d","has_charge_last_90d","has_click_id","has_disputes","has_negative_earnings_from_transfers","has_payment_activity_last_30d","has_payment_activity_last_365d","has_payment_activity_last_60d","has_payment_activity_last_90d","has_refunds","has_remaining_balance","has_reversals","has_subscription","has_successful_payment","has_tax_code","hosted_relink_requested_at","impacted_capability","include_blocked_payments","include_connect_charges","include_efw","include_protected_disputes","inclusive","incurred_by","institution_name","interaction_type","interval_end","interval_end_date_as_string","interval_start","interval_start_date_as_string","intervention_type","invoice","invoice_hint","invoice_id","invoice_line_item","ip_address","ip_country","is_agent_transaction","is_backtest","is_cloned","is_controller","is_domestic","is_eu_vat_moss","is_latam","is_link_in_pmm_supported","is_on_session_toggled","is_rule_matched","is_top_fraudy_attributes","is_unbilled","jurisdiction_key","keyword","last4","last_active_on","last_activity_timeframe","last_issuing_transaction_on","last_payment","last_payout_on","last_transaction_on","legal_entity_type","legal_entity_type_ch_mapping","legal_entity_types","limit","list_item","list_items","livemode","location_ids","lookup_key","losses_payments","managed_payments","margin_uplift_lower","margin_uplift_upper","match_mode","match_status","max_churn","merchant_activity","merchant_ids","message_category","metadata","metadata_columns","metadata_key_filter","meter_id","meter_ids","metric","min_active_days","min_payout_count","min_payouts_volume_usd","min_trim_size","mor","moto","name","nci_filter_for","nci_mcc","net_volume","network_types","next_payment_attempt","numeric_filters","object_definition_id","offer_ids","offer_types","offset","on_behalf_of","onboarding_status","onboarding_surface","orchestrated_commerce_agreements","outcome","outstanding_balance","outstanding_date","override_artificial_delay","pagination_direction","paid","past_due","pause_collection","payment_balance_filter","payment_count","payment_link_id","payment_method","payment_method_type","payment_method_types","payment_methods","payment_processors","payment_record_scope","payout","payout_date_end","payout_date_start","payout_schedule","payout_status","payout_type","percentage","period_type","permission_config_can_access_apikeys","permission_config_can_access_billing","permission_config_can_access_disputes","permission_config_can_access_payment_capture","permission_config_can_access_payment_links","permission_config_can_access_payments","permission_config_can_access_payout_schedule","permission_config_can_access_payouts","permission_config_can_access_refunds","permission_config_can_access_topups","permission_config_livemode","platform","platform_account_id","platform_id","platform_ids_filter","posted_at","prebilled","price_filters","price_ids","processor","processor_type","processors","product","product_catalog_status","product_feature_description","product_features","product_filters","product_ids","products","program","provider","pv_t180_tier","pv_t30_tier","pv_t35_tier","pv_t365_tier","pv_t90_tier","query","query_options","radar_bad_outcome_configuration","radar_fraud_outcomes","radar_good_outcomes","rate","rate_card_ids","recipient_action_filter","recipient_network_business_profile_id","recipient_payout_method_types","recipient_primary_payout_method_card_brand","recipient_primary_payout_method_last_4","recipient_primary_payout_method_type","recipient_primary_payout_method_wallet_type","recognition_end","recognition_start","recon_party_name","recon_space","recon_space_type","reconciliation_status","reference_id","refund_status","refund_volume","regions","rejected_by","rejected_on","rejected_reason","reported_outcomes","reporting_category","reporting_string_filters","requirement","requirement_collection","requirement_group","requirement_status","requirement_trigger","requirement_update","requirement_update_status","reserve_release_end","reserve_release_start","reserve_types","restricted_on","retries_correction_factor","retrieve_on_behalf_of_disputes","retry_status","rev_rec_month_summary_line_item","risk_level","risk_score","roles","rule_action","rule_attribute","rule_attribute_case_insensitive","rule_attribute_name_value","rule_id","rule_matched_on","rule_predicate_sql","rules","ryw_created_ids","ryw_deleted_ids","ryw_updated_ids","scheduled_payment","search_after","search_params","secondary_cursor","seconds_since_card_first_seen","segment_id","serial_numbers","service_agreement","simulated_fixed_app_fee_amount","simulated_max_app_fee_amount","simulated_min_app_fee_amount","simulated_variable_app_fee_rate","sort_field","sort_field_type","sort_order","sorted_column","source","state","states","status","status_details_active_action","status_details_active_cause","status_details_active_expected_deactivation_date","statuses","string_filters","string_query","subscription","subscription_status","sync_fees","t30_pv_active","t365_pv_active","t60_pv_active","t90_pv_active","table_list","table_name","tax_amount","tax_form_id","tax_registration_status","tax_settings_status","tax_threshold_status","tax_type","taxable","tds_result","tds_triggered","tds_type","template_override","tenant_filters","tenant_filters_by_meter","tenant_group_by_keys_by_meter","terminal_location","terminal_reader","test_clocked","three_d_s_outcome","time_granularity","timezone","top_connected_accounts","total","total_charges_per_card_number_daily","total_fraud_volume","total_legitimate_volume","tracking_load_type","transaction_age_max","transaction_age_min","transaction_id","transaction_initiators","transaction_type","transfer_instruction","transferred_to","type","unit","updated","ur","usage_id","use_dispute_creation_date","use_minerva","used_network_tokens","utm_medium","utm_source","utm_sources","verification_attempt_timestamp","view_type","volume_filter","volume_metric_type","win_chance","window_key","write_access_extension_connection"]},"report_type":{"type":"string","description":"The ID of the [report type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `\"balance.summary.1\"`."}},"additionalProperties":false,"x-stripeMostCommon":["parameters","report_type"]},"encoding":{"expand":{"style":"deepObject","explode":true},"parameters":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting.report_run"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_report_run"}},"/v1/reporting/report_runs/{report_run}":{"get":{"summary":"Retrieve a Report Run","description":"Retrieves the details of an existing Report Run.
","operationId":"GetReportingReportRunsReportRun","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"report_run","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting.report_run"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_report_run"}},"/v1/reporting/report_types":{"get":{"summary":"List all Report Types","description":"Returns a full list of Report Types.
","operationId":"GetReportingReportTypes","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"FinancialReportingFinanceReportTypeList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reporting.report_type"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_report_types"}},"/v1/reporting/report_types/{report_type}":{"get":{"summary":"Retrieve a Report Type","description":"Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
","operationId":"GetReportingReportTypesReportType","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"report_type","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting.report_type"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_report_type"}},"/v1/reserve/holds":{"get":{"summary":"List ReserveHolds","description":"Returns a list of ReserveHolds previously created. The ReserveHolds are returned in sorted order, with the most recent ReserveHolds appearing first.
","operationId":"GetReserveHolds","parameters":[{"name":"currency","in":"query","description":"Only return ReserveHolds associated with the currency specified by this currency code. 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":false,"style":"form","explode":true,"schema":{"type":"string","format":"currency"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"is_releasable","in":"query","description":"Only return ReserveHolds that are releasable.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"reason","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["charge","standalone"]}},{"name":"reserve_plan","in":"query","description":"Only return ReserveHolds associated with the ReservePlan specified by this ReservePlan ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"reserve_release","in":"query","description":"Only return ReserveHolds associated with the ReserveRelease specified by this ReserveRelease ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"source_charge","in":"query","description":"Only return ReserveHolds associated with the Charge specified by this source charge ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ReserveHoldList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reserve.hold"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_reserve_holds"}},"/v1/reserve/holds/{id}":{"get":{"summary":"Retrieve a ReserveHold","description":"Retrieve a ReserveHold.
","operationId":"GetReserveHoldsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The identifier of the ReserveHold to retrieve.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reserve.hold"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"get_reserve_hold"}},"/v1/reserve/plans":{"get":{"summary":"List ReservePlans","description":"Returns a list of ReservePlans previously created. The ReservePlans are returned in sorted order, with the most recent ReservePlans appearing first.
","operationId":"GetReservePlans","parameters":[{"name":"destination","in":"query","description":"Only return ReservePlans with the specified destination. If omitted, returns ReservePlans with any destination.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["risk_reserved","settlement_reserved"],"x-stripeEnum":{"kind":"open","values":[{"description":"Funds are held in the risk reserved balance.","value":"risk_reserved"},{"description":"Funds are held in the settlement reserved balance.","value":"settlement_reserved"}]}}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return ReservePlans with the specified status. If omitted, returns ReservePlans with any status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["active","disabled","expired"],"x-stripeEnum":{"kind":"open","values":[{"description":"The ReservePlan is active and reserving funds.","value":"active"},{"description":"The ReservePlan has been manually disabled and is no longer reserving funds, and its associated funds have been released.","value":"disabled"},{"description":"The ReservePlan has expired automatically and is no longer reserving funds, and its associated funds have been released.","value":"expired"}]}}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ReservePlanList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reserve.plan"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_reserve_plans"}},"/v1/reserve/plans/{id}":{"get":{"summary":"Retrieve a ReservePlan","description":"Retrieve a ReservePlan.
","operationId":"GetReservePlansId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The identifier of the ReservePlan to retrieve.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reserve.plan"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"get_reserve_plan"}},"/v1/reserve/releases":{"get":{"summary":"List ReserveReleases","description":"Returns a list of ReserveReleases previously created. The ReserveReleases are returned in sorted order, with the most recent ReserveReleases appearing first.
","operationId":"GetReserveReleases","parameters":[{"name":"currency","in":"query","description":"Only return ReserveReleases associated with the currency specified by this currency code. 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":false,"style":"form","explode":true,"schema":{"type":"string","format":"currency"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"reserve_hold","in":"query","description":"Only return ReserveReleases associated with the ReserveHold specified by this ReserveHold ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"reserve_plan","in":"query","description":"Only return ReserveReleases associated with the ReservePlan specified by this ReservePlan ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ReserveReleaseList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reserve.release"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_reserve_releases"}},"/v1/reserve/releases/{id}":{"get":{"summary":"Retrieve a ReserveRelease","description":"Retrieve a ReserveRelease.
","operationId":"GetReserveReleasesId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","description":"The identifier of the ReserveRelease to retrieve.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reserve.release"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"get_reserve_release"}},"/v1/reviews":{"get":{"summary":"List all open reviews","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.
Retrieves a Review object.
Approves a Review object, closing it and removing it from the list of reviews.
Returns a list of SetupAttempts that associate with a provided SetupIntent.
","operationId":"GetSetupAttempts","parameters":[{"name":"created","in":"query","description":"A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp or a\ndictionary with a number of different query options.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"setup_intent","in":"query","description":"Only return SetupAttempts created by the SetupIntent specified by\nthis ID.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentFlowsSetupIntentSetupAttemptList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/setup_attempt"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/setup_attempts","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_setup_attempts"}},"/v1/setup_intents":{"get":{"summary":"List all SetupIntents","description":"Returns a list of SetupIntents.
","operationId":"GetSetupIntents","parameters":[{"name":"attach_to_self","in":"query","description":"If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt 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.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return SetupIntents for the customer specified by this customer ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"Only return SetupIntents for the account specified by this customer ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payment_method","in":"query","description":"Only return SetupIntents that associate with the specified payment method.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"PaymentFlowsSetupIntentList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/setup_intent"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/setup_intents","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_setup_intents"},"post":{"summary":"Create a SetupIntent","description":"Creates a SetupIntent object.
\n\nAfter you create the SetupIntent, attach a payment method and confirm\nit to collect any required permissions to charge the payment method later.
","operationId":"PostSetupIntents","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"allowed_payment_method_types":{"type":"array","description":"The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).","items":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boku_promptpay","boleto","capchase_pay","card","card_present","cashapp","check_scan","click_to_pay","crypto","customer_balance","demo_pay","duitnow","dummy_auth_push","dummy_passthrough_card","edenred","eps","fpx","gcash","getbalance","gift_card","giropay","gopay","grabpay","id_bank_transfer","ideal","interac_present","kakao_pay","klarna","knet","konbini","kr_card","kr_market","kriya","link","mb_way","mobilepay","momo","mondu","multibanco","naver_pay","netbanking","ng_bank","ng_bank_transfer","ng_card","ng_market","ng_ussd","ng_wallet","nz_bank_account","octopus","oxxo","p24","paper_check","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shop_pay","shopeepay","sofort","south_korea_market","stripe_balance","sunbit","swish","tamara","test_pay","touch_n_go","truemoney","twint","upi","us_bank_account","us_cash_voucher","vipps","wechat_pay","wero","zip"],"x-stripeBypassValidation":true}},"attach_to_self":{"type":"boolean","description":"If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."},"automatic_payment_methods":{"title":"automatic_payment_methods_param","required":["enabled"],"type":"object","properties":{"allow_redirects":{"type":"string","description":"Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.","enum":["always","never"]},"enabled":{"type":"boolean","description":"Whether this feature is enabled."}},"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.","x-stripeMostCommon":["allow_redirects","enabled"]},"confirm":{"type":"boolean","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."},"confirmation_token":{"maxLength":5000,"type":"string","description":"ID of the ConfirmationToken used to confirm this SetupIntent.\n\nIf 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."},"customer":{"maxLength":5000,"type":"string","description":"ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent."},"customer_account":{"maxLength":5000,"type":"string","description":"ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent."},"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"excluded_payment_method_types":{"type":"array","description":"The list of payment method types to exclude from use with this SetupIntent.","items":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"flow_directions":{"type":"array","description":"Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `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":{"type":"string","enum":["inbound","outbound"]}},"mandate_data":{"description":"This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm).","anyOf":[{"title":"secret_key_param","required":["customer_acceptance"],"type":"object","properties":{"customer_acceptance":{"title":"customer_acceptance_param","required":["type"],"type":"object","properties":{"accepted_at":{"type":"integer","description":"The time at which the customer accepted the Mandate.","format":"unix-time"},"offline":{"title":"offline_param","type":"object","properties":{},"description":"If this is a Mandate accepted offline, this hash contains details about the offline acceptance."},"online":{"title":"online_param","required":["ip_address","user_agent"],"type":"object","properties":{"ip_address":{"type":"string","description":"The IP address from which the Mandate was accepted by the customer."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the Mandate was accepted by the customer."}},"description":"If this is a Mandate accepted online, this hash contains details about the online acceptance.","x-stripeMostCommon":["ip_address","user_agent"]},"type":{"maxLength":5000,"type":"string","description":"The type of customer acceptance information included with the Mandate. One of `online` or `offline`.","enum":["offline","online"]}},"description":"This hash contains details about the customer acceptance of the Mandate.","x-stripeMostCommon":["accepted_at","offline","online","type"]}},"x-stripeMostCommon":["customer_acceptance"]},{"type":"string","enum":[""]}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"The Stripe account ID created for this SetupIntent."},"payment_method":{"maxLength":5000,"type":"string","description":"ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent."},"payment_method_configuration":{"maxLength":100,"type":"string","description":"The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent."},"payment_method_data":{"title":"payment_method_data_params","required":["type"],"type":"object","properties":{"acss_debit":{"title":"payment_method_param","required":["account_number","institution_number","transit_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Customer's bank account number."},"institution_number":{"maxLength":5000,"type":"string","description":"Institution number of the customer's bank."},"transit_number":{"maxLength":5000,"type":"string","description":"Transit number of the customer's bank."}},"description":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","x-stripeMostCommon":["account_number","financial_connections_account","institution_number","transit_number"]},"affirm":{"title":"param","type":"object","properties":{},"description":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method."},"afterpay_clearpay":{"title":"param","type":"object","properties":{},"description":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"alipay":{"title":"param","type":"object","properties":{},"description":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method."},"allow_redisplay":{"type":"string","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"]},"alma":{"title":"param","type":"object","properties":{},"description":"If this is an Alma PaymentMethod, this hash contains details about the Alma payment method."},"amazon_pay":{"title":"param","type":"object","properties":{},"description":"If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method."},"au_becs_debit":{"title":"param","required":["account_number","bsb_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."}},"description":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","x-stripeMostCommon":["account_number","bsb_number"]},"bacs_debit":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account that the funds will be debited from."},"sort_code":{"maxLength":5000,"type":"string","description":"Sort code of the bank account. (e.g., `10-20-30`)"}},"description":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","x-stripeMostCommon":["account_number","sort_code"]},"bancontact":{"title":"param","type":"object","properties":{},"description":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method."},"billie":{"title":"param","type":"object","properties":{},"description":"If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method."},"billing_details":{"title":"billing_details_inner_params","type":"object","properties":{"address":{"description":"Billing address.","anyOf":[{"title":"billing_details_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"email":{"description":"Email address.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"name":{"description":"Full name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"phone":{"description":"Billing phone number (including extension).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"tax_id":{"maxLength":5000,"type":"string","description":"Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone","tax_id"]},"bizum":{"title":"param","type":"object","properties":{},"description":"If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method."},"blik":{"title":"param","type":"object","properties":{},"description":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method."},"boleto":{"title":"param","required":["tax_id"],"type":"object","properties":{"tax_id":{"maxLength":5000,"type":"string","description":"The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)"}},"description":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","x-stripeMostCommon":["tax_id"]},"cashapp":{"title":"param","type":"object","properties":{},"description":"If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method."},"crypto":{"title":"param","type":"object","properties":{},"description":"If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method."},"customer_balance":{"title":"param","type":"object","properties":{},"description":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method."},"eps":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's 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"]}},"description":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","x-stripeMostCommon":["bank"]},"fpx":{"title":"param","required":["bank"],"type":"object","properties":{"account_holder_type":{"maxLength":5000,"type":"string","description":"Account holder type for FPX transaction","enum":["company","individual"]},"bank":{"maxLength":5000,"type":"string","description":"The customer's bank.","enum":["affin_bank","agrobank","alliance_bank","ambank","bank_islam","bank_muamalat","bank_of_china","bank_rakyat","bnp_paribas","bsn","cimb","citibank","deutsche_bank","hong_leong_bank","hsbc","kfh","maybank2e","maybank2u","mbsb_bank","ocbc","pb_enterprise","public_bank","rhb","standard_chartered","uob"],"x-stripeBypassValidation":true}},"description":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","x-stripeMostCommon":["account_holder_type","bank"]},"giropay":{"title":"param","type":"object","properties":{},"description":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method."},"gopay":{"title":"param","type":"object","properties":{},"description":"If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method."},"grabpay":{"title":"param","type":"object","properties":{},"description":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method."},"id_bank_transfer":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"Bank where the account is held.","enum":["bca","bni","bri","cimb","permata"],"x-stripeBypassValidation":true}},"description":"If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.","x-stripeMostCommon":["bank"]},"ideal":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.","enum":["abn_amro","adyen","asn_bank","bunq","buut","finom","handelsbanken","ing","knab","mollie","moneyou","n26","nn","rabobank","regiobank","revolut","sns_bank","triodos_bank","van_lanschot","yoursafe"]}},"description":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","x-stripeMostCommon":["bank"]},"interac_present":{"title":"param","type":"object","properties":{},"description":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","x-stripeMostCommon":["device_identifier","device_type","emv","location"]},"kakao_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method."},"klarna":{"title":"param","type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","x-stripeMostCommon":["dob"]},"konbini":{"title":"param","type":"object","properties":{},"description":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method."},"kr_card":{"title":"param","type":"object","properties":{},"description":"If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method."},"link":{"title":"param","type":"object","properties":{},"description":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK)."},"mb_way":{"title":"param","type":"object","properties":{},"description":"If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"mobilepay":{"title":"param","type":"object","properties":{},"description":"If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method."},"multibanco":{"title":"param","type":"object","properties":{},"description":"If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method."},"naver_pay":{"title":"param","type":"object","properties":{"funding":{"type":"string","description":"Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.","enum":["card","points"],"x-stripeBypassValidation":true}},"description":"If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.","x-stripeMostCommon":["funding"]},"nz_bank_account":{"title":"param","required":["account_number","bank_code","branch_code","suffix"],"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."},"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bank_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank."},"branch_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank branch."},"reference":{"maxLength":128,"type":"string"},"suffix":{"maxLength":5000,"type":"string","description":"The suffix of the bank account number."}},"description":"If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.","x-stripeMostCommon":["account_holder_name","account_number","bank_code","branch_code","reference","suffix"]},"oxxo":{"title":"param","type":"object","properties":{},"description":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method."},"p24":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"The customer's 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"],"x-stripeBypassValidation":true}},"description":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","x-stripeMostCommon":["bank"]},"pay_by_bank":{"title":"param","type":"object","properties":{},"description":"If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method."},"payco":{"title":"param","type":"object","properties":{},"description":"If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method."},"paynow":{"title":"param","type":"object","properties":{},"description":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method."},"paypal":{"title":"param","type":"object","properties":{},"description":"If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method."},"paypay":{"title":"param","type":"object","properties":{},"description":"If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method."},"payto":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."},"pay_id":{"maxLength":5000,"type":"string","description":"The PayID alias for the bank account."}},"description":"If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.","x-stripeMostCommon":["account_number","bsb_number","pay_id"]},"pix":{"title":"param","type":"object","properties":{},"description":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","x-stripeMostCommon":["tax_id"]},"promptpay":{"title":"param","type":"object","properties":{},"description":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method."},"qris":{"title":"param","type":"object","properties":{},"description":"If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method."},"radar_options":{"title":"radar_options_with_hidden_options","type":"object","properties":{"session":{"maxLength":5000,"type":"string","description":"A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."}},"description":"Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.","x-stripeMostCommon":["session","skip_rules"]},"rechnung":{"title":"param","required":["dob"],"type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.","x-stripeMostCommon":["dob"]},"revolut_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method."},"samsung_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method."},"satispay":{"title":"param","type":"object","properties":{},"description":"If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method."},"scalapay":{"title":"param","type":"object","properties":{},"description":"If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method."},"sepa_debit":{"title":"param","required":["iban"],"type":"object","properties":{"iban":{"maxLength":5000,"type":"string","description":"IBAN of the bank account."}},"description":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","x-stripeMostCommon":["iban"]},"sequra":{"title":"param","type":"object","properties":{},"description":"If this is a SeQura PaymentMethod, this hash contains details about the SeQura payment method."},"shared_payment_granted_token":{"type":"string","description":"ID of the SharedPaymentGrantedToken used to confirm this PaymentIntent."},"shopeepay":{"title":"param","type":"object","properties":{},"description":"If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method."},"sofort":{"title":"param","required":["country"],"type":"object","properties":{"country":{"type":"string","description":"Two-letter ISO code representing the country the bank account is located in.","enum":["AT","BE","DE","ES","IT","NL"]}},"description":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","x-stripeMostCommon":["country"]},"stripe_balance":{"title":"param","type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"The connected account ID whose Stripe balance to use as the source of payment"}},"description":"This hash contains details about the Stripe balance payment method.","x-stripeMostCommon":["account","financial_account"]},"sunbit":{"title":"param","type":"object","properties":{},"description":"If this is a `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method."},"swish":{"title":"param","type":"object","properties":{},"description":"If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method."},"twint":{"title":"param","type":"object","properties":{},"description":"If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method."},"type":{"type":"string","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","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true},"upi":{"title":"param","type":"object","properties":{"mandate_options":{"title":"mandate_options","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]}},"description":"If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.","x-stripeMostCommon":["mandate_options","vpa"]},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"account_holder_type":{"type":"string","description":"Account holder type: individual or company.","enum":["company","individual"]},"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account."},"account_type":{"type":"string","description":"Account type: checkings or savings. Defaults to checking if omitted.","enum":["checking","savings"]},"financial_connections_account":{"maxLength":5000,"type":"string","description":"The ID of a Financial Connections Account to use as a payment method."},"routing_number":{"maxLength":5000,"type":"string","description":"Routing number of the bank account."}},"description":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","x-stripeMostCommon":["account_holder_type","account_number","account_type","financial_connections_account","routing_number","token"]},"wechat_pay":{"title":"param","type":"object","properties":{},"description":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method."},"zip":{"title":"param","type":"object","properties":{},"description":"If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method."}},"description":"When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.","x-stripeMostCommon":["billing_details","metadata","type"]},"payment_method_options":{"title":"payment_method_options_param","type":"object","properties":{"acss_debit":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"currency":{"type":"string","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).","enum":["cad","usd"]},"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"custom_mandate_url":{"description":"A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"default_for":{"type":"array","description":"List of Stripe products where this mandate can be selected automatically.","items":{"type":"string","enum":["invoice","subscription"]}},"interval_description":{"maxLength":500,"type":"string","description":"Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'."},"payment_schedule":{"type":"string","description":"Payment schedule for the mandate.","enum":["combined","interval","sporadic"]},"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["custom_mandate_url","default_for","interval_description","payment_schedule","transaction_type"]},"verification_method":{"type":"string","description":"Bank account verification method. The default value is `automatic`.","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"description":"If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.","x-stripeMostCommon":["currency","financial_connections","mandate_options","verification_method"]},"amazon_pay":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{},"description":"If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.","x-stripeMostCommon":["charge_permission_id"]},"bacs_debit":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference_prefix"]}},"description":"If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.","x-stripeMostCommon":["mandate_options","verification_method"]},"bizum":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{},"description":"If this is a `bizum` SetupIntent, this sub-hash contains details about the Bizum payment method options.","x-stripeMostCommon":["mandate_options"]},"blik":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"code":{"maxLength":5000,"type":"string","description":"The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation."},"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"expires_at":{"type":"integer","description":"Expiry date of the mandate.","format":"unix-time"}},"description":"Details of the BLIK mandate","x-stripeMostCommon":["expires_at"]}},"description":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.","x-stripeMostCommon":["code","mandate_options"]},"card":{"title":"setup_intent_param","type":"object","properties":{"mandate_options":{"title":"setup_intent_mandate_options_param","required":["amount","amount_type","currency","interval","reference","start_date"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments, specified in the presentment currency."},"amount_type":{"type":"string","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"]},"currency":{"type":"string","description":"Currency in which future payments will be charged. 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).","format":"currency"},"description":{"maxLength":200,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","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"},"interval":{"type":"string","description":"Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.","enum":["day","month","sporadic","week","year"]},"interval_count":{"type":"integer","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`."},"reference":{"maxLength":80,"type":"string","description":"Unique identifier for the mandate or subscription."},"start_date":{"type":"integer","description":"Start date of the mandate or subscription. Start date should not be lesser than yesterday.","format":"unix-time"},"supported_types":{"type":"array","description":"Specifies the type of mandates supported. Possible values are `india`.","items":{"type":"string","enum":["india"]}}},"description":"Configuration options for setting up an eMandate for cards issued in India.","x-stripeMostCommon":["amount","amount_type","currency","description","end_date","interval","interval_count","reference","start_date","supported_types"]},"moto":{"type":"boolean","description":"When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation."},"network":{"maxLength":5000,"type":"string","description":"Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.","enum":["amex","cartes_bancaires","diners","discover","eftpos_au","girocard","interac","jcb","link","mastercard","unionpay","unknown","visa"],"x-stripeBypassValidation":true},"request_three_d_secure":{"type":"string","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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"],"x-stripeBypassValidation":true},"setup_credential_usage":{"type":"string","description":"Set to indicate the future transaction type usage for the card being set up.","enum":["installment","recurring","unscheduled"],"x-stripeEnum":{"kind":"open","values":[{"description":"Use `installment` if the payment method will be used for future off-session installment payments that you manage. This is distinct from [`payment_method_options.card.installments`](/api/payment_intents/create#create_payment_intent-payment_method_options-card-installments), which is used for issuer installments like [Mexico installments](/payments/meses-sin-intereses/accept-a-payment) and [Japan installments](/payments/jp-installments/accept-a-payment).","value":"installment"},{"description":"Use `recurring` if the payment method will be used for off-session payment that occurs at regularly scheduled intervals.","value":"recurring"},{"description":"Use `unscheduled` if the payment method will be used for off-session payment that does not occur at regular intervals on a scheduled date.","value":"unscheduled"}]}},"three_d_secure":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"ares_trans_status":{"type":"string","description":"The `transStatus` returned from the card Issuer’s ACS in the ARes.","enum":["A","C","I","N","R","U","Y"]},"cryptogram":{"maxLength":5000,"type":"string","description":"The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)"},"electronic_commerce_indicator":{"type":"string","description":"The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.","enum":["01","02","05","06","07"],"x-stripeBypassValidation":true},"network_options":{"title":"network_options_param","type":"object","properties":{"cartes_bancaires":{"title":"cartes_bancaires_network_options_param","required":["cb_avalgo"],"type":"object","properties":{"cb_avalgo":{"type":"string","description":"The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO","enum":["0","1","2","3","4","A"]},"cb_exemption":{"maxLength":4,"type":"string","description":"The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded"},"cb_score":{"type":"integer","description":"The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99"}},"description":"Cartes Bancaires-specific 3DS fields.","x-stripeMostCommon":["cb_avalgo","cb_exemption","cb_score"]}},"description":"Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly","x-stripeMostCommon":["cartes_bancaires"]},"requestor_challenge_indicator":{"maxLength":2,"type":"string","description":"The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99."},"transaction_id":{"maxLength":5000,"type":"string","description":"For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID)."},"version":{"type":"string","description":"The version of 3D Secure that was performed.","enum":["1.0.2","2.1.0","2.2.0","2.3.0","2.3.1"],"x-stripeBypassValidation":true}},"description":"If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.","x-stripeMostCommon":["ares_trans_status","cryptogram","electronic_commerce_indicator","exemption_preferred","gateway","network_options","requestor_challenge_indicator","transaction_id","version"]}},"description":"Configuration for any card setup attempted on this SetupIntent.","x-stripeMostCommon":["commerce_type","mandate_options","moto","name_verification","network","network_token","request_name_verification","request_three_d_secure","setup_credential_usage","three_d_secure","verify_card_account"]},"card_present":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{},"description":"If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options."},"klarna":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"currency":{"type":"string","description":"The currency of the SetupIntent. Three letter ISO currency code.","format":"currency"},"on_demand":{"title":"on_demand_param","type":"object","properties":{"average_amount":{"type":"integer","description":"Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc."},"maximum_amount":{"type":"integer","description":"The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc."},"minimum_amount":{"type":"integer","description":"The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc."},"purchase_interval":{"type":"string","description":"Interval at which the customer is making purchases","enum":["day","month","week","year"]},"purchase_interval_count":{"type":"integer","description":"The number of `purchase_interval` between charges"}},"description":"On-demand details if setting up a payment method for on-demand payments.","x-stripeMostCommon":["average_amount","maximum_amount","minimum_amount","purchase_interval","purchase_interval_count"]},"preferred_locale":{"type":"string","description":"Preferred language of the Klarna authorization page that the customer is redirected to","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-RO","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","ro-RO","sv-FI","sv-SE"],"x-stripeBypassValidation":true},"subscriptions":{"description":"Subscription details if setting up or charging a subscription","anyOf":[{"type":"array","items":{"title":"setup_intent_subscription_param","required":["interval","next_billing","reference"],"type":"object","properties":{"interval":{"type":"string","description":"Unit of time between subscription charges.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months."},"name":{"maxLength":255,"type":"string","description":"Name for subscription."},"next_billing":{"title":"subscription_next_billing_param","required":["amount","date"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount of the next charge for the subscription."},"date":{"maxLength":5000,"type":"string","description":"The date of the next charge for the subscription in YYYY-MM-DD format."}},"description":"Describes the upcoming charge for this subscription.","x-stripeMostCommon":["amount","date"]},"reference":{"maxLength":255,"type":"string","description":"A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges."}},"x-stripeMostCommon":["interval","interval_count","name","next_billing","reference"]}},{"type":"string","enum":[""]}]}},"description":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.","x-stripeMostCommon":["currency","interoperability_token","on_demand","payment_option_id","preferred_locale","subscriptions"]},"link":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"persistent_token":{"maxLength":5000,"type":"string","description":"[Deprecated] This is a legacy parameter that no longer has any function."}},"description":"If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options (Link is also known as Onelink in the UK).","x-stripeMostCommon":["persistent_token"]},"paypal":{"title":"payment_method_options_param","type":"object","properties":{"billing_agreement_id":{"maxLength":5000,"type":"string","description":"The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."},"currency":{"type":"string","format":"currency"},"subsellers":{"type":"array","description":"The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.","items":{"maxLength":32,"type":"string"}}},"description":"If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.","x-stripeMostCommon":["billing_agreement_id","currency","subsellers"]},"payto":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"description":"Amount that will be collected. It is required when `amount_type` is `fixed`.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"amount_type":{"type":"string","description":"The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.","enum":["","fixed","maximum"]},"end_date":{"description":"Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"payment_schedule":{"type":"string","description":"The periodicity at which payments will be collected. Defaults to `adhoc`.","enum":["","adhoc","annual","daily","fortnightly","monthly","quarterly","semi_annual","weekly"]},"payments_per_period":{"description":"The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"purpose":{"type":"string","description":"The purpose for which payments are made. Has a default value based on your merchant category code.","enum":["","dependant_support","government","loan","mortgage","other","pension","personal","retail","salary","tax","utility"]},"start_date":{"description":"Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation.","x-stripeMostCommon":["amount","amount_type","end_date","payment_schedule","payments_per_period","purpose","start_date"]}},"description":"If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.","x-stripeMostCommon":["mandate_options"]},"pix":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000."},"amount_includes_iof":{"type":"string","description":"Determines if the amount includes the IOF tax. Defaults to `never`.","enum":["always","never"]},"amount_type":{"type":"string","description":"Type of amount. Defaults to `maximum`.","enum":["fixed","maximum"]},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.","format":"currency"},"end_date":{"maxLength":5000,"type":"string","description":"Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."},"payment_schedule":{"type":"string","description":"Schedule at which the future payments will be charged. Defaults to `monthly`.","enum":["halfyearly","monthly","quarterly","weekly","yearly"]},"reference":{"maxLength":35,"type":"string","description":"Subscription name displayed to buyers in their bank app. Defaults to the displayable business name."},"start_date":{"maxLength":5000,"type":"string","description":"Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date."}},"description":"Additional fields for mandate creation.","x-stripeMostCommon":["amount","amount_includes_iof","amount_type","currency","end_date","payment_schedule","reference","start_date"]}},"description":"If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.","x-stripeMostCommon":["mandate_options"]},"sepa_debit":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference","reference_prefix"]}},"description":"If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.","x-stripeMostCommon":["mandate_options","verification_method"]},"upi":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]},"setup_future_usage":{"type":"string","enum":["","none","off_session","on_session"]}},"description":"If this is a `upi` SetupIntent, this sub-hash contains details about the UPI payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage"]},"us_bank_account":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"financial_connections":{"title":"linked_account_options_param","type":"object","properties":{"filters":{"title":"linked_account_options_filters_param","type":"object","properties":{"account_subcategories":{"type":"array","description":"The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.","items":{"maxLength":5000,"type":"string","enum":["checking","savings"]}},"institution":{"maxLength":5000,"type":"string","description":"ID of the institution to use to filter for selectable accounts."}},"description":"Provide filters for the linked accounts that the customer can select for the payment method.","x-stripeMostCommon":["account_subcategories","institution"]},"manual_entry":{"title":"linked_account_options_manual_entry_param","required":["mode"],"type":"object","properties":{"mode":{"type":"string","description":"Settings for configuring manual entry of account details.","enum":["automatic","custom"]}},"description":"Customize manual entry behavior","x-stripeMostCommon":["mode"]},"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.","items":{"maxLength":5000,"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeBypassValidation":true}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","inferred_balances","ownership","transactions"],"x-stripeBypassValidation":true}},"return_url":{"maxLength":5000,"type":"string","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."}},"description":"Additional fields for Financial Connections Session creation","x-stripeMostCommon":["filters","manual_entry","permissions","prefetch","return_url"]},"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"collection_method":{"type":"string","description":"The method used to collect offline mandate customer acceptance.","enum":["","paper"],"x-stripeBypassValidation":true}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["collection_method"]},"networks":{"title":"networks_options_param","type":"object","properties":{"requested":{"type":"array","description":"Triggers validations to run across the selected networks","items":{"type":"string","enum":["ach","us_domestic_wire"]}}},"description":"Additional fields for network related functions","x-stripeMostCommon":["requested"]},"verification_method":{"type":"string","description":"Bank account verification method. The default value is `automatic`.","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"description":"If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.","x-stripeMostCommon":["financial_connections","mandate_options","networks","verification_method"]}},"description":"Payment method-specific configuration for this SetupIntent.","x-stripeMostCommon":["acss_debit","alipay","amazon_pay","bacs_debit","bizum","blik","card","card_present","demo_pay","dummy_auth_push","klarna","link","pay_by_bank","paypal","payto","pix","sepa_debit","stripe_balance","upi","us_bank_account","wechat_pay"]},"return_url":{"type":"string","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://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm)."},"single_use":{"title":"setup_intent_single_use_params","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."},"currency":{"type":"string","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).","format":"currency"}},"description":"If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.\n\nSingle-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.","x-stripeMostCommon":["amount","currency"]},"usage":{"type":"string","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"]},"use_stripe_sdk":{"type":"boolean","description":"Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions."}},"additionalProperties":false,"x-stripeMostCommon":["automatic_payment_methods","confirm","customer","customer_account","description","metadata","payment_method","usage"]},"encoding":{"allowed_payment_method_types":{"style":"deepObject","explode":true},"automatic_payment_methods":{"style":"deepObject","explode":true},"excluded_payment_method_types":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"flow_directions":{"style":"deepObject","explode":true},"mandate_data":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_method_data":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true},"single_use":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setup_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_setup_intent"}},"/v1/setup_intents/{intent}":{"get":{"summary":"Retrieve a SetupIntent","description":"Retrieves the details of a SetupIntent that has previously been created.
\n\nClient-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":[{"name":"client_secret","in":"query","description":"The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setup_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_setup_intent_via_client_key,retrieve_setup_intent_via_terminal_client,retrieve_setup_intent_via_terminal_merchant"},"post":{"summary":"Update a SetupIntent","description":"Updates a SetupIntent object.
","operationId":"PostSetupIntentsIntent","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"allowed_payment_method_types":{"description":"The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).","anyOf":[{"type":"array","items":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boku_promptpay","boleto","capchase_pay","card","card_present","cashapp","check_scan","click_to_pay","crypto","customer_balance","demo_pay","duitnow","dummy_auth_push","dummy_passthrough_card","edenred","eps","fpx","gcash","getbalance","gift_card","giropay","gopay","grabpay","id_bank_transfer","ideal","interac_present","kakao_pay","klarna","knet","konbini","kr_card","kr_market","kriya","link","mb_way","mobilepay","momo","mondu","multibanco","naver_pay","netbanking","ng_bank","ng_bank_transfer","ng_card","ng_market","ng_ussd","ng_wallet","nz_bank_account","octopus","oxxo","p24","paper_check","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shop_pay","shopeepay","sofort","south_korea_market","stripe_balance","sunbit","swish","tamara","test_pay","touch_n_go","truemoney","twint","upi","us_bank_account","us_cash_voucher","vipps","wechat_pay","wero","zip"],"x-stripeBypassValidation":true}},{"type":"string","enum":[""]}]},"attach_to_self":{"type":"boolean","description":"If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt 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."},"customer":{"maxLength":5000,"type":"string","description":"ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent."},"customer_account":{"maxLength":5000,"type":"string","description":"ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent."},"description":{"maxLength":1000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"excluded_payment_method_types":{"description":"The list of payment method types to exclude from use with this SetupIntent.","anyOf":[{"type":"array","items":{"type":"string","enum":["acss_debit","affirm","afterpay_clearpay","alipay","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","card","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"flow_directions":{"type":"array","description":"Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `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":{"type":"string","enum":["inbound","outbound"]}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment_method":{"maxLength":5000,"type":"string","description":"ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string."},"payment_method_configuration":{"maxLength":100,"type":"string","description":"The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent."},"payment_method_data":{"title":"payment_method_data_params","required":["type"],"type":"object","properties":{"acss_debit":{"title":"payment_method_param","required":["account_number","institution_number","transit_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Customer's bank account number."},"institution_number":{"maxLength":5000,"type":"string","description":"Institution number of the customer's bank."},"transit_number":{"maxLength":5000,"type":"string","description":"Transit number of the customer's bank."}},"description":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","x-stripeMostCommon":["account_number","financial_connections_account","institution_number","transit_number"]},"affirm":{"title":"param","type":"object","properties":{},"description":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method."},"afterpay_clearpay":{"title":"param","type":"object","properties":{},"description":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"alipay":{"title":"param","type":"object","properties":{},"description":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method."},"allow_redisplay":{"type":"string","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"]},"alma":{"title":"param","type":"object","properties":{},"description":"If this is an Alma PaymentMethod, this hash contains details about the Alma payment method."},"amazon_pay":{"title":"param","type":"object","properties":{},"description":"If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method."},"au_becs_debit":{"title":"param","required":["account_number","bsb_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."}},"description":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","x-stripeMostCommon":["account_number","bsb_number"]},"bacs_debit":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account that the funds will be debited from."},"sort_code":{"maxLength":5000,"type":"string","description":"Sort code of the bank account. (e.g., `10-20-30`)"}},"description":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","x-stripeMostCommon":["account_number","sort_code"]},"bancontact":{"title":"param","type":"object","properties":{},"description":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method."},"billie":{"title":"param","type":"object","properties":{},"description":"If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method."},"billing_details":{"title":"billing_details_inner_params","type":"object","properties":{"address":{"description":"Billing address.","anyOf":[{"title":"billing_details_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"email":{"description":"Email address.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"name":{"description":"Full name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"phone":{"description":"Billing phone number (including extension).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"tax_id":{"maxLength":5000,"type":"string","description":"Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone","tax_id"]},"bizum":{"title":"param","type":"object","properties":{},"description":"If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method."},"blik":{"title":"param","type":"object","properties":{},"description":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method."},"boleto":{"title":"param","required":["tax_id"],"type":"object","properties":{"tax_id":{"maxLength":5000,"type":"string","description":"The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)"}},"description":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","x-stripeMostCommon":["tax_id"]},"cashapp":{"title":"param","type":"object","properties":{},"description":"If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method."},"crypto":{"title":"param","type":"object","properties":{},"description":"If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method."},"customer_balance":{"title":"param","type":"object","properties":{},"description":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method."},"eps":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's 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"]}},"description":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","x-stripeMostCommon":["bank"]},"fpx":{"title":"param","required":["bank"],"type":"object","properties":{"account_holder_type":{"maxLength":5000,"type":"string","description":"Account holder type for FPX transaction","enum":["company","individual"]},"bank":{"maxLength":5000,"type":"string","description":"The customer's bank.","enum":["affin_bank","agrobank","alliance_bank","ambank","bank_islam","bank_muamalat","bank_of_china","bank_rakyat","bnp_paribas","bsn","cimb","citibank","deutsche_bank","hong_leong_bank","hsbc","kfh","maybank2e","maybank2u","mbsb_bank","ocbc","pb_enterprise","public_bank","rhb","standard_chartered","uob"],"x-stripeBypassValidation":true}},"description":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","x-stripeMostCommon":["account_holder_type","bank"]},"giropay":{"title":"param","type":"object","properties":{},"description":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method."},"gopay":{"title":"param","type":"object","properties":{},"description":"If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method."},"grabpay":{"title":"param","type":"object","properties":{},"description":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method."},"id_bank_transfer":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"Bank where the account is held.","enum":["bca","bni","bri","cimb","permata"],"x-stripeBypassValidation":true}},"description":"If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.","x-stripeMostCommon":["bank"]},"ideal":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.","enum":["abn_amro","adyen","asn_bank","bunq","buut","finom","handelsbanken","ing","knab","mollie","moneyou","n26","nn","rabobank","regiobank","revolut","sns_bank","triodos_bank","van_lanschot","yoursafe"]}},"description":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","x-stripeMostCommon":["bank"]},"interac_present":{"title":"param","type":"object","properties":{},"description":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","x-stripeMostCommon":["device_identifier","device_type","emv","location"]},"kakao_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method."},"klarna":{"title":"param","type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","x-stripeMostCommon":["dob"]},"konbini":{"title":"param","type":"object","properties":{},"description":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method."},"kr_card":{"title":"param","type":"object","properties":{},"description":"If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method."},"link":{"title":"param","type":"object","properties":{},"description":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK)."},"mb_way":{"title":"param","type":"object","properties":{},"description":"If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"mobilepay":{"title":"param","type":"object","properties":{},"description":"If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method."},"multibanco":{"title":"param","type":"object","properties":{},"description":"If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method."},"naver_pay":{"title":"param","type":"object","properties":{"funding":{"type":"string","description":"Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.","enum":["card","points"],"x-stripeBypassValidation":true}},"description":"If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.","x-stripeMostCommon":["funding"]},"nz_bank_account":{"title":"param","required":["account_number","bank_code","branch_code","suffix"],"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."},"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bank_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank."},"branch_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank branch."},"reference":{"maxLength":128,"type":"string"},"suffix":{"maxLength":5000,"type":"string","description":"The suffix of the bank account number."}},"description":"If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.","x-stripeMostCommon":["account_holder_name","account_number","bank_code","branch_code","reference","suffix"]},"oxxo":{"title":"param","type":"object","properties":{},"description":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method."},"p24":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"The customer's 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"],"x-stripeBypassValidation":true}},"description":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","x-stripeMostCommon":["bank"]},"pay_by_bank":{"title":"param","type":"object","properties":{},"description":"If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method."},"payco":{"title":"param","type":"object","properties":{},"description":"If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method."},"paynow":{"title":"param","type":"object","properties":{},"description":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method."},"paypal":{"title":"param","type":"object","properties":{},"description":"If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method."},"paypay":{"title":"param","type":"object","properties":{},"description":"If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method."},"payto":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."},"pay_id":{"maxLength":5000,"type":"string","description":"The PayID alias for the bank account."}},"description":"If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.","x-stripeMostCommon":["account_number","bsb_number","pay_id"]},"pix":{"title":"param","type":"object","properties":{},"description":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","x-stripeMostCommon":["tax_id"]},"promptpay":{"title":"param","type":"object","properties":{},"description":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method."},"qris":{"title":"param","type":"object","properties":{},"description":"If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method."},"radar_options":{"title":"radar_options_with_hidden_options","type":"object","properties":{"session":{"maxLength":5000,"type":"string","description":"A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."}},"description":"Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.","x-stripeMostCommon":["session","skip_rules"]},"rechnung":{"title":"param","required":["dob"],"type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.","x-stripeMostCommon":["dob"]},"revolut_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method."},"samsung_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method."},"satispay":{"title":"param","type":"object","properties":{},"description":"If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method."},"scalapay":{"title":"param","type":"object","properties":{},"description":"If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method."},"sepa_debit":{"title":"param","required":["iban"],"type":"object","properties":{"iban":{"maxLength":5000,"type":"string","description":"IBAN of the bank account."}},"description":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","x-stripeMostCommon":["iban"]},"sequra":{"title":"param","type":"object","properties":{},"description":"If this is a SeQura PaymentMethod, this hash contains details about the SeQura payment method."},"shared_payment_granted_token":{"type":"string","description":"ID of the SharedPaymentGrantedToken used to confirm this PaymentIntent."},"shopeepay":{"title":"param","type":"object","properties":{},"description":"If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method."},"sofort":{"title":"param","required":["country"],"type":"object","properties":{"country":{"type":"string","description":"Two-letter ISO code representing the country the bank account is located in.","enum":["AT","BE","DE","ES","IT","NL"]}},"description":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","x-stripeMostCommon":["country"]},"stripe_balance":{"title":"param","type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"The connected account ID whose Stripe balance to use as the source of payment"}},"description":"This hash contains details about the Stripe balance payment method.","x-stripeMostCommon":["account","financial_account"]},"sunbit":{"title":"param","type":"object","properties":{},"description":"If this is a `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method."},"swish":{"title":"param","type":"object","properties":{},"description":"If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method."},"twint":{"title":"param","type":"object","properties":{},"description":"If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method."},"type":{"type":"string","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","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true},"upi":{"title":"param","type":"object","properties":{"mandate_options":{"title":"mandate_options","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]}},"description":"If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.","x-stripeMostCommon":["mandate_options","vpa"]},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"account_holder_type":{"type":"string","description":"Account holder type: individual or company.","enum":["company","individual"]},"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account."},"account_type":{"type":"string","description":"Account type: checkings or savings. Defaults to checking if omitted.","enum":["checking","savings"]},"financial_connections_account":{"maxLength":5000,"type":"string","description":"The ID of a Financial Connections Account to use as a payment method."},"routing_number":{"maxLength":5000,"type":"string","description":"Routing number of the bank account."}},"description":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","x-stripeMostCommon":["account_holder_type","account_number","account_type","financial_connections_account","routing_number","token"]},"wechat_pay":{"title":"param","type":"object","properties":{},"description":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method."},"zip":{"title":"param","type":"object","properties":{},"description":"If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method."}},"description":"When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.","x-stripeMostCommon":["billing_details","metadata","type"]},"payment_method_options":{"title":"payment_method_options_param","type":"object","properties":{"acss_debit":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"currency":{"type":"string","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).","enum":["cad","usd"]},"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"custom_mandate_url":{"description":"A URL for custom mandate text to render during confirmation step.\nThe URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,\nor `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"default_for":{"type":"array","description":"List of Stripe products where this mandate can be selected automatically.","items":{"type":"string","enum":["invoice","subscription"]}},"interval_description":{"maxLength":500,"type":"string","description":"Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'."},"payment_schedule":{"type":"string","description":"Payment schedule for the mandate.","enum":["combined","interval","sporadic"]},"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["custom_mandate_url","default_for","interval_description","payment_schedule","transaction_type"]},"verification_method":{"type":"string","description":"Bank account verification method. The default value is `automatic`.","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"description":"If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.","x-stripeMostCommon":["currency","financial_connections","mandate_options","verification_method"]},"amazon_pay":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{},"description":"If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.","x-stripeMostCommon":["charge_permission_id"]},"bacs_debit":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference_prefix"]}},"description":"If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.","x-stripeMostCommon":["mandate_options","verification_method"]},"bizum":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{},"description":"If this is a `bizum` SetupIntent, this sub-hash contains details about the Bizum payment method options.","x-stripeMostCommon":["mandate_options"]},"blik":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"code":{"maxLength":5000,"type":"string","description":"The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation."},"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"expires_at":{"type":"integer","description":"Expiry date of the mandate.","format":"unix-time"}},"description":"Details of the BLIK mandate","x-stripeMostCommon":["expires_at"]}},"description":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.","x-stripeMostCommon":["code","mandate_options"]},"card":{"title":"setup_intent_param","type":"object","properties":{"mandate_options":{"title":"setup_intent_mandate_options_param","required":["amount","amount_type","currency","interval","reference","start_date"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments, specified in the presentment currency."},"amount_type":{"type":"string","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"]},"currency":{"type":"string","description":"Currency in which future payments will be charged. 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).","format":"currency"},"description":{"maxLength":200,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","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"},"interval":{"type":"string","description":"Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.","enum":["day","month","sporadic","week","year"]},"interval_count":{"type":"integer","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`."},"reference":{"maxLength":80,"type":"string","description":"Unique identifier for the mandate or subscription."},"start_date":{"type":"integer","description":"Start date of the mandate or subscription. Start date should not be lesser than yesterday.","format":"unix-time"},"supported_types":{"type":"array","description":"Specifies the type of mandates supported. Possible values are `india`.","items":{"type":"string","enum":["india"]}}},"description":"Configuration options for setting up an eMandate for cards issued in India.","x-stripeMostCommon":["amount","amount_type","currency","description","end_date","interval","interval_count","reference","start_date","supported_types"]},"moto":{"type":"boolean","description":"When specified, this parameter signals that a card has been collected\nas MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This\nparameter can only be provided during confirmation."},"network":{"maxLength":5000,"type":"string","description":"Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.","enum":["amex","cartes_bancaires","diners","discover","eftpos_au","girocard","interac","jcb","link","mastercard","unionpay","unknown","visa"],"x-stripeBypassValidation":true},"request_three_d_secure":{"type":"string","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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"],"x-stripeBypassValidation":true},"setup_credential_usage":{"type":"string","description":"Set to indicate the future transaction type usage for the card being set up.","enum":["installment","recurring","unscheduled"],"x-stripeEnum":{"kind":"open","values":[{"description":"Use `installment` if the payment method will be used for future off-session installment payments that you manage. This is distinct from [`payment_method_options.card.installments`](/api/payment_intents/create#create_payment_intent-payment_method_options-card-installments), which is used for issuer installments like [Mexico installments](/payments/meses-sin-intereses/accept-a-payment) and [Japan installments](/payments/jp-installments/accept-a-payment).","value":"installment"},{"description":"Use `recurring` if the payment method will be used for off-session payment that occurs at regularly scheduled intervals.","value":"recurring"},{"description":"Use `unscheduled` if the payment method will be used for off-session payment that does not occur at regular intervals on a scheduled date.","value":"unscheduled"}]}},"three_d_secure":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"ares_trans_status":{"type":"string","description":"The `transStatus` returned from the card Issuer’s ACS in the ARes.","enum":["A","C","I","N","R","U","Y"]},"cryptogram":{"maxLength":5000,"type":"string","description":"The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)"},"electronic_commerce_indicator":{"type":"string","description":"The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.","enum":["01","02","05","06","07"],"x-stripeBypassValidation":true},"network_options":{"title":"network_options_param","type":"object","properties":{"cartes_bancaires":{"title":"cartes_bancaires_network_options_param","required":["cb_avalgo"],"type":"object","properties":{"cb_avalgo":{"type":"string","description":"The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO","enum":["0","1","2","3","4","A"]},"cb_exemption":{"maxLength":4,"type":"string","description":"The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded"},"cb_score":{"type":"integer","description":"The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99"}},"description":"Cartes Bancaires-specific 3DS fields.","x-stripeMostCommon":["cb_avalgo","cb_exemption","cb_score"]}},"description":"Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly","x-stripeMostCommon":["cartes_bancaires"]},"requestor_challenge_indicator":{"maxLength":2,"type":"string","description":"The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99."},"transaction_id":{"maxLength":5000,"type":"string","description":"For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID)."},"version":{"type":"string","description":"The version of 3D Secure that was performed.","enum":["1.0.2","2.1.0","2.2.0","2.3.0","2.3.1"],"x-stripeBypassValidation":true}},"description":"If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.","x-stripeMostCommon":["ares_trans_status","cryptogram","electronic_commerce_indicator","exemption_preferred","gateway","network_options","requestor_challenge_indicator","transaction_id","version"]}},"description":"Configuration for any card setup attempted on this SetupIntent.","x-stripeMostCommon":["commerce_type","mandate_options","moto","name_verification","network","network_token","request_name_verification","request_three_d_secure","setup_credential_usage","three_d_secure","verify_card_account"]},"card_present":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{},"description":"If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options."},"klarna":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"currency":{"type":"string","description":"The currency of the SetupIntent. Three letter ISO currency code.","format":"currency"},"on_demand":{"title":"on_demand_param","type":"object","properties":{"average_amount":{"type":"integer","description":"Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc."},"maximum_amount":{"type":"integer","description":"The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc."},"minimum_amount":{"type":"integer","description":"The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc."},"purchase_interval":{"type":"string","description":"Interval at which the customer is making purchases","enum":["day","month","week","year"]},"purchase_interval_count":{"type":"integer","description":"The number of `purchase_interval` between charges"}},"description":"On-demand details if setting up a payment method for on-demand payments.","x-stripeMostCommon":["average_amount","maximum_amount","minimum_amount","purchase_interval","purchase_interval_count"]},"preferred_locale":{"type":"string","description":"Preferred language of the Klarna authorization page that the customer is redirected to","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-RO","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","ro-RO","sv-FI","sv-SE"],"x-stripeBypassValidation":true},"subscriptions":{"description":"Subscription details if setting up or charging a subscription","anyOf":[{"type":"array","items":{"title":"setup_intent_subscription_param","required":["interval","next_billing","reference"],"type":"object","properties":{"interval":{"type":"string","description":"Unit of time between subscription charges.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months."},"name":{"maxLength":255,"type":"string","description":"Name for subscription."},"next_billing":{"title":"subscription_next_billing_param","required":["amount","date"],"type":"object","properties":{"amount":{"type":"integer","description":"The amount of the next charge for the subscription."},"date":{"maxLength":5000,"type":"string","description":"The date of the next charge for the subscription in YYYY-MM-DD format."}},"description":"Describes the upcoming charge for this subscription.","x-stripeMostCommon":["amount","date"]},"reference":{"maxLength":255,"type":"string","description":"A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges."}},"x-stripeMostCommon":["interval","interval_count","name","next_billing","reference"]}},{"type":"string","enum":[""]}]}},"description":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method options.","x-stripeMostCommon":["currency","interoperability_token","on_demand","payment_option_id","preferred_locale","subscriptions"]},"link":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"persistent_token":{"maxLength":5000,"type":"string","description":"[Deprecated] This is a legacy parameter that no longer has any function."}},"description":"If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options (Link is also known as Onelink in the UK).","x-stripeMostCommon":["persistent_token"]},"paypal":{"title":"payment_method_options_param","type":"object","properties":{"billing_agreement_id":{"maxLength":5000,"type":"string","description":"The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."},"currency":{"type":"string","format":"currency"},"subsellers":{"type":"array","description":"The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.","items":{"maxLength":32,"type":"string"}}},"description":"If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.","x-stripeMostCommon":["billing_agreement_id","currency","subsellers"]},"payto":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"setup_intent_payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"description":"Amount that will be collected. It is required when `amount_type` is `fixed`.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"amount_type":{"type":"string","description":"The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.","enum":["","fixed","maximum"]},"end_date":{"description":"Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"payment_schedule":{"type":"string","description":"The periodicity at which payments will be collected. Defaults to `adhoc`.","enum":["","adhoc","annual","daily","fortnightly","monthly","quarterly","semi_annual","weekly"]},"payments_per_period":{"description":"The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"purpose":{"type":"string","description":"The purpose for which payments are made. Has a default value based on your merchant category code.","enum":["","dependant_support","government","loan","mortgage","other","pension","personal","retail","salary","tax","utility"]},"start_date":{"description":"Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation.","x-stripeMostCommon":["amount","amount_type","end_date","payment_schedule","payments_per_period","purpose","start_date"]}},"description":"If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.","x-stripeMostCommon":["mandate_options"]},"pix":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000."},"amount_includes_iof":{"type":"string","description":"Determines if the amount includes the IOF tax. Defaults to `never`.","enum":["always","never"]},"amount_type":{"type":"string","description":"Type of amount. Defaults to `maximum`.","enum":["fixed","maximum"]},"currency":{"type":"string","description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.","format":"currency"},"end_date":{"maxLength":5000,"type":"string","description":"Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."},"payment_schedule":{"type":"string","description":"Schedule at which the future payments will be charged. Defaults to `monthly`.","enum":["halfyearly","monthly","quarterly","weekly","yearly"]},"reference":{"maxLength":35,"type":"string","description":"Subscription name displayed to buyers in their bank app. Defaults to the displayable business name."},"start_date":{"maxLength":5000,"type":"string","description":"Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date."}},"description":"Additional fields for mandate creation.","x-stripeMostCommon":["amount","amount_includes_iof","amount_type","currency","end_date","payment_schedule","reference","start_date"]}},"description":"If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.","x-stripeMostCommon":["mandate_options"]},"sepa_debit":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"reference_prefix":{"description":"Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.","anyOf":[{"maxLength":12,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["reference","reference_prefix"]}},"description":"If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.","x-stripeMostCommon":["mandate_options","verification_method"]},"upi":{"title":"payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]},"setup_future_usage":{"type":"string","enum":["","none","off_session","on_session"]}},"description":"If this is a `upi` SetupIntent, this sub-hash contains details about the UPI payment method options.","x-stripeMostCommon":["mandate_options","setup_future_usage"]},"us_bank_account":{"title":"setup_intent_payment_method_options_param","type":"object","properties":{"financial_connections":{"title":"linked_account_options_param","type":"object","properties":{"filters":{"title":"linked_account_options_filters_param","type":"object","properties":{"account_subcategories":{"type":"array","description":"The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.","items":{"maxLength":5000,"type":"string","enum":["checking","savings"]}},"institution":{"maxLength":5000,"type":"string","description":"ID of the institution to use to filter for selectable accounts."}},"description":"Provide filters for the linked accounts that the customer can select for the payment method.","x-stripeMostCommon":["account_subcategories","institution"]},"manual_entry":{"title":"linked_account_options_manual_entry_param","required":["mode"],"type":"object","properties":{"mode":{"type":"string","description":"Settings for configuring manual entry of account details.","enum":["automatic","custom"]}},"description":"Customize manual entry behavior","x-stripeMostCommon":["mode"]},"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.","items":{"maxLength":5000,"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeBypassValidation":true}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","inferred_balances","ownership","transactions"],"x-stripeBypassValidation":true}},"return_url":{"maxLength":5000,"type":"string","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."}},"description":"Additional fields for Financial Connections Session creation","x-stripeMostCommon":["filters","manual_entry","permissions","prefetch","return_url"]},"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"collection_method":{"type":"string","description":"The method used to collect offline mandate customer acceptance.","enum":["","paper"],"x-stripeBypassValidation":true}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["collection_method"]},"networks":{"title":"networks_options_param","type":"object","properties":{"requested":{"type":"array","description":"Triggers validations to run across the selected networks","items":{"type":"string","enum":["ach","us_domestic_wire"]}}},"description":"Additional fields for network related functions","x-stripeMostCommon":["requested"]},"verification_method":{"type":"string","description":"Bank account verification method. The default value is `automatic`.","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"description":"If this is a `us_bank_account` SetupIntent, this sub-hash contains details about the US bank account payment method options.","x-stripeMostCommon":["financial_connections","mandate_options","networks","verification_method"]}},"description":"Payment method-specific configuration for this SetupIntent.","x-stripeMostCommon":["acss_debit","alipay","amazon_pay","bacs_debit","bizum","blik","card","card_present","demo_pay","dummy_auth_push","klarna","link","pay_by_bank","paypal","payto","pix","sepa_debit","stripe_balance","upi","us_bank_account","wechat_pay"]}},"additionalProperties":false,"x-stripeMostCommon":["customer","customer_account","description","metadata","payment_method"]},"encoding":{"allowed_payment_method_types":{"style":"deepObject","explode":true},"excluded_payment_method_types":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"flow_directions":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_method_data":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setup_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_setup_intent"}},"/v1/setup_intents/{intent}/cancel":{"post":{"summary":"Cancel a SetupIntent","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. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.
","operationId":"PostSetupIntentsIntentCancel","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"cancellation_reason":{"maxLength":5000,"type":"string","description":"Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`","enum":["abandoned","duplicate","requested_by_customer"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["cancellation_reason"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setup_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_setup_intent,cancel_setup_intent_via_terminal_merchant,cancel_setup_intent_via_client_merchant"}},"/v1/setup_intents/{intent}/confirm":{"post":{"summary":"Confirm a SetupIntent","description":"Confirm that your customer intends to set up the current or\nprovided payment method. For example, you would confirm a SetupIntent\nwhen a customer hits the “Save” button on a payment method management\npage on your website.
\n\nIf the selected payment method does not require any additional\nsteps from the customer, the SetupIntent will transition to the\nsucceeded status.
Otherwise, it will transition to the requires_action status and\nsuggest additional actions via next_action. If setup fails,\nthe SetupIntent will transition to the\nrequires_payment_method status or the canceled status if the\nconfirmation limit is reached.
Verifies microdeposits on a SetupIntent object.
","operationId":"PostSetupIntentsIntentVerifyMicrodeposits","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amounts":{"type":"array","description":"Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.","items":{"type":"integer"}},"descriptor_code":{"maxLength":5000,"type":"string","description":"A six-character code starting with SM present in the microdeposit sent to the bank account."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["amounts","descriptor_code"]},"encoding":{"amounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setup_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"verify_setup_intent_microdeposits_via_secret_key"}},"/v1/shared_payment/granted_tokens/{shared_payment_granted_token}":{"get":{"summary":"Retrieve a SharedPaymentGrantedToken","description":"Retrieves an existing SharedPaymentGrantedToken object
","operationId":"GetSharedPaymentGrantedTokensSharedPaymentGrantedToken","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"shared_payment_granted_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shared_payment.granted_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"shared_payment_granted_token_retrieve_method"}},"/v1/shared_payment/issued_tokens":{"post":{"summary":"Create a SharedPaymentIssuedToken","description":"Creates a new SharedPaymentIssuedToken object
","operationId":"PostSharedPaymentIssuedTokens","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["payment_method","seller_details","usage_limits"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_method":{"maxLength":5000,"type":"string","description":"The PaymentMethod that is going to be shared by the SharedPaymentIssuedToken."},"return_url":{"type":"string","description":"If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."},"seller_details":{"title":"param","type":"object","properties":{"external_id":{"maxLength":5000,"type":"string","description":"A unique id within a network that identifies a logical seller, usually this would be the unique merchant id."},"network_business_profile":{"maxLength":5000,"type":"string","description":"A string that identifies the network that this SharedToken is being created for."}},"description":"Seller details of the SharedPaymentIssuedToken, including network_id and external_id.","x-stripeMostCommon":["external_id","network_business_profile","network_id"]},"setup_future_usage":{"type":"string","description":"Indicates that you intend to save the PaymentMethod of this SharedPaymentToken to a customer later.","enum":["on_session"],"x-stripeBypassValidation":true},"shared_metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to the SharedPaymentIssuedToken. The values here are visible by default with the party that you share this SharedPaymentIssuedToken with."},"usage_limits":{"title":"usage_limits_param","required":["currency","max_amount"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"expires_at":{"type":"integer","description":"Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.","format":"unix-time"},"max_amount":{"type":"integer","description":"Max amount that can be captured using this SharedPaymentToken"}},"description":"Limits on how this SharedPaymentToken can be used.","x-stripeMostCommon":["currency","expires_at","max_amount","recurring","recurring_interval"]},"use_stripe_sdk":{"type":"boolean","description":"Set to true when using Stripe.js, iOS, or Android client-side SDKs to handle next actions."}},"additionalProperties":false,"x-stripeMostCommon":["payment_method","return_url","seller_details","setup_future_usage","shared_metadata","usage_limits","use_stripe_sdk"]},"encoding":{"expand":{"style":"deepObject","explode":true},"seller_details":{"style":"deepObject","explode":true},"shared_metadata":{"style":"deepObject","explode":true},"usage_limits":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shared_payment.issued_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"shared_payment_token_create_method"}},"/v1/shared_payment/issued_tokens/{shared_payment_issued_token}":{"get":{"summary":"Retrieve a SharedPaymentIssuedToken","description":"Retrieves an existing SharedPaymentIssuedToken object
","operationId":"GetSharedPaymentIssuedTokensSharedPaymentIssuedToken","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"shared_payment_issued_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shared_payment.issued_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"shared_payment_token_retrieve_method"}},"/v1/shared_payment/issued_tokens/{shared_payment_issued_token}/revoke":{"post":{"summary":"Revoke a SharedPaymentIssuedToken","description":"Revokes a SharedPaymentIssuedToken
","operationId":"PostSharedPaymentIssuedTokensSharedPaymentIssuedTokenRevoke","parameters":[{"name":"shared_payment_issued_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shared_payment.issued_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"shared_payment_token_revoke_method"}},"/v1/shipping_rates":{"get":{"summary":"List all shipping rates","description":"Returns a list of your shipping rates.
","operationId":"GetShippingRates","parameters":[{"name":"active","in":"query","description":"Only return shipping rates that are active or inactive.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"currency","in":"query","description":"Only return shipping rates for the given currency.","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"currency"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ShippingResourcesShippingRateList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/shipping_rate"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/shipping_rates","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_shipping_rates"},"post":{"summary":"Create a shipping rate","description":"Creates a new shipping rate object.
","operationId":"PostShippingRates","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["display_name"],"type":"object","properties":{"delivery_estimate":{"title":"delivery_estimate","type":"object","properties":{"maximum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.","x-stripeMostCommon":["unit","value"]},"minimum":{"title":"delivery_estimate_bound","required":["unit","value"],"type":"object","properties":{"unit":{"type":"string","description":"A unit of time.","enum":["business_day","day","hour","month","week"]},"value":{"type":"integer","description":"Must be greater than 0."}},"description":"The lower bound of the estimated range. If empty, represents no lower bound.","x-stripeMostCommon":["unit","value"]}},"description":"The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.","x-stripeMostCommon":["maximum","minimum"]},"display_name":{"maxLength":100,"type":"string","description":"The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fixed_amount":{"title":"fixed_amount","required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"currency":{"type":"string","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).","format":"currency"},"currency_options":{"type":"object","additionalProperties":{"title":"currency_option","required":["amount"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"x-stripeMostCommon":["amount","tax_behavior"]},"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)."}},"description":"Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.","x-stripeMostCommon":["amount","currency","currency_options"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]},"tax_code":{"type":"string","description":"A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`."},"type":{"type":"string","description":"The type of calculation to use on the shipping rate.","enum":["fixed_amount"]}},"additionalProperties":false,"x-stripeMostCommon":["display_name","fixed_amount","metadata","tax_behavior","tax_code","type"]},"encoding":{"delivery_estimate":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"fixed_amount":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipping_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_shipping_rate"}},"/v1/shipping_rates/{shipping_rate_token}":{"get":{"summary":"Retrieve a shipping rate","description":"Returns the shipping rate object with the given ID.
","operationId":"GetShippingRatesShippingRateToken","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"shipping_rate_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipping_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_shipping_rate"},"post":{"summary":"Update a shipping rate","description":"Updates an existing shipping rate object.
","operationId":"PostShippingRatesShippingRateToken","parameters":[{"name":"shipping_rate_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the shipping rate can be used for new purchases. Defaults to `true`."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fixed_amount":{"title":"fixed_amount_update","type":"object","properties":{"currency_options":{"type":"object","additionalProperties":{"title":"currency_option_update","type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer in cents representing how much to charge."},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"x-stripeMostCommon":["amount","tax_behavior"]},"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)."}},"description":"Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.","x-stripeMostCommon":["currency_options"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"tax_behavior":{"type":"string","description":"Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.","enum":["exclusive","inclusive","unspecified"]}},"additionalProperties":false,"x-stripeMostCommon":["active","fixed_amount","metadata","tax_behavior"]},"encoding":{"expand":{"style":"deepObject","explode":true},"fixed_amount":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipping_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_shipping_rate"}},"/v1/sigma/scheduled_query_runs":{"get":{"summary":"List all scheduled query runs","description":"Returns a list of scheduled query runs.
","operationId":"GetSigmaScheduledQueryRuns","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SigmaScheduledQueryRunList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/scheduled_query_run"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/sigma/scheduled_query_runs","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_scheduled_query_runs"}},"/v1/sigma/scheduled_query_runs/{scheduled_query_run}":{"get":{"summary":"Retrieve a scheduled query run","description":"Retrieves the details of a scheduled query run.
","operationId":"GetSigmaScheduledQueryRunsScheduledQueryRun","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"scheduled_query_run","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduled_query_run"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_scheduled_query_run"}},"/v1/sources":{"post":{"summary":"Create a source","description":"Creates a new source object.
","operationId":"PostSources","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","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."},"currency":{"type":"string","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.","format":"currency"},"customer":{"maxLength":500,"type":"string","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`)."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"flow":{"maxLength":5000,"type":"string","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"]},"mandate":{"title":"mandate_params","type":"object","properties":{"acceptance":{"title":"mandate_acceptance_params","required":["status"],"type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the mandate was accepted or refused by the customer."},"offline":{"title":"mandate_offline_acceptance_params","required":["contact_email"],"type":"object","properties":{"contact_email":{"type":"string","description":"An email to contact you with if a copy of the mandate is requested, required if `type` is `offline`."}},"description":"The parameters required to store a mandate accepted offline. Should only be set if `mandate[type]` is `offline`","x-stripeMostCommon":["contact_email"]},"online":{"title":"mandate_online_acceptance_params","type":"object","properties":{"date":{"type":"integer","description":"The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.","format":"unix-time"},"ip":{"type":"string","description":"The IP address from which the mandate was accepted or refused by the customer."},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the mandate was accepted or refused by the customer."}},"description":"The parameters required to store a mandate accepted online. Should only be set if `mandate[type]` is `online`","x-stripeMostCommon":["date","ip","user_agent"]},"status":{"maxLength":5000,"type":"string","description":"The status of the mandate acceptance. Either `accepted` (the mandate was accepted) or `refused` (the mandate was refused).","enum":["accepted","pending","refused","revoked"]},"type":{"maxLength":5000,"type":"string","description":"The type of acceptance information included with the mandate. Either `online` or `offline`","enum":["offline","online"]},"user_agent":{"maxLength":5000,"type":"string","description":"The user agent of the browser from which the mandate was accepted or refused by the customer."}},"description":"The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.","x-stripeMostCommon":["date","ip","offline","online","status","type","user_agent"]},"amount":{"description":"The amount specified by the mandate. (Leave null for a mandate covering all amounts)","anyOf":[{"type":"integer"},{"type":"string","enum":[""]}]},"currency":{"type":"string","description":"The currency specified by the mandate. (Must match `currency` of the source)","format":"currency"},"interval":{"maxLength":5000,"type":"string","description":"The interval of debits permitted by the mandate. Either `one_time` (just permitting a single debit), `scheduled` (with debits on an agreed schedule or for clearly-defined events), or `variable`(for debits with any frequency)","enum":["one_time","scheduled","variable"]},"notification_method":{"maxLength":5000,"type":"string","description":"The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either `email` (an email is sent directly to the customer), `manual` (a `source.mandate_notification` event is sent to your webhooks endpoint and you should handle the notification) or `none` (the underlying debit network does not require any notification).","enum":["deprecated_none","email","manual","none","stripe_email"]}},"description":"Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.","x-stripeMostCommon":["acceptance","amount","currency","interval","notification_method"]},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"original_source":{"maxLength":5000,"type":"string","description":"The source to share."},"owner":{"title":"owner","type":"object","properties":{"address":{"title":"source_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Owner's address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"Owner's email address."},"name":{"maxLength":5000,"type":"string","description":"Owner's full name."},"phone":{"maxLength":5000,"type":"string","description":"Owner's phone number."}},"description":"Information about the owner of the payment instrument that may be used or required by particular source types.","x-stripeMostCommon":["address","email","name","phone"]},"receiver":{"title":"receiver_params","type":"object","properties":{"refund_attributes_method":{"maxLength":5000,"type":"string","description":"The method Stripe should use to request information needed to process a refund or mispayment. Either `email` (an email is sent directly to the customer) or `manual` (a `source.refund_attributes_required` event is sent to your webhooks endpoint). Refer to each payment method's documentation to learn which refund attributes may be required.","enum":["email","manual","none"]}},"description":"Optional parameters for the receiver flow. Can be set only if the source is a receiver (`flow` is `receiver`).","x-stripeMostCommon":["refund_attributes_method"]},"redirect":{"title":"redirect_params","required":["return_url"],"type":"object","properties":{"return_url":{"type":"string","description":"The URL you provide to redirect the customer back to you after they authenticated their payment. It can use your application URI scheme in the context of a mobile application."}},"description":"Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`).","x-stripeMostCommon":["return_url"]},"source_order":{"title":"shallow_order_specs","type":"object","properties":{"items":{"type":"array","description":"List of items constituting the order.","items":{"title":"order_item_specs","type":"object","properties":{"amount":{"type":"integer"},"currency":{"type":"string","format":"currency"},"description":{"maxLength":1000,"type":"string"},"parent":{"maxLength":5000,"type":"string","description":"The ID of the SKU being ordered."},"quantity":{"type":"integer","description":"The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered."},"type":{"maxLength":5000,"type":"string","enum":["discount","shipping","sku","tax"]}},"x-stripeMostCommon":["amount","currency","description","parent","quantity","type"]}},"shipping":{"title":"order_shipping","required":["address"],"type":"object","properties":{"address":{"title":"address","required":["line1"],"type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"carrier":{"maxLength":5000,"type":"string","description":"The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."},"name":{"maxLength":5000,"type":"string","description":"Recipient name."},"phone":{"maxLength":5000,"type":"string","description":"Recipient phone (including extension)."},"tracking_number":{"maxLength":5000,"type":"string","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."}},"description":"Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true.","x-stripeMostCommon":["address","carrier","name","phone","tracking_number"]}},"description":"Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.","x-stripeMostCommon":["items","shipping"]},"statement_descriptor":{"maxLength":5000,"type":"string","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."},"token":{"maxLength":5000,"type":"string","description":"An optional token used to create the source. When passed, token properties will override source parameters."},"type":{"maxLength":5000,"type":"string","description":"The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide)"},"usage":{"maxLength":5000,"type":"string","enum":["reusable","single_use"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","customer","metadata","original_source","owner","redirect","statement_descriptor","type"]},"encoding":{"expand":{"style":"deepObject","explode":true},"mandate":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"owner":{"style":"deepObject","explode":true},"receiver":{"style":"deepObject","explode":true},"redirect":{"style":"deepObject","explode":true},"source_order":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/source"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_source"}},"/v1/sources/{source}":{"get":{"summary":"Retrieve a source","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":[{"name":"client_secret","in":"query","description":"The client secret of the source. Required if a publishable key is used to retrieve the source.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"source","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/source"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_source"},"post":{"summary":"Update a source","description":"Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n\nThis 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.
List source transactions for a given source.
","operationId":"GetSourcesSourceSourceTransactions","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"source","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ApmsSourcesSourceTransactionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/source_transaction"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/sources/{source}/verify":{"post":{"description":"Verify a given source.
","operationId":"PostSourcesSourceVerify","parameters":[{"name":"source","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["values"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"values":{"type":"array","description":"The values needed to verify the source.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["values"]},"encoding":{"expand":{"style":"deepObject","explode":true},"values":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/source"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/subscription_items":{"get":{"summary":"List all subscription items","description":"Returns a list of your subscription items for a given subscription.
","operationId":"GetSubscriptionItems","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"subscription","in":"query","description":"The ID of the subscription whose items will be retrieved.","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SubscriptionsItemsSubscriptionItemList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subscription_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/subscription_items","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_subscription_items"},"post":{"summary":"Create a subscription item","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":{"schema":{"required":["subscription"],"type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"current_trial":{"title":"current_trial_param","required":["trial_offer"],"type":"object","properties":{"trial_end":{"type":"integer","description":"Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.","format":"unix-time"},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the subscription item."}},"description":"The trial offer to apply to this subscription item.","x-stripeMostCommon":["trial_end","trial_offer"]},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_behavior":{"type":"string","description":"Controls how Stripe handles payment when a subscription update requires payment and `collection_method=charge_automatically`.","enum":["allow_incomplete","default_incomplete","error_if_incomplete","pending_if_incomplete"],"x-stripeEnum":{"kind":"open","values":[{"description":"This is the default behavior since [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails). Transition the subscription to `status=past_due` if payment fails. If you have payment retries configured, Stripe automatically retries the payment. If the payment requires action, you receive an `invoice.payment_action_required` webhook and must manage additional user actions. For example, SCA regulations might require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more.","value":"allow_incomplete"},{"description":"When payment is required, transition the subscription to `status=past_due` without attempting payment. You must request explicit confirmation of the Invoice's PaymentIntent. The resulting Invoice has [auto_advance=false](https://docs.stripe.com/api/invoices/object#invoice_object-auto_advance), so Stripe doesn't automatically attempt payment, retry payment, or finalize the subscription.","value":"default_incomplete"},{"description":"If payment fails, return an HTTP `402` status code and don't update the subscription. This behavior doesn't support payments that require user action, such as 3DS authentication, because it returns an error instead of creating a PaymentIntent with `status=requires_action`. To handle payments that require action, use `allow_incomplete` or `default_incomplete` instead. This behavior was the default for API versions before [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails).","value":"error_if_incomplete"},{"description":"If payment fails, Stripe creates a [pending update](https://docs.stripe.com/billing/subscriptions/pending-updates), which applies only if the payment eventually succeeds. This behavior doesn't support all [attributes and payment methods](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). This option is the simplest way to ensure the customer completes payment before Stripe applies the update.","value":"pending_if_incomplete"}]}},"plan":{"maxLength":5000,"type":"string","description":"The identifier of the plan to add to the subscription."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/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"]},"proration_date":{"type":"integer","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](/api/invoices/create_preview) endpoint.","format":"unix-time"},"quantity":{"type":"integer","description":"The quantity you'd like to apply to the subscription item you're creating."},"subscription":{"maxLength":5000,"type":"string","description":"The identifier of the subscription to modify."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]}},"additionalProperties":false,"x-stripeMostCommon":["metadata","payment_behavior","price","proration_behavior","quantity","subscription"]},"encoding":{"billing_thresholds":{"style":"deepObject","explode":true},"current_trial":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"price_data":{"style":"deepObject","explode":true},"tax_rates":{"style":"deepObject","explode":true},"trial":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_item"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_subscription_item"}},"/v1/subscription_items/{item}":{"get":{"summary":"Retrieve a subscription item","description":"Retrieves the subscription item with the given ID.
","operationId":"GetSubscriptionItemsItem","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"item","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_item"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_subscription_item"},"post":{"summary":"Update a subscription item","description":"Updates the plan or quantity of an item on a current subscription.
","operationId":"PostSubscriptionItemsItem","parameters":[{"name":"item","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"current_trial":{"title":"current_trial_param","required":["trial_offer"],"type":"object","properties":{"trial_end":{"type":"integer","description":"Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.","format":"unix-time"},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the subscription item."}},"description":"The trial offer to apply to this subscription item.","x-stripeMostCommon":["trial_end","trial_offer"]},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"off_session":{"type":"boolean","description":"Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session)."},"payment_behavior":{"type":"string","description":"Controls how Stripe handles payment when a subscription update requires payment and `collection_method=charge_automatically`.","enum":["allow_incomplete","default_incomplete","error_if_incomplete","pending_if_incomplete"],"x-stripeEnum":{"kind":"open","values":[{"description":"This is the default behavior since [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails). Transition the subscription to `status=past_due` if payment fails. If you have payment retries configured, Stripe automatically retries the payment. If the payment requires action, you receive an `invoice.payment_action_required` webhook and must manage additional user actions. For example, SCA regulations might require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more.","value":"allow_incomplete"},{"description":"When payment is required, transition the subscription to `status=past_due` without attempting payment. You must request explicit confirmation of the Invoice's PaymentIntent. The resulting Invoice has [auto_advance=false](https://docs.stripe.com/api/invoices/object#invoice_object-auto_advance), so Stripe doesn't automatically attempt payment, retry payment, or finalize the subscription.","value":"default_incomplete"},{"description":"If payment fails, return an HTTP `402` status code and don't update the subscription. This behavior doesn't support payments that require user action, such as 3DS authentication, because it returns an error instead of creating a PaymentIntent with `status=requires_action`. To handle payments that require action, use `allow_incomplete` or `default_incomplete` instead. This behavior was the default for API versions before [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails).","value":"error_if_incomplete"},{"description":"If payment fails, Stripe creates a [pending update](https://docs.stripe.com/billing/subscriptions/pending-updates), which applies only if the payment eventually succeeds. This behavior doesn't support all [attributes and payment methods](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). This option is the simplest way to ensure the customer completes payment before Stripe applies the update.","value":"pending_if_incomplete"}]}},"plan":{"maxLength":5000,"type":"string","description":"The identifier of the new plan for this subscription item."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/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"]},"proration_date":{"type":"integer","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](/api/invoices/create_preview) endpoint.","format":"unix-time"},"quantity":{"type":"integer","description":"The quantity you'd like to apply to the subscription item you're creating."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["metadata","payment_behavior","price","proration_behavior","quantity"]},"encoding":{"billing_thresholds":{"style":"deepObject","explode":true},"current_trial":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"price_data":{"style":"deepObject","explode":true},"tax_rates":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_item"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_subscription_item"},"delete":{"summary":"Delete a subscription item","description":"Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
","operationId":"DeleteSubscriptionItemsItem","parameters":[{"name":"item","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"clear_usage":{"type":"boolean","description":"Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`."},"payment_behavior":{"type":"string","description":"Controls how Stripe handles payment when a subscription update requires payment and `collection_method=charge_automatically`.","enum":["allow_incomplete","default_incomplete","error_if_incomplete","pending_if_incomplete"],"x-stripeEnum":{"kind":"open","values":[{"description":"This is the default behavior since [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails). Transition the subscription to `status=past_due` if payment fails. If you have payment retries configured, Stripe automatically retries the payment. If the payment requires action, you receive an `invoice.payment_action_required` webhook and must manage additional user actions. For example, SCA regulations might require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more.","value":"allow_incomplete"},{"description":"When payment is required, transition the subscription to `status=past_due` without attempting payment. You must request explicit confirmation of the Invoice's PaymentIntent. The resulting Invoice has [auto_advance=false](https://docs.stripe.com/api/invoices/object#invoice_object-auto_advance), so Stripe doesn't automatically attempt payment, retry payment, or finalize the subscription.","value":"default_incomplete"},{"description":"If payment fails, return an HTTP `402` status code and don't update the subscription. This behavior doesn't support payments that require user action, such as 3DS authentication, because it returns an error instead of creating a PaymentIntent with `status=requires_action`. To handle payments that require action, use `allow_incomplete` or `default_incomplete` instead. This behavior was the default for API versions before [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails).","value":"error_if_incomplete"},{"description":"If payment fails, Stripe creates a [pending update](https://docs.stripe.com/billing/subscriptions/pending-updates), which applies only if the payment eventually succeeds. This behavior doesn't support all [attributes and payment methods](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). This option is the simplest way to ensure the customer completes payment before Stripe applies the update.","value":"pending_if_incomplete"}]}},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/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"]},"proration_date":{"type":"integer","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](/api/invoices/create_preview) endpoint.","format":"unix-time"}},"additionalProperties":false,"x-stripeMostCommon":["payment_behavior","proration_behavior"]},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_subscription_item"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_billing_subscription_item"}},"/v1/subscription_schedules":{"get":{"summary":"List all schedules","description":"Retrieves the list of your subscription schedules.
","operationId":"GetSubscriptionSchedules","parameters":[{"name":"canceled_at","in":"query","description":"Only return subscription schedules that were created canceled the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"completed_at","in":"query","description":"Only return subscription schedules that completed during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"created","in":"query","description":"Only return subscription schedules that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"customer","in":"query","description":"Only return subscription schedules for the given customer. The response will not include subscription schedules for customers with a test clock attached if this parameter is not set.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"customer_account","in":"query","description":"Only return subscription schedules for the given account.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"released_at","in":"query","description":"Only return subscription schedules that were released during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"scheduled","in":"query","description":"Only return subscription schedules that have not started yet.","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SubscriptionSchedulesResourceScheduleList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subscription_schedule"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/subscription_schedules","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_billing_subscription_schedules"},"post":{"summary":"Create a schedule","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":{"schema":{"type":"object","properties":{"billing_behavior":{"type":"string","description":"Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.","enum":["prorate_on_next_phase","prorate_up_front"]},"billing_mode":{"title":"billing_mode","required":["type"],"type":"object","properties":{"flexible":{"title":"flexible_params","type":"object","properties":{"proration_discounts":{"type":"string","description":"Controls how invoices and invoice items display proration amounts and discount amounts.","enum":["included","itemized"],"x-stripeEnum":{"kind":"open","values":[{"description":"Amounts are net of discounts, and discount amounts are zero.","value":"included"},{"description":"Amounts are gross of discounts, and discount amounts are accurate.","value":"itemized"}]}}},"description":"Configure behavior for flexible billing mode.","x-stripeMostCommon":["proration_discounts"]},"type":{"type":"string","description":"Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.","enum":["classic","flexible"]}},"description":"Controls how prorations and invoices for subscriptions are calculated and orchestrated.","x-stripeMostCommon":["flexible","type"]},"customer":{"maxLength":5000,"type":"string","description":"The identifier of the customer to create the subscription schedule for."},"customer_account":{"maxLength":5000,"type":"string","description":"The identifier of the account to create the subscription schedule for."},"default_settings":{"title":"default_settings_params","type":"object","properties":{"application_fee_percent":{"type":"number","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":{"title":"automatic_tax_config","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Default settings for automatic tax computation.","x-stripeMostCommon":["enabled","liability"]},"billing_cycle_anchor":{"type":"string","description":"Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["automatic","phase_start"]},"billing_thresholds":{"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.","anyOf":[{"title":"billing_thresholds_param","type":"object","properties":{"amount_gte":{"type":"integer","description":"Monetary threshold that triggers the subscription to advance to a new billing period"},"reset_billing_cycle_anchor":{"type":"boolean","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."}},"x-stripeMostCommon":["amount_gte","reset_billing_cycle_anchor"]},{"type":"string","enum":[""]}]},"collection_method":{"type":"string","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`. Defaults to `charge_automatically` on creation.","enum":["charge_automatically","send_invoice"]},"default_payment_method":{"maxLength":5000,"type":"string","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."},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"invoice_settings":{"title":"subscription_schedule_default_settings_param","type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"days_until_due":{"type":"integer","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 `collection_method=charge_automatically`."},"description":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"string","enum":[""]}]},"footer":{"anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","days_until_due","description","footer","issuer","rendering","send_hosted_payment_email","supported_payment_methods"]},"on_behalf_of":{"description":"The account on behalf of which to charge, for each of the associated subscription's invoices.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"transfer_data":{"description":"The data with which to automatically create a Transfer for each of the associated subscription's invoices.","anyOf":[{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"x-stripeMostCommon":["amount_percent","destination"]},{"type":"string","enum":[""]}]}},"description":"Object representing the subscription schedule's default settings.","x-stripeMostCommon":["application_fee_percent","automatic_tax","billing_cycle_anchor","billing_thresholds","collection_method","default_payment_method","description","invoice_settings","on_behalf_of","phase_effective_at","transfer_data"]},"end_behavior":{"type":"string","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"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"from_subscription":{"maxLength":5000,"type":"string","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."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"pause_schedules":{"type":"array","description":"Configures the subscription's pause behavior and, optionally, its resume behavior. Only one entry is supported.","items":{"title":"pause_schedules_create_params","type":"object","properties":{"key":{"maxLength":40,"type":"string","description":"A unique identifier for this pause schedule entry."},"pause":{"title":"pause_schedule_create_pause_params","required":["pause_at"],"type":"object","properties":{"pause_at":{"title":"pause_at_params","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The Unix timestamp at which to pause the subscription. Required when `type` is `timestamp`.","format":"unix-time"},"type":{"type":"string","description":"When to pause the subscription. Use `now` to pause immediately or `timestamp` to pause at a specific time.","enum":["now","timestamp"]}},"description":"When to pause the subscription.","x-stripeMostCommon":["timestamp","type"]},"settings":{"title":"pause_settings_params","type":"object","properties":{"bill_for":{"title":"pause_settings_bill_for_params","type":"object","properties":{"outstanding_usage_through":{"title":"pause_settings_bill_for_outstanding_usage_through_params","type":"object","properties":{"type":{"type":"string","description":"Determines whether to collect metered usage accrued up to the pause date. When adding a pause schedule, defaults to `pause_at`. On updates, the existing value is preserved if not provided.","enum":["none","pause_at"],"x-stripeEnum":{"kind":"open","values":[{"description":"Do not collect outstanding metered usage.","value":"none"},{"description":"Collect metered usage accrued through the pause date.","value":"pause_at"}]}}},"description":"Controls whether to collect metered usage accrued up to the pause date.","x-stripeMostCommon":["type"]},"unused_time_from":{"title":"pause_settings_bill_for_unused_time_from_params","type":"object","properties":{"type":{"type":"string","description":"Determines which point in the billing period unused time is credited from. When adding a pause schedule, defaults to `pause_at`. On updates, the existing value is preserved if not provided.","enum":["item_current_period_start","none","pause_at"],"x-stripeEnum":{"kind":"open","values":[{"description":"Credit unused time from the start of each item's current billing period.","value":"item_current_period_start"},{"description":"Do not credit unused time.","value":"none"},{"description":"Credit unused time from the pause date.","value":"pause_at"}]}}},"description":"Controls how unused time on subscription items is credited when pausing.","x-stripeMostCommon":["type"]}},"description":"Controls what to bill for when pausing the subscription.","x-stripeMostCommon":["outstanding_usage_through","unused_time_from"]},"invoicing_behavior":{"type":"string","description":"Determines whether to generate an invoice for outstanding amounts when pausing. When adding a pause schedule, defaults to `pending_invoice_item`. On updates, the existing value is preserved if not provided.","enum":["invoice","pending_invoice_item"],"x-stripeEnum":{"kind":"open","values":[{"description":"Invoices immediately for debits and credits in the current period. If pausing doesn't create any invoice items, Stripe doesn't generate an invoice.","value":"invoice"},{"description":"Creates pending invoice items for debits and credits in the current period.","value":"pending_invoice_item"}]}},"type":{"type":"string","description":"The pause type. Currently only `subscription` is supported.","enum":["subscription"],"x-stripeEnum":{"kind":"open","values":[{"description":"Pauses collection, billing, and servicing.","value":"subscription"}]}}},"description":"Settings controlling billing behavior during the pause.","x-stripeMostCommon":["bill_for","invoicing_behavior","type"]}},"description":"Configuration for when and how the subscription pauses.","x-stripeMostCommon":["pause_at","settings"]},"resume":{"title":"pause_schedule_create_resume_params","required":["resume_at"],"type":"object","properties":{"resume_at":{"title":"resume_at_params","required":["type"],"type":"object","properties":{"duration":{"title":"resume_at_duration_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"The time unit for the resume duration. One of `day`, `week`, `month`, or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals after which the subscription resumes."}},"description":"The duration after which to resume the subscription. Required when `type` is `duration`.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"The Unix timestamp at which to resume the subscription. Required when `type` is `timestamp`.","format":"unix-time"},"type":{"type":"string","description":"When to resume the subscription. Use `now` to resume immediately, `duration` to resume after a set duration, or `timestamp` to resume at a specific time.","enum":["duration","now","timestamp"]}},"description":"When to resume the subscription.","x-stripeMostCommon":["duration","timestamp","type"]},"settings":{"title":"resume_settings_params","type":"object","properties":{"billing_cycle_anchor":{"type":"string","description":"Controls the billing cycle anchor when the subscription resumes. When adding a pause schedule, defaults to `resume_at`. On updates, the existing value is preserved if not provided.","enum":["resume_at","unchanged"],"x-stripeEnum":{"kind":"open","values":[{"description":"Set the billing cycle anchor to the date the subscription resumes.","value":"resume_at"},{"description":"Keep the existing billing cycle anchor.","value":"unchanged"}]}},"payment_behavior":{"type":"string","description":"Controls whether Stripe attempts payment on the resumption invoice and how payment affects the subscription's status. When adding a pause schedule, defaults to `resume_on_payment_success`. On updates, the existing value is preserved if not provided.","enum":["resume_on_payment_attempt","resume_on_payment_success"],"x-stripeEnum":{"kind":"open","values":[{"description":"If you create a resumption invoice, Stripe finalizes the invoice immediately but doesn't attempt payment. You can then manually attempt payment on the invoice using the [Pay invoice endpoint](/api/invoices/pay). If the payment attempt succeeds, the subscription becomes `active`. If the payment attempt fails, the subscription becomes `past_due`. If the invoice has no payment attempts after 23 hours, Stripe voids the invoice and the subscription remains `paused`.","value":"resume_on_payment_attempt"},{"description":"If you create a resumption invoice, Stripe finalizes and attempts payment on the invoice immediately. If that payment attempt succeeds, the subscription becomes `active`. If that payment attempt fails, the subscription remains `paused`. You can then manually attempt payment on the invoice using the [Pay invoice endpoint](/api/invoices/pay). If the invoice isn't paid successfully within 1 year of its creation, Stripe voids the invoice and the subscription remains `paused`.","value":"resume_on_payment_success"}]}},"proration_behavior":{"type":"string","description":"Determines how to handle prorations when the subscription resumes. When adding a pause schedule, defaults to `create_prorations`. On updates, the existing value is preserved if not provided.","enum":["always_invoice","create_prorations","none"]}},"description":"Settings controlling how the subscription resumes.","x-stripeMostCommon":["billing_cycle_anchor","payment_behavior","proration_behavior"]}},"description":"Configuration for when and how the subscription resumes.","x-stripeMostCommon":["resume_at","settings"]}},"x-stripeMostCommon":["key","pause","resume"]}},"phases":{"type":"array","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":{"title":"phase_configuration_params","required":["items"],"type":"object","properties":{"add_invoice_items":{"type":"array","description":"A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.","items":{"title":"add_invoice_item_entry","type":"object","properties":{"discountable":{"type":"boolean","description":"Controls whether discounts apply to this invoice item. Defaults to true if no value is provided."},"discounts":{"type":"array","description":"The coupons to redeem into discounts for the item.","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"title":"invoice_item_period","required":["end","start"],"type":"object","properties":{"end":{"title":"invoice_item_period_end","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the end of the invoice item period.","enum":["min_item_period_end","phase_end","timestamp"],"x-stripeBypassValidation":true}},"description":"End of the invoice item period.","x-stripeMostCommon":["timestamp","type"]},"start":{"title":"invoice_item_period_start","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the start of the invoice item period.","enum":["max_item_period_start","phase_start","timestamp"],"x-stripeBypassValidation":true}},"description":"Start of the invoice item period.","x-stripeMostCommon":["timestamp","type"]}},"description":"The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.","x-stripeMostCommon":["end","start"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. One of `price` or `price_data` is required."},"price_data":{"title":"one_time_price_data_with_negative_amounts","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for this item. Defaults to 1."},"tax_rates":{"description":"The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["price","quantity"],"x-stripeParam":{"class_name":"AddInvoiceItem"}}},"application_fee_percent":{"type":"number","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":{"title":"automatic_tax_config","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Automatic tax settings for this phase.","x-stripeMostCommon":["enabled","liability"]},"billing_cycle_anchor":{"type":"string","description":"Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["automatic","phase_start"]},"billing_thresholds":{"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.","anyOf":[{"title":"billing_thresholds_param","type":"object","properties":{"amount_gte":{"type":"integer","description":"Monetary threshold that triggers the subscription to advance to a new billing period"},"reset_billing_cycle_anchor":{"type":"boolean","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."}},"x-stripeMostCommon":["amount_gte","reset_billing_cycle_anchor"]},{"type":"string","enum":[""]}]},"collection_method":{"type":"string","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`. Defaults to `charge_automatically` on creation.","enum":["charge_automatically","send_invoice"]},"currency":{"type":"string","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).","format":"currency"},"default_payment_method":{"maxLength":5000,"type":"string","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."},"default_tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.","anyOf":[{"type":"array","items":{"title":"schedule_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"duration":{"title":"duration_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies phase duration. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The multiplier applied to the interval."}},"description":"The number of intervals the phase should last. If set, `end_date` must not be set.","x-stripeMostCommon":["interval","interval_count"]},"end_date":{"type":"integer","description":"The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.","format":"unix-time"},"invoice_settings":{"title":"schedule_phase_invoice_settings","type":"object","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.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"description":"A list of up to 4 custom fields to be displayed on the invoice.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"days_until_due":{"type":"integer","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 `collection_method=charge_automatically`."},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":1500,"type":"string"},{"type":"string","enum":[""]}]},"footer":{"description":"Footer to be displayed on the invoice.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","days_until_due","description","footer","issuer","send_hosted_payment_email","supported_payment_methods"]},"items":{"type":"array","description":"List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.","items":{"title":"configuration_item_params","type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"schedule_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`."},"plan":{"maxLength":5000,"type":"string","description":"The plan ID to subscribe to. You may specify the same ID in `plan` and `price`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"x-stripeMostCommon":["billing_thresholds","discounts","metadata","plan","price","quantity","tax_rates","trial","trial_offer"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/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, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`."},"on_behalf_of":{"type":"string","description":"The account on behalf of which to charge, for each of the associated subscription's invoices."},"pause_collection":{"title":"pause_collection_params","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}}},"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](https://docs.stripe.com/billing/subscriptions/pause-payment).","x-stripeMostCommon":["behavior"]},"proration_behavior":{"type":"string","description":"Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.","enum":["always_invoice","create_prorations","none"]},"transfer_data":{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"description":"The data with which to automatically create a Transfer for each of the associated subscription's invoices.","x-stripeMostCommon":["amount_percent","destination"]},"trial":{"type":"boolean","description":"If set to true the entire phase is counted as a trial and the customer will not be charged for any fees."},"trial_continuation":{"type":"string","description":"Specify trial behavior when crossing phase boundaries","enum":["continue","none"]},"trial_end":{"type":"integer","description":"Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`","format":"unix-time"},"trial_settings":{"title":"trial_settings_specs","type":"object","properties":{"end_behavior":{"title":"end_behavior_specs","type":"object","properties":{"prorate_up_front":{"type":"string","description":"Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.","enum":["defer","include"]}},"description":"Defines how the subscription should behave when a trial ends.","x-stripeMostCommon":["prorate_up_front"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"x-stripeMostCommon":["add_invoice_items","application_fee_percent","automatic_tax","billing_cycle_anchor","billing_thresholds","cancel_at_period_end","collection_method","currency","default_payment_method","default_tax_rates","description","discounts","duration","effective_at","end_date","invoice_settings","items","metadata","on_behalf_of","pause_collection","proration_behavior","tax_filing_currency","transfer_data","trial","trial_continuation","trial_end","trial_settings"]}},"prebilling":{"title":"prebilling_specs","required":["iterations"],"type":"object","properties":{"iterations":{"type":"integer","description":"This is used to determine the number of billing cycles to prebill."},"update_behavior":{"type":"string","description":"Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.","enum":["prebill","reset"]}},"description":"If specified, the invoicing for the given billing cycle iterations will be processed now.","x-stripeMostCommon":["iterations","update_behavior"]},"start_date":{"description":"When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately, and to avoid unexpected behavior due to request delays or clock skew resulting in a slightly backdated or postdated start. 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.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]}},"additionalProperties":false,"x-stripeMostCommon":["customer","metadata","phases","start_date"]},"encoding":{"billing_mode":{"style":"deepObject","explode":true},"default_settings":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"pause_schedules":{"style":"deepObject","explode":true},"phases":{"style":"deepObject","explode":true},"prebilling":{"style":"deepObject","explode":true},"start_date":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_schedule"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_billing_subscription_schedule"}},"/v1/subscription_schedules/{schedule}":{"get":{"summary":"Retrieve a schedule","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"schedule","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_schedule"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_subscription_schedule"},"post":{"summary":"Update a schedule","description":"Updates an existing subscription schedule.
","operationId":"PostSubscriptionSchedulesSchedule","parameters":[{"name":"schedule","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"billing_behavior":{"type":"string","description":"Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.","enum":["prorate_on_next_phase","prorate_up_front"]},"default_settings":{"title":"default_settings_params","type":"object","properties":{"application_fee_percent":{"type":"number","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":{"title":"automatic_tax_config","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Default settings for automatic tax computation.","x-stripeMostCommon":["enabled","liability"]},"billing_cycle_anchor":{"type":"string","description":"Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["automatic","phase_start"]},"billing_thresholds":{"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.","anyOf":[{"title":"billing_thresholds_param","type":"object","properties":{"amount_gte":{"type":"integer","description":"Monetary threshold that triggers the subscription to advance to a new billing period"},"reset_billing_cycle_anchor":{"type":"boolean","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."}},"x-stripeMostCommon":["amount_gte","reset_billing_cycle_anchor"]},{"type":"string","enum":[""]}]},"collection_method":{"type":"string","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`. Defaults to `charge_automatically` on creation.","enum":["charge_automatically","send_invoice"]},"default_payment_method":{"maxLength":5000,"type":"string","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."},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"invoice_settings":{"title":"subscription_schedule_default_settings_param","type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"days_until_due":{"type":"integer","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 `collection_method=charge_automatically`."},"description":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"string","enum":[""]}]},"footer":{"anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","days_until_due","description","footer","issuer","rendering","send_hosted_payment_email","supported_payment_methods"]},"on_behalf_of":{"description":"The account on behalf of which to charge, for each of the associated subscription's invoices.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"transfer_data":{"description":"The data with which to automatically create a Transfer for each of the associated subscription's invoices.","anyOf":[{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"x-stripeMostCommon":["amount_percent","destination"]},{"type":"string","enum":[""]}]}},"description":"Object representing the subscription schedule's default settings.","x-stripeMostCommon":["application_fee_percent","automatic_tax","billing_cycle_anchor","billing_thresholds","collection_method","default_payment_method","description","invoice_settings","on_behalf_of","phase_effective_at","transfer_data"]},"end_behavior":{"type":"string","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"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"pause_schedules":{"description":"Configures the subscription's pause behavior and, optionally, its resume behavior. Only one entry is supported. Include a key to update an existing entry. Omit to leave an existing pause schedule unchanged, or pass \"\" to clear it.","anyOf":[{"type":"array","items":{"title":"pause_schedules_update_params","type":"object","properties":{"key":{"maxLength":40,"type":"string","description":"A unique identifier for this pause schedule entry."},"pause":{"title":"pause_schedule_update_pause_params","type":"object","properties":{"pause_at":{"title":"pause_at_params","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"The Unix timestamp at which to pause the subscription. Required when `type` is `timestamp`.","format":"unix-time"},"type":{"type":"string","description":"When to pause the subscription. Use `now` to pause immediately or `timestamp` to pause at a specific time.","enum":["now","timestamp"]}},"description":"When to pause the subscription.","x-stripeMostCommon":["timestamp","type"]},"settings":{"title":"pause_settings_params","type":"object","properties":{"bill_for":{"title":"pause_settings_bill_for_params","type":"object","properties":{"outstanding_usage_through":{"title":"pause_settings_bill_for_outstanding_usage_through_params","type":"object","properties":{"type":{"type":"string","description":"Determines whether to collect metered usage accrued up to the pause date. When adding a pause schedule, defaults to `pause_at`. On updates, the existing value is preserved if not provided.","enum":["none","pause_at"],"x-stripeEnum":{"kind":"open","values":[{"description":"Do not collect outstanding metered usage.","value":"none"},{"description":"Collect metered usage accrued through the pause date.","value":"pause_at"}]}}},"description":"Controls whether to collect metered usage accrued up to the pause date.","x-stripeMostCommon":["type"]},"unused_time_from":{"title":"pause_settings_bill_for_unused_time_from_params","type":"object","properties":{"type":{"type":"string","description":"Determines which point in the billing period unused time is credited from. When adding a pause schedule, defaults to `pause_at`. On updates, the existing value is preserved if not provided.","enum":["item_current_period_start","none","pause_at"],"x-stripeEnum":{"kind":"open","values":[{"description":"Credit unused time from the start of each item's current billing period.","value":"item_current_period_start"},{"description":"Do not credit unused time.","value":"none"},{"description":"Credit unused time from the pause date.","value":"pause_at"}]}}},"description":"Controls how unused time on subscription items is credited when pausing.","x-stripeMostCommon":["type"]}},"description":"Controls what to bill for when pausing the subscription.","x-stripeMostCommon":["outstanding_usage_through","unused_time_from"]},"invoicing_behavior":{"type":"string","description":"Determines whether to generate an invoice for outstanding amounts when pausing. When adding a pause schedule, defaults to `pending_invoice_item`. On updates, the existing value is preserved if not provided.","enum":["invoice","pending_invoice_item"],"x-stripeEnum":{"kind":"open","values":[{"description":"Invoices immediately for debits and credits in the current period. If pausing doesn't create any invoice items, Stripe doesn't generate an invoice.","value":"invoice"},{"description":"Creates pending invoice items for debits and credits in the current period.","value":"pending_invoice_item"}]}},"type":{"type":"string","description":"The pause type. Currently only `subscription` is supported.","enum":["subscription"],"x-stripeEnum":{"kind":"open","values":[{"description":"Pauses collection, billing, and servicing.","value":"subscription"}]}}},"description":"Settings controlling billing behavior during the pause.","x-stripeMostCommon":["bill_for","invoicing_behavior","type"]}},"description":"Configuration for when and how the subscription pauses.","x-stripeMostCommon":["pause_at","settings"]},"resume":{"description":"Configuration for when and how the subscription resumes.","anyOf":[{"title":"pause_schedule_update_resume_params","type":"object","properties":{"resume_at":{"title":"resume_at_params","required":["type"],"type":"object","properties":{"duration":{"title":"resume_at_duration_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"The time unit for the resume duration. One of `day`, `week`, `month`, or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals after which the subscription resumes."}},"description":"The duration after which to resume the subscription. Required when `type` is `duration`.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"The Unix timestamp at which to resume the subscription. Required when `type` is `timestamp`.","format":"unix-time"},"type":{"type":"string","description":"When to resume the subscription. Use `now` to resume immediately, `duration` to resume after a set duration, or `timestamp` to resume at a specific time.","enum":["duration","now","timestamp"]}},"description":"When to resume the subscription.","x-stripeMostCommon":["duration","timestamp","type"]},"settings":{"title":"resume_settings_params","type":"object","properties":{"billing_cycle_anchor":{"type":"string","description":"Controls the billing cycle anchor when the subscription resumes. When adding a pause schedule, defaults to `resume_at`. On updates, the existing value is preserved if not provided.","enum":["resume_at","unchanged"],"x-stripeEnum":{"kind":"open","values":[{"description":"Set the billing cycle anchor to the date the subscription resumes.","value":"resume_at"},{"description":"Keep the existing billing cycle anchor.","value":"unchanged"}]}},"payment_behavior":{"type":"string","description":"Controls whether Stripe attempts payment on the resumption invoice and how payment affects the subscription's status. When adding a pause schedule, defaults to `resume_on_payment_success`. On updates, the existing value is preserved if not provided.","enum":["resume_on_payment_attempt","resume_on_payment_success"],"x-stripeEnum":{"kind":"open","values":[{"description":"If you create a resumption invoice, Stripe finalizes the invoice immediately but doesn't attempt payment. You can then manually attempt payment on the invoice using the [Pay invoice endpoint](/api/invoices/pay). If the payment attempt succeeds, the subscription becomes `active`. If the payment attempt fails, the subscription becomes `past_due`. If the invoice has no payment attempts after 23 hours, Stripe voids the invoice and the subscription remains `paused`.","value":"resume_on_payment_attempt"},{"description":"If you create a resumption invoice, Stripe finalizes and attempts payment on the invoice immediately. If that payment attempt succeeds, the subscription becomes `active`. If that payment attempt fails, the subscription remains `paused`. You can then manually attempt payment on the invoice using the [Pay invoice endpoint](/api/invoices/pay). If the invoice isn't paid successfully within 1 year of its creation, Stripe voids the invoice and the subscription remains `paused`.","value":"resume_on_payment_success"}]}},"proration_behavior":{"type":"string","description":"Determines how to handle prorations when the subscription resumes. When adding a pause schedule, defaults to `create_prorations`. On updates, the existing value is preserved if not provided.","enum":["always_invoice","create_prorations","none"]}},"description":"Settings controlling how the subscription resumes.","x-stripeMostCommon":["billing_cycle_anchor","payment_behavior","proration_behavior"]}},"x-stripeMostCommon":["resume_at","settings"]},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["key","pause","resume"]}},{"type":"string","enum":[""]}]},"phases":{"type":"array","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":{"title":"phase_configuration_params","required":["items"],"type":"object","properties":{"add_invoice_items":{"type":"array","description":"A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.","items":{"title":"add_invoice_item_entry","type":"object","properties":{"discountable":{"type":"boolean","description":"Controls whether discounts apply to this invoice item. Defaults to true if no value is provided."},"discounts":{"type":"array","description":"The coupons to redeem into discounts for the item.","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"title":"invoice_item_period","required":["end","start"],"type":"object","properties":{"end":{"title":"invoice_item_period_end","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the end of the invoice item period.","enum":["min_item_period_end","phase_end","timestamp"],"x-stripeBypassValidation":true}},"description":"End of the invoice item period.","x-stripeMostCommon":["timestamp","type"]},"start":{"title":"invoice_item_period_start","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the start of the invoice item period.","enum":["max_item_period_start","phase_start","timestamp"],"x-stripeBypassValidation":true}},"description":"Start of the invoice item period.","x-stripeMostCommon":["timestamp","type"]}},"description":"The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.","x-stripeMostCommon":["end","start"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. One of `price` or `price_data` is required."},"price_data":{"title":"one_time_price_data_with_negative_amounts","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for this item. Defaults to 1."},"tax_rates":{"description":"The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["price","quantity"],"x-stripeParam":{"class_name":"AddInvoiceItem"}}},"application_fee_percent":{"type":"number","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":{"title":"automatic_tax_config","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Automatic tax settings for this phase.","x-stripeMostCommon":["enabled","liability"]},"billing_cycle_anchor":{"type":"string","description":"Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).","enum":["automatic","phase_start"]},"billing_thresholds":{"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.","anyOf":[{"title":"billing_thresholds_param","type":"object","properties":{"amount_gte":{"type":"integer","description":"Monetary threshold that triggers the subscription to advance to a new billing period"},"reset_billing_cycle_anchor":{"type":"boolean","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."}},"x-stripeMostCommon":["amount_gte","reset_billing_cycle_anchor"]},{"type":"string","enum":[""]}]},"collection_method":{"type":"string","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`. Defaults to `charge_automatically` on creation.","enum":["charge_automatically","send_invoice"]},"currency":{"type":"string","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).","format":"currency"},"default_payment_method":{"maxLength":5000,"type":"string","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."},"default_tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.","anyOf":[{"type":"array","items":{"title":"schedule_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"duration":{"title":"duration_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies phase duration. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The multiplier applied to the interval."}},"description":"The number of intervals the phase should last. If set, `end_date` must not be set.","x-stripeMostCommon":["interval","interval_count"]},"end_date":{"description":"The date at which this phase of the subscription schedule ends. If set, `duration` must not be set.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]},"invoice_settings":{"title":"schedule_phase_invoice_settings","type":"object","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.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"description":"A list of up to 4 custom fields to be displayed on the invoice.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"days_until_due":{"type":"integer","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 `collection_method=charge_automatically`."},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":1500,"type":"string"},{"type":"string","enum":[""]}]},"footer":{"description":"Footer to be displayed on the invoice.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","days_until_due","description","footer","issuer","send_hosted_payment_email","supported_payment_methods"]},"items":{"type":"array","description":"List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.","items":{"title":"configuration_item_params","type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"schedule_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`."},"plan":{"maxLength":5000,"type":"string","description":"The plan ID to subscribe to. You may specify the same ID in `plan` and `price`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"x-stripeMostCommon":["billing_thresholds","discounts","metadata","plan","price","quantity","tax_rates","trial","trial_offer"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/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, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`."},"on_behalf_of":{"type":"string","description":"The account on behalf of which to charge, for each of the associated subscription's invoices."},"pause_collection":{"title":"pause_collection_params","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}}},"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](https://docs.stripe.com/billing/subscriptions/pause-payment).","x-stripeMostCommon":["behavior"]},"proration_behavior":{"type":"string","description":"Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.","enum":["always_invoice","create_prorations","none"]},"start_date":{"description":"The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. Prefer to specify `now` over an explicit timestamp when appropriate to avoid unexpected behavior due to request delays or clock skew resulting in the phase being slightly backdated or postdated.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]},"transfer_data":{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"description":"The data with which to automatically create a Transfer for each of the associated subscription's invoices.","x-stripeMostCommon":["amount_percent","destination"]},"trial":{"type":"boolean","description":"If set to true the entire phase is counted as a trial and the customer will not be charged for any fees."},"trial_continuation":{"type":"string","description":"Specify trial behavior when crossing phase boundaries","enum":["continue","none"]},"trial_end":{"description":"Sets the phase to trialing from the start date to this date. Must be within the phase. When combined with `trial=true`, it must match the phase end date.","anyOf":[{"type":"integer","format":"unix-time"},{"maxLength":5000,"type":"string","enum":["now"]}]},"trial_settings":{"title":"trial_settings_specs","type":"object","properties":{"end_behavior":{"title":"end_behavior_specs","type":"object","properties":{"prorate_up_front":{"type":"string","description":"Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.","enum":["defer","include"]}},"description":"Defines how the subscription should behave when a trial ends.","x-stripeMostCommon":["prorate_up_front"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"x-stripeMostCommon":["add_invoice_items","application_fee_percent","automatic_tax","billing_cycle_anchor","billing_thresholds","collection_method","currency","default_payment_method","default_tax_rates","description","discounts","duration","effective_at","end_date","invoice_settings","items","metadata","on_behalf_of","pause_collection","proration_behavior","start_date","tax_filing_currency","transfer_data","trial","trial_continuation","trial_end","trial_settings"]}},"prebilling":{"title":"prebilling_specs","required":["iterations"],"type":"object","properties":{"iterations":{"type":"integer","description":"This is used to determine the number of billing cycles to prebill."},"update_behavior":{"type":"string","description":"Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.","enum":["prebill","reset"]}},"description":"If specified, the invoicing for the given billing cycle iterations will be processed now.","x-stripeMostCommon":["iterations","update_behavior"]},"proration_behavior":{"type":"string","description":"If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.","enum":["always_invoice","create_prorations","none"]}},"additionalProperties":false,"x-stripeMostCommon":["metadata","phases","proration_behavior"]},"encoding":{"default_settings":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"pause_schedules":{"style":"deepObject","explode":true},"phases":{"style":"deepObject","explode":true},"prebilling":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_schedule"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_subscription_schedule"}},"/v1/subscription_schedules/{schedule}/amend":{"post":{"summary":"Amend a schedule","description":"Amends an existing subscription schedule.
","operationId":"PostSubscriptionSchedulesScheduleAmend","parameters":[{"name":"schedule","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amendments":{"type":"array","description":"Changes to apply to the phases of the subscription schedule, in the order provided.","items":{"title":"amendment_specs","required":["amendment_start"],"type":"object","properties":{"amendment_end":{"title":"specs","required":["type"],"type":"object","properties":{"discount_end":{"title":"discount_end_specs","required":["discount"],"type":"object","properties":{"discount":{"maxLength":5000,"type":"string","description":"The ID of a specific discount."}},"description":"Use the `end` time of a given discount.","x-stripeMostCommon":["discount"]},"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the amendment starting from the `amendment_start`.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.","format":"unix-time"},"type":{"type":"string","description":"Select one of three ways to pass the `amendment_end`.","enum":["discount_end","duration","schedule_end","timestamp","trial_end","trial_start","upcoming_invoice"]}},"description":"Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.","x-stripeMostCommon":["discount_end","duration","timestamp","type"]},"amendment_start":{"title":"specs","required":["type"],"type":"object","properties":{"amendment_end":{"title":"amendment_end_index_specs","required":["index"],"type":"object","properties":{"index":{"type":"integer","description":"The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array."}},"description":"Details of another amendment in the same array, immediately after which this amendment should begin.","x-stripeMostCommon":["index"]},"discount_end":{"title":"discount_end_specs","required":["discount"],"type":"object","properties":{"discount":{"maxLength":5000,"type":"string","description":"The ID of a specific discount."}},"description":"Use the `end` time of a given discount.","x-stripeMostCommon":["discount"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the amendment to start.","format":"unix-time"},"type":{"type":"string","description":"Select one of three ways to pass the `amendment_start`.","enum":["amendment_end","discount_end","now","schedule_end","timestamp","trial_end","trial_start","upcoming_invoice"]}},"description":"Details to identify the earliest timestamp where the proposed change should take effect.","x-stripeMostCommon":["amendment_end","discount_end","timestamp","type"]},"billing_cycle_anchor":{"type":"string","description":"For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp. For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.","enum":["amendment_start","automatic"]},"discount_actions":{"type":"array","description":"Changes to the coupons being redeemed or discounts being applied during the amendment time span.","items":{"title":"specs","required":["type"],"type":"object","properties":{"add":{"title":"add_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to redeem."},"discount":{"maxLength":5000,"type":"string","description":"An ID of an existing discount for a coupon that was already redeemed."},"discount_end":{"title":"amendment_discount_end","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["amendment_end"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["type"]},"index":{"type":"integer","description":"The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array."},"promotion_code":{"maxLength":5000,"type":"string","description":"The promotion code to redeem."}},"description":"Details of the discount to add.","x-stripeMostCommon":["coupon","discount","discount_end","index","promotion_code","settings"]},"remove":{"title":"remove_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to remove from the `discounts` array."},"discount":{"maxLength":5000,"type":"string","description":"The ID of a discount to remove from the `discounts` array."},"promotion_code":{"maxLength":5000,"type":"string","description":"The ID of a promotion code to remove from the `discounts` array."}},"description":"Details of the discount to remove.","x-stripeMostCommon":["coupon","discount","promotion_code"]},"set":{"title":"set_discount_specs","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"The coupon code to replace the `discounts` array with."},"discount":{"maxLength":5000,"type":"string","description":"An ID of an existing discount to replace the `discounts` array with."},"promotion_code":{"maxLength":5000,"type":"string","description":"An ID of an existing promotion code to replace the `discounts` array with."}},"description":"Details of the discount to replace the existing discounts with.","x-stripeMostCommon":["coupon","discount","promotion_code","settings"]},"type":{"type":"string","description":"Determines the type of discount action.","enum":["add","remove","set"]}},"x-stripeMostCommon":["add","remove","set","type"]}},"item_actions":{"type":"array","description":"Changes to the subscription items during the amendment time span.","items":{"title":"specs","required":["type"],"type":"object","properties":{"add":{"title":"add_item_specs","required":["price"],"type":"object","properties":{"discounts":{"type":"array","description":"The discounts applied to the item. Subscription item discounts are applied before subscription discounts.","items":{"title":"schedule_amendments_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"quantity":{"type":"integer","description":"Quantity for this item."},"tax_rates":{"type":"array","description":"The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.","items":{"maxLength":5000,"type":"string"}},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"Options that configure the trial on the subscription item.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"description":"Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.","x-stripeMostCommon":["discounts","metadata","price","quantity","tax_rates","trial","trial_offer"]},"remove":{"title":"remove_item_specs","required":["price"],"type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"ID of a price to remove."}},"description":"Details of the subscription item to remove.","x-stripeMostCommon":["price"]},"set":{"title":"set_item_specs","required":["price"],"type":"object","properties":{"discounts":{"type":"array","description":"If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.","items":{"title":"schedule_amendments_discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"quantity":{"type":"integer","description":"If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`."},"tax_rates":{"type":"array","description":"If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.","items":{"maxLength":5000,"type":"string"}},"trial":{"title":"trial_specs","required":["type"],"type":"object","properties":{"converts_to":{"type":"array","description":"List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Determines the type of trial for this item.","enum":["free","paid"]}},"description":"If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.","x-stripeMostCommon":["converts_to","type"]},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the configuration item."}},"description":"Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.","x-stripeMostCommon":["discounts","metadata","price","quantity","tax_rates","trial","trial_offer"]},"type":{"type":"string","description":"Determines the type of item action.","enum":["add","remove","set"]}},"x-stripeMostCommon":["add","remove","set","type"]}},"metadata_actions":{"type":"array","description":"Instructions for how to modify phase metadata","items":{"title":"specs","required":["type"],"type":"object","properties":{"add":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata."},"remove":{"type":"array","description":"Keys to remove from schedule phase metadata.","items":{"maxLength":5000,"type":"string"}},"set":{"description":"Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"type":{"type":"string","description":"Select one of three ways to update phase-level `metadata` on subscription schedules.","enum":["add","remove","set"]}},"x-stripeMostCommon":["add","remove","set","type"]}},"proration_behavior":{"type":"string","description":"Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.","enum":["always_invoice","create_prorations","none"]},"set_pause_collection":{"title":"specs","required":["type"],"type":"object","properties":{"set":{"title":"pause_collection_params","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}}},"description":"Details of the pause_collection behavior to apply to the amendment.","x-stripeMostCommon":["behavior"]},"type":{"type":"string","description":"Determines the type of the pause_collection amendment.","enum":["remove","set"]}},"description":"Defines how to pause collection for the underlying subscription throughout the duration of the amendment.","x-stripeMostCommon":["set","type"]},"set_schedule_end":{"type":"string","description":"Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.","enum":["amendment_end","amendment_start"]},"trial_settings":{"title":"trial_settings_specs","type":"object","properties":{"end_behavior":{"title":"end_behavior_specs","type":"object","properties":{"prorate_up_front":{"type":"string","description":"Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.","enum":["defer","include"]}},"description":"Defines how the subscription should behave when a trial ends.","x-stripeMostCommon":["prorate_up_front"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"x-stripeMostCommon":["amendment_end","amendment_start","billing_cycle_anchor","billing_schedules_actions","discount_actions","effective_at","item_actions","metadata_actions","proration_behavior","set_pause_collection","set_schedule_end","trial_settings"]}},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"prebilling":{"description":"Provide any time periods to bill in advance.","anyOf":[{"type":"array","items":{"title":"specs","type":"object","properties":{"bill_from":{"title":"specs","required":["type"],"type":"object","properties":{"amendment_start":{"title":"amendment_start_specs","required":["index"],"type":"object","properties":{"index":{"type":"integer","description":"The position of the amendment in the `amendments` array with which prebilling should begin. Indexes start from 0 and must be less than the total number of supplied amendments."}},"description":"Start the prebilled period when a specified amendment begins.","x-stripeMostCommon":["index"]},"timestamp":{"type":"integer","description":"Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.","format":"unix-time"},"type":{"type":"string","description":"Select one of several ways to pass the `bill_from` value.","enum":["amendment_start","now","timestamp"]}},"description":"The beginning of the prebilled time period. The default value is `now`.","x-stripeMostCommon":["amendment_start","timestamp","type"]},"bill_until":{"title":"specs","required":["type"],"type":"object","properties":{"amendment_end":{"title":"amendment_end_specs","required":["index"],"type":"object","properties":{"index":{"type":"integer","description":"The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments."}},"description":"End the prebilled period when a specified amendment ends.","x-stripeMostCommon":["index"]},"duration":{"title":"duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for prebilling, starting from `bill_from`.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"End the prebilled period at a precise integer timestamp, starting from the Unix epoch.","format":"unix-time"},"type":{"type":"string","description":"Select one of several ways to pass the `bill_until` value.","enum":["amendment_end","duration","schedule_end","timestamp"]}},"description":"The end of the prebilled time period.","x-stripeMostCommon":["amendment_end","duration","timestamp","type"]},"invoice_at":{"type":"string","description":"When the prebilling invoice should be created. The default value is `now`.","enum":["now"]},"update_behavior":{"type":"string","description":"Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.","enum":["prebill","reset"]}},"x-stripeMostCommon":["bill_from","bill_until","invoice_at","update_behavior"]}},{"type":"string","enum":[""]}]},"proration_behavior":{"type":"string","description":"In cases where the amendment changes the currently active phase,\n specifies if and how to prorate at the time of the request.","enum":["always_invoice","create_prorations","none"]},"schedule_settings":{"title":"specs","type":"object","properties":{"end_behavior":{"type":"string","description":"Behavior of the subscription schedule and underlying subscription when it ends.","enum":["cancel","release"]}},"description":"Changes to apply to the subscription schedule.","x-stripeMostCommon":["end_behavior"]}},"additionalProperties":false,"x-stripeMostCommon":["amendments","proration_behavior","schedule_settings"]},"encoding":{"amendments":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"prebilling":{"style":"deepObject","explode":true},"schedule_settings":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_schedule"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"amend_billing_subscription_schedule"}},"/v1/subscription_schedules/{schedule}/cancel":{"post":{"summary":"Cancel a schedule","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.
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.
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
\n\nWhen you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.\nThe 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.\nSchedules provide the flexibility to model more complex billing configurations that change over time.
Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.
","operationId":"GetSubscriptionsSearch","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"page","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"query","in":"query","description":"The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions).","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"SearchResult","required":["data","has_more","next_page","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/subscription"}},"has_more":{"type":"boolean"},"next_page":{"maxLength":5000,"type":"string","nullable":true},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value.","enum":["search_result"]},"total_count":{"type":"integer","description":"The total number of objects that match the query, only accurate up to 10,000."},"url":{"maxLength":5000,"type":"string"}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","next_page","object","total_count","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"search_billing_subscription"}},"/v1/subscriptions/{subscription_exposed_id}":{"get":{"summary":"Retrieve a subscription","description":"Retrieves the subscription with the given ID.
","operationId":"GetSubscriptionsSubscriptionExposedId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"subscription_exposed_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_billing_subscription"},"post":{"summary":"Update a subscription","description":"Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the create preview endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Switching prices does not normally change the billing date or generate an immediate charge unless:
\n\nIn 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. Learn about how Stripe immediately attempts payment for subscription changes.
\n\nIf 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 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":[{"name":"subscription_exposed_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"add_invoice_items":{"type":"array","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":{"title":"add_invoice_item_entry","type":"object","properties":{"discountable":{"type":"boolean","description":"Controls whether discounts apply to this invoice item. Defaults to true if no value is provided."},"discounts":{"type":"array","description":"The coupons to redeem into discounts for the item.","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"title":"invoice_item_period","required":["end","start"],"type":"object","properties":{"end":{"title":"invoice_item_period_end","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the end of the invoice item period.","enum":["min_item_period_end","timestamp"],"x-stripeBypassValidation":true}},"description":"End of the invoice item period.","x-stripeMostCommon":["timestamp","type"]},"start":{"title":"invoice_item_period_start","required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","description":"A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.","format":"unix-time"},"type":{"type":"string","description":"Select how to calculate the start of the invoice item period.","enum":["max_item_period_start","now","timestamp"],"x-stripeBypassValidation":true}},"description":"Start of the invoice item period.","x-stripeMostCommon":["timestamp","type"]}},"description":"The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.","x-stripeMostCommon":["end","start"]},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. One of `price` or `price_data` is required."},"price_data":{"title":"one_time_price_data_with_negative_amounts","required":["currency","product"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.","x-stripeMostCommon":["currency","product","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for this item. Defaults to 1."},"tax_rates":{"description":"The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["price","quantity"],"x-stripeParam":{"class_name":"AddInvoiceItem"}}},"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. 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).","anyOf":[{"type":"number"},{"type":"string","enum":[""]}]},"automatic_tax":{"title":"automatic_tax_config","required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription."},"liability":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"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.","x-stripeMostCommon":["account","type"]}},"description":"Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.","x-stripeMostCommon":["enabled","liability"]},"billing_cycle_anchor":{"title":"billing_cycle_anchor_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Determines how the billing cycle anchor changes when the subscription is updated.","enum":["now","unchanged"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Reset the subscription's billing cycle anchor to the current time (in UTC) and start a new billing period.","value":"now"},{"description":"Keep the subscription's existing billing cycle anchor unchanged.","value":"unchanged"}]}}},"description":"Controls how the subscription's billing cycle anchor changes. Set `type` to `now` to reset the billing cycle anchor to the current time (in UTC), or `unchanged` to preserve it. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).","x-stripeMostCommon":["timestamp","type"]},"billing_schedules":{"description":"An array of billing schedules, which allow you to bill customers in advance for multiple service periods. Requires flexible billing mode and API version 2026-05-27.dahlia or later. Learn more about [prebilling](https://docs.stripe.com/billing/subscriptions/prebilling).","anyOf":[{"type":"array","items":{"title":"billing_schedules_update_params","type":"object","properties":{"applies_to":{"type":"array","description":"Configure billing schedule differently for individual subscription items.","items":{"title":"billing_schedules_applies_to","required":["type"],"type":"object","properties":{"price":{"maxLength":5000,"type":"string","description":"The ID of the price object."},"type":{"type":"string","description":"Controls which subscription items the billing schedule applies to.","enum":["price"]}},"x-stripeMostCommon":["price","type"]}},"bill_until":{"title":"billing_schedules_bill_until","required":["type"],"type":"object","properties":{"duration":{"title":"billing_schedules_bill_until_duration","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing duration. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The multiplier applied to the interval."}},"description":"Specifies the billing period.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"The end date of the billing schedule.","format":"unix-time"},"type":{"type":"string","description":"Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.","enum":["duration","timestamp"]}},"description":"The end date for the billing schedule. You must not set this earlier than current period end for every applicable subscription item.","x-stripeMostCommon":["duration","timestamp","type"]},"key":{"maxLength":200,"type":"string","description":"Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated."}},"x-stripeMostCommon":["applies_to","bill_until","key"]}},{"type":"string","enum":[""]}]},"billing_thresholds":{"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.","anyOf":[{"title":"billing_thresholds_param","type":"object","properties":{"amount_gte":{"type":"integer","description":"Monetary threshold that triggers the subscription to advance to a new billing period"},"reset_billing_cycle_anchor":{"type":"boolean","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."}},"x-stripeMostCommon":["amount_gte","reset_billing_cycle_anchor"]},{"type":"string","enum":[""]}]},"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.","anyOf":[{"type":"integer","format":"unix-time"},{"type":"string","enum":[""]},{"type":"string","enum":["max_billed_until","max_period_end","min_period_end"]}]},"cancel_at_period_end":{"type":"boolean","description":"Indicate whether this subscription should cancel at the end of the current period (`current_period_end`)."},"cancellation_details":{"title":"cancellation_details_param","type":"object","properties":{"comment":{"description":"Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"feedback":{"type":"string","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"]},"feedback_option":{"maxLength":5000,"type":"string","description":"Customized feedback options that provide deeper insight into why the subscription was canceled, if the subscription was canceled explicitly by the user."}},"description":"Details about why this subscription was cancelled","x-stripeMostCommon":["comment","feedback","feedback_option"]},"collection_method":{"type":"string","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"]},"days_until_due":{"type":"integer","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`."},"default_payment_method":{"maxLength":5000,"type":"string","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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source)."},"default_source":{"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://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"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. Pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"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.","anyOf":[{"maxLength":500,"type":"string"},{"type":"string","enum":[""]}]},"discounts":{"description":"The coupons to redeem into discounts for the subscription. A populated array overwrites the existing discounts on the subscription. If not specified or empty array, it leaves the subscription's discounts unchanged. If empty string, it clears the subscription's discounts.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_settings":{"title":"invoice_settings_update_param","type":"object","properties":{"account_tax_ids":{"description":"The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]},"custom_fields":{"description":"A list of up to 4 custom fields to be displayed on the invoice.","anyOf":[{"type":"array","items":{"title":"custom_field_params","required":["name","value"],"type":"object","properties":{"name":{"maxLength":40,"type":"string","description":"The name of the custom field. This may be up to 40 characters."},"value":{"maxLength":140,"type":"string","description":"The value of the custom field. This may be up to 140 characters."}},"x-stripeMostCommon":["name","value"]}},{"type":"string","enum":[""]}]},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","anyOf":[{"maxLength":1500,"type":"string"},{"type":"string","enum":[""]}]},"footer":{"description":"Footer to be displayed on the invoice.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"issuer":{"title":"param","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"The connected account being referenced when `type` is `account`."},"type":{"type":"string","description":"Type of the account referenced in the request.","enum":["account","self"],"x-stripeBypassValidation":true}},"description":"The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.","x-stripeMostCommon":["account","type"]}},"description":"All invoices will be billed using the specified settings.","x-stripeMostCommon":["account_tax_ids","custom_fields","description","footer","issuer","rendering","send_hosted_payment_email","supported_payment_methods"]},"items":{"type":"array","description":"A list of up to 20 subscription items, each with an attached price.","items":{"title":"subscription_item_update_params","type":"object","properties":{"billing_thresholds":{"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.","anyOf":[{"title":"item_billing_thresholds_param","required":["usage_gte"],"type":"object","properties":{"usage_gte":{"type":"integer","description":"Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))"}},"x-stripeMostCommon":["usage_gte"]},{"type":"string","enum":[""]}]},"clear_usage":{"type":"boolean","description":"Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached."},"current_trial":{"title":"current_trial_param","required":["trial_offer"],"type":"object","properties":{"trial_end":{"type":"integer","description":"Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.","format":"unix-time"},"trial_offer":{"maxLength":5000,"type":"string","description":"The ID of the trial offer to apply to the subscription item."}},"description":"The trial offer to apply to this subscription item.","x-stripeMostCommon":["trial_end","trial_offer"]},"deleted":{"type":"boolean","description":"A flag that, if set to `true`, will delete the specified item."},"discounts":{"description":"The coupons to redeem into discounts for the subscription item.","anyOf":[{"type":"array","items":{"title":"discounts_data_param","type":"object","properties":{"coupon":{"maxLength":5000,"type":"string","description":"ID of the coupon to create a new discount for."},"discount":{"maxLength":5000,"type":"string","description":"ID of an existing discount on the object (or one of its ancestors) to reuse."},"discount_end":{"title":"discount_end","required":["type"],"type":"object","properties":{"duration":{"title":"discount_end_duration_specs","required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","description":"The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration."}},"description":"Time span for the redeemed discount.","x-stripeMostCommon":["interval","interval_count"]},"timestamp":{"type":"integer","description":"A precise Unix timestamp for the discount to end. Must be in the future.","format":"unix-time"},"type":{"type":"string","description":"The type of calculation made to determine when the discount ends.","enum":["duration","timestamp"]}},"description":"Details to determine how long the discount should be applied for.","x-stripeMostCommon":["duration","timestamp","type"]},"promotion_code":{"maxLength":5000,"type":"string","description":"ID of the promotion code to create a new discount for."}},"x-stripeMostCommon":["coupon","settings"]}},{"type":"string","enum":[""]}]},"id":{"maxLength":5000,"type":"string","description":"Subscription item to update. If you omit `id`, the API adds a new subscription item rather than updating the existing one. See [Changing a subscription's price](https://docs.stripe.com/billing/subscriptions/change-price#changing)."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"plan":{"maxLength":5000,"type":"string","description":"Plan ID for this item, as a string."},"price":{"maxLength":5000,"type":"string","description":"The ID of the price object. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided."},"price_data":{"title":"recurring_price_data","required":["currency","product","recurring"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"product":{"maxLength":5000,"type":"string","description":"The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to."},"recurring":{"title":"recurring_adhoc","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies billing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"description":"The recurring components of a price such as `interval` and `interval_count`.","x-stripeMostCommon":["interval"]},"tax_behavior":{"type":"string","description":"Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.","enum":["exclusive","inclusive","unspecified"]},"unit_amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge."},"unit_amount_decimal":{"type":"string","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"}},"description":"Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both.","x-stripeMostCommon":["currency","product","recurring","unit_amount"]},"quantity":{"type":"integer","description":"Quantity for this item."},"tax_rates":{"description":"A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.","anyOf":[{"type":"array","items":{"maxLength":5000,"type":"string"}},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["billing_thresholds","clear_usage","current_trial","deleted","discounts","id","metadata","plan","price","quantity","tax_rates"]}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"off_session":{"type":"boolean","description":"Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session)."},"on_behalf_of":{"description":"The account on behalf of which to charge, for each of the subscription's invoices.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"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](https://docs.stripe.com/billing/subscriptions/pause-payment).","anyOf":[{"title":"pause_collection_param","required":["behavior"],"type":"object","properties":{"behavior":{"type":"string","description":"The payment collection behavior for this subscription while paused.","enum":["keep_as_draft","mark_uncollectible","void"],"x-stripeEnum":{"kind":"open","values":[{"description":"Keep all invoices as `draft` while collection is paused.","value":"keep_as_draft"},{"description":"Mark all invoices as `uncollectible` while collection is paused.","value":"mark_uncollectible"},{"description":"Void all invoices while collection is paused.","value":"void"}]}},"resumes_at":{"type":"integer","description":"The time after which the subscription will resume collecting payments.","format":"unix-time"}},"x-stripeMostCommon":["behavior","resumes_at"]},{"type":"string","enum":[""]}]},"payment_behavior":{"type":"string","description":"Controls how Stripe handles payment when a subscription update requires payment and `collection_method=charge_automatically`.","enum":["allow_incomplete","default_incomplete","error_if_incomplete","pending_if_incomplete"],"x-stripeEnum":{"kind":"open","values":[{"description":"This is the default behavior since [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails). Transition the subscription to `status=past_due` if payment fails. If you have payment retries configured, Stripe automatically retries the payment. If the payment requires action, you receive an `invoice.payment_action_required` webhook and must manage additional user actions. For example, SCA regulations might require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more.","value":"allow_incomplete"},{"description":"When payment is required, transition the subscription to `status=past_due` without attempting payment. You must request explicit confirmation of the Invoice's PaymentIntent. The resulting Invoice has [auto_advance=false](https://docs.stripe.com/api/invoices/object#invoice_object-auto_advance), so Stripe doesn't automatically attempt payment, retry payment, or finalize the subscription.","value":"default_incomplete"},{"description":"If payment fails, return an HTTP `402` status code and don't update the subscription. This behavior doesn't support payments that require user action, such as 3DS authentication, because it returns an error instead of creating a PaymentIntent with `status=requires_action`. To handle payments that require action, use `allow_incomplete` or `default_incomplete` instead. This behavior was the default for API versions before [2019-03-14](changelog/2019-03-14/subscriptions-successfully-created-first-payment-fails).","value":"error_if_incomplete"},{"description":"If payment fails, Stripe creates a [pending update](https://docs.stripe.com/billing/subscriptions/pending-updates), which applies only if the payment eventually succeeds. This behavior doesn't support all [attributes and payment methods](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). This option is the simplest way to ensure the customer completes payment before Stripe applies the update.","value":"pending_if_incomplete"}]}},"payment_settings":{"title":"payment_settings","type":"object","properties":{"payment_method_options":{"title":"payment_method_options","type":"object","properties":{"acss_debit":{"description":"This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"]}},"description":"Additional fields for Mandate creation","x-stripeMostCommon":["transaction_type"]},"verification_method":{"type":"string","description":"Verification method for the intent","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["mandate_options","verification_method"]},{"type":"string","enum":[""]}]},"bancontact":{"description":"This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"preferred_language":{"type":"string","description":"Preferred language of the Bancontact authorization page that the customer is redirected to.","enum":["de","en","fr","nl"]}},"x-stripeMostCommon":["preferred_language"]},{"type":"string","enum":[""]}]},"billie":{"description":"This sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"subscription_payment_method_options_param","type":"object","properties":{"company_details":{"description":"Registration details about the buyer's organization.","anyOf":[{"title":"company_details_param","type":"object","properties":{"registered_address":{"description":"The address the company or entity is registered with.","anyOf":[{"title":"registered_address_param","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1 (for example, street, PO Box, or company name)."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2 (for example, apartment, suite, unit, or building)."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"registered_name":{"maxLength":5000,"type":"string","description":"Company or entity name."},"registration_number":{"maxLength":5000,"type":"string","description":"The official registration number for the given registration type."},"registration_type":{"type":"string","description":"Type of registration the company or entity holds in their registered country.","enum":["","ch_ein","de_hrb","dk_cvr","es_cif","fi_tunnus","fr_siren","fr_siret","it_rea","nl_kvk","no_org_number","no_pno","se_org_number","se_pno","uk_crn"]},"vat":{"maxLength":5000,"type":"string","description":"VAT ID number."}},"x-stripeMostCommon":["registered_address","registered_name","registration_number","registration_type","vat"]},{"type":"string","enum":[""]}]}},"x-stripeMostCommon":["company_details","extra_merchant_data_blob"]},{"type":"string","enum":[""]}]},"blik":{"description":"This sub-hash contains details about the Blik payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"subscription_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"subscription_payment_method_options_mandate_options_param","type":"object","properties":{"expires_at":{"type":"integer","description":"Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.","format":"unix-time"}},"description":"Configuration options for setting up a mandate","x-stripeMostCommon":["expires_at"]}},"x-stripeMostCommon":["mandate_options"]},{"type":"string","enum":[""]}]},"card":{"description":"This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"subscription_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments, specified in the presentment currency."},"amount_type":{"type":"string","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"]},"description":{"maxLength":200,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."}},"description":"Configuration options for setting up an eMandate for cards issued in India.","x-stripeMostCommon":["amount","amount_type","description"]},"network":{"maxLength":5000,"type":"string","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","girocard","interac","jcb","link","mastercard","unionpay","unknown","visa"],"x-stripeBypassValidation":true},"request_three_d_secure":{"type":"string","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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"]}},"x-stripeMostCommon":["mandate_options","mcc","mit_exemption","network","network_options","request_three_d_secure"]},{"type":"string","enum":[""]}]},"customer_balance":{"description":"This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"bank_transfer":{"title":"bank_transfer_param","type":"object","properties":{"eu_bank_transfer":{"title":"eu_bank_transfer_param","required":["country"],"type":"object","properties":{"country":{"maxLength":5000,"type":"string","description":"The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."}},"description":"Configuration for eu_bank_transfer funding type.","x-stripeMostCommon":["country"]},"type":{"type":"string","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`."}},"description":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.","x-stripeMostCommon":["eu_bank_transfer","id_bank_transfer","type"]},"funding_type":{"type":"string","description":"The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."}},"x-stripeMostCommon":["bank_transfer","funding_type"]},{"type":"string","enum":[""]}]},"id_bank_transfer":{"description":"This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{}},{"type":"string","enum":[""]}]},"konbini":{"description":"This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{}},{"type":"string","enum":[""]}]},"payto":{"description":"This sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit."},"purpose":{"type":"string","description":"The purpose for which payments are made. Has a default value based on your merchant category code.","enum":["dependant_support","government","loan","mortgage","other","pension","personal","retail","salary","tax","utility"]}},"description":"Additional fields for Mandate creation.","x-stripeMostCommon":["amount","purpose"]}},"x-stripeMostCommon":["mandate_options"]},{"type":"string","enum":[""]}]},"pix":{"description":"This sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"subscription_payment_method_options_param","type":"object","properties":{"expires_after_seconds":{"type":"integer","description":"The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds."},"mandate_options":{"title":"subscription_payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments. If not provided, defaults to 40000."},"amount_includes_iof":{"type":"string","description":"Determines if the amount includes the IOF tax. Defaults to `never`.","enum":["always","never"]},"end_date":{"maxLength":5000,"type":"string","description":"Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled."},"payment_schedule":{"type":"string","description":"Schedule at which the future payments will be charged. Defaults to the subscription servicing interval.","enum":["halfyearly","monthly","quarterly","weekly","yearly"]}},"description":"Configuration options for setting up a mandate","x-stripeMostCommon":["amount","amount_includes_iof","end_date","payment_schedule"]}},"x-stripeMostCommon":["expires_after_seconds","mandate_options"]},{"type":"string","enum":[""]}]},"sepa_debit":{"description":"This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{},"x-stripeMostCommon":["verification_method"]},{"type":"string","enum":[""]}]},"upi":{"description":"This sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"mandate_options":{"title":"invoice_payment_method_options_mandate_options_param","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]}},"x-stripeMostCommon":["mandate_options"]},{"type":"string","enum":[""]}]},"us_bank_account":{"description":"This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.","anyOf":[{"title":"invoice_payment_method_options_param","type":"object","properties":{"financial_connections":{"title":"invoice_linked_account_options_param","type":"object","properties":{"filters":{"title":"invoice_linked_account_options_filters_param","type":"object","properties":{"account_subcategories":{"type":"array","description":"The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.","items":{"type":"string","enum":["checking","savings"]}},"institution":{"maxLength":5000,"type":"string","description":"ID of the institution to use to filter for selectable accounts."}},"description":"Provide filters for the linked accounts that the customer can select for the payment method.","x-stripeMostCommon":["account_subcategories","institution"]},"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.","items":{"maxLength":5000,"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeBypassValidation":true}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","inferred_balances","ownership","transactions"],"x-stripeBypassValidation":true}}},"description":"Additional fields for Financial Connections Session creation","x-stripeMostCommon":["filters","permissions","prefetch"]},"verification_method":{"type":"string","description":"Verification method for the intent","enum":["automatic","instant","microdeposits"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["financial_connections","verification_method"]},{"type":"string","enum":[""]}]}},"description":"Payment-method-specific configuration to provide to invoices created by the subscription.","x-stripeMostCommon":["acss_debit","bacs_debit","bancontact","billie","bizum","blik","card","check_scan","customer_balance","id_bank_transfer","konbini","payto","pix","sepa_debit","upi","us_bank_account","wechat_pay"]},"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). Should not be specified with payment_method_configuration","anyOf":[{"type":"array","items":{"type":"string","enum":["ach_credit_transfer","ach_debit","acss_debit","affirm","alipay","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","blik","boleto","card","cashapp","crypto","custom","customer_balance","eps","fpx","giropay","grabpay","id_bank_transfer","ideal","jp_credit_transfer","kakao_pay","klarna","konbini","kr_card","link","mb_way","multibanco","naver_pay","nz_bank_account","p24","pay_by_bank","payco","paynow","paypal","payto","pix","promptpay","revolut_pay","satispay","sepa_credit_transfer","sepa_debit","sofort","stripe_balance","swish","twint","upi","us_bank_account","wechat_pay"],"x-stripeBypassValidation":true}},{"type":"string","enum":[""]}]},"save_default_payment_method":{"type":"string","description":"Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.","enum":["off","on_subscription"]}},"description":"Payment settings to pass to invoices created by the subscription.","x-stripeMostCommon":["payment_method_configuration","payment_method_options","payment_method_types","save_default_payment_method"]},"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](/api/invoices/create) for the given subscription at the specified interval.","anyOf":[{"title":"pending_invoice_item_interval_params","required":["interval"],"type":"object","properties":{"interval":{"type":"string","description":"Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.","enum":["day","month","week","year"]},"interval_count":{"type":"integer","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)."}},"x-stripeMostCommon":["interval","interval_count"]},{"type":"string","enum":[""]}]},"prebilling":{"title":"prebilling_specs","required":["iterations"],"type":"object","properties":{"iterations":{"type":"integer","description":"This is used to determine the number of billing cycles to prebill."},"update_behavior":{"type":"string","description":"Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.","enum":["prebill","reset"]}},"description":"If specified, the invoicing for the given billing cycle iterations will be processed now.","x-stripeMostCommon":["iterations","update_behavior"]},"proration_behavior":{"type":"string","description":"Determines how to handle [prorations](https://docs.stripe.com/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"]},"proration_date":{"type":"integer","description":"If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` 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"},"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. This will be unset if you POST an empty value.","anyOf":[{"title":"transfer_data_specs","required":["destination"],"type":"object","properties":{"amount_percent":{"type":"number","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."},"destination":{"type":"string","description":"ID of an existing, connected Stripe account."}},"x-stripeMostCommon":["amount_percent","destination"]},{"type":"string","enum":[""]}]},"trial_end":{"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 `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.","anyOf":[{"maxLength":5000,"type":"string","enum":["now"]},{"type":"integer","format":"unix-time"}]},"trial_from_plan":{"type":"boolean","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://docs.stripe.com/billing/subscriptions/trials/free-trials) to learn more."},"trial_settings":{"title":"trial_settings_config","required":["end_behavior"],"type":"object","properties":{"end_behavior":{"title":"end_behavior","type":"object","properties":{"billing_cycle_anchor":{"type":"string","description":"Indicates how the subscription's billing cycle anchor is reset when a trial ends. Defaults to `now`.","enum":["now","unchanged"],"x-stripeEnum":{"kind":"open","values":[{"description":"Reset the subscription's billing cycle anchor to the end of the trial.","value":"now"},{"description":"Keep the subscription's existing billing cycle anchor unchanged. This value is unsupported for trials initiated through `trial_end`, `trial_period_days`, or a plan trial.","value":"unchanged"}]}},"missing_payment_method":{"type":"string","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"]}},"description":"Defines how the subscription should behave when the user's free trial ends.","x-stripeMostCommon":["billing_cycle_anchor","missing_payment_method"]}},"description":"Settings related to subscription trials.","x-stripeMostCommon":["end_behavior"]}},"additionalProperties":false,"x-stripeMostCommon":["automatic_tax","default_payment_method","description","items","metadata","payment_behavior","proration_behavior"]},"encoding":{"add_invoice_items":{"style":"deepObject","explode":true},"application_fee_percent":{"style":"deepObject","explode":true},"automatic_tax":{"style":"deepObject","explode":true},"billing_cycle_anchor":{"style":"deepObject","explode":true},"billing_schedules":{"style":"deepObject","explode":true},"billing_thresholds":{"style":"deepObject","explode":true},"cancel_at":{"style":"deepObject","explode":true},"cancellation_details":{"style":"deepObject","explode":true},"default_source":{"style":"deepObject","explode":true},"default_tax_rates":{"style":"deepObject","explode":true},"description":{"style":"deepObject","explode":true},"discounts":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"invoice_settings":{"style":"deepObject","explode":true},"items":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"on_behalf_of":{"style":"deepObject","explode":true},"pause_collection":{"style":"deepObject","explode":true},"payment_settings":{"style":"deepObject","explode":true},"pending_invoice_item_interval":{"style":"deepObject","explode":true},"prebilling":{"style":"deepObject","explode":true},"transfer_data":{"style":"deepObject","explode":true},"trial_end":{"style":"deepObject","explode":true},"trial_settings":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_billing_subscription"},"delete":{"summary":"Cancel a subscription","description":"Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, the subscription is largely immutable. You can still update its metadata and cancellation_details.
Any pending invoice items that you’ve created are still charged 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 are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to false.
By default, upon subscription cancellation, Stripe stops 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":[{"name":"subscription_exposed_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"cancellation_details":{"title":"cancellation_details_param","type":"object","properties":{"comment":{"description":"Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"feedback":{"type":"string","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"]},"feedback_option":{"maxLength":5000,"type":"string","description":"Customized feedback options that provide deeper insight into why the subscription was canceled, if the subscription was canceled explicitly by the user."}},"description":"Details about why this subscription was cancelled","x-stripeMostCommon":["comment","feedback","feedback_option"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoice_now":{"type":"boolean","description":"Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`."},"prorate":{"type":"boolean","description":"Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`."}},"additionalProperties":false},"encoding":{"cancellation_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_billing_subscription"}},"/v1/subscriptions/{subscription_exposed_id}/discount":{"delete":{"summary":"Delete a subscription discount","description":"Removes the currently applied discount on a subscription.
","operationId":"DeleteSubscriptionsSubscriptionExposedIdDiscount","parameters":[{"name":"subscription_exposed_id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_discount"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_subscription_discount"}},"/v1/subscriptions/{subscription}/migrate":{"post":{"summary":"Migrate a subscription","description":"Upgrade the billing_mode of an existing subscription.
","operationId":"PostSubscriptionsSubscriptionMigrate","parameters":[{"name":"subscription","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["billing_mode"],"type":"object","properties":{"billing_mode":{"title":"billing_mode_migrate","required":["type"],"type":"object","properties":{"flexible":{"title":"flexible_params","type":"object","properties":{"proration_discounts":{"type":"string","description":"Controls how invoices and invoice items display proration amounts and discount amounts.","enum":["included","itemized"],"x-stripeEnum":{"kind":"open","values":[{"description":"Amounts are net of discounts, and discount amounts are zero.","value":"included"},{"description":"Amounts are gross of discounts, and discount amounts are accurate.","value":"itemized"}]}}},"description":"Configure behavior for flexible billing mode.","x-stripeMostCommon":["proration_discounts"]},"type":{"type":"string","description":"Controls the calculation and orchestration of prorations and invoices for subscriptions.","enum":["flexible"]}},"description":"Controls how prorations and invoices for subscriptions are calculated and orchestrated.","x-stripeMostCommon":["flexible","type"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["billing_mode"]},"encoding":{"billing_mode":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"migrate_subscription"}},"/v1/subscriptions/{subscription}/pause":{"post":{"summary":"Pause a subscription","description":"Pauses a subscription by transitioning it to the paused status. A paused subscription does not generate invoices and will not advance to new billing periods. The subscription can be resumed later using the resume endpoint. Cannot pause subscriptions with attached schedules.
","operationId":"PostSubscriptionsSubscriptionPause","parameters":[{"name":"subscription","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"bill_for":{"title":"bill_for_param","type":"object","properties":{"outstanding_usage_through":{"title":"outstanding_usage_through_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"When to bill metered usage in the current period.","enum":["none","now"],"x-stripeEnum":{"kind":"open","values":[{"description":"Don't bill for metered usage in the current period.","value":"none"},{"description":"Bill for metered usage in the current period, from current period start to pause time (default).","value":"now"}]}}},"description":"Controls when to bill for metered usage in the current period. Defaults to `{ type: \"now\" }`.","x-stripeMostCommon":["type"]},"unused_time_from":{"title":"unused_time_from_param","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"When to credit for unused time.","enum":["item_current_period_start","none","now"],"x-stripeEnum":{"kind":"open","values":[{"description":"Credit unused time from each item's current period start to period end.","value":"item_current_period_start"},{"description":"Don't credit for unused time.","value":"none"},{"description":"Credit unused time from pause time to period end (default).","value":"now"}]}}},"description":"Controls when to credit for unused time on licensed items. Defaults to `{ type: \"now\" }`.","x-stripeMostCommon":["type"]}},"description":"Controls what to bill for when pausing the subscription.","x-stripeMostCommon":["outstanding_usage_through","unused_time_from"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"invoicing_behavior":{"type":"string","description":"Determines how to handle debits and credits when pausing. Defaults to `pending_invoice_item`.","enum":["invoice","pending_invoice_item"],"x-stripeEnum":{"kind":"open","values":[{"description":"Invoices immediately for debits and credits in the current period. If pausing doesn't create any invoice items, Stripe doesn't generate an invoice.","value":"invoice"},{"description":"Creates pending invoice items for debits and credits in the current period.","value":"pending_invoice_item"}]}},"type":{"type":"string","description":"The type of pause to apply. Defaults to `subscription`.","enum":["subscription"],"x-stripeEnum":{"kind":"open","values":[{"description":"Pauses collection, billing, and servicing.","value":"subscription"}]}}},"additionalProperties":false,"x-stripeMostCommon":["bill_for","invoicing_behavior","type"]},"encoding":{"bill_for":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"pause_billing_subscription"}},"/v1/subscriptions/{subscription}/resume":{"post":{"summary":"Resume a subscription","description":"Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn’t generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes active. If the invoice is manually voided, the subscription stays paused. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays paused. Learn more about resuming subscriptions.
Finds a tax association object by PaymentIntent id.
","operationId":"GetTaxAssociationsFind","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"payment_intent","in":"query","description":"Valid [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) id","required":true,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax.association"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"find_tax_association"}},"/v1/tax/calculations":{"post":{"summary":"Create a Calculation","description":"Calculates tax based on the input and returns a Tax Calculation object.
Retrieves a Tax Calculation object, if the calculation hasn’t expired.
Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.
","operationId":"GetTaxCalculationsCalculationLineItems","parameters":[{"name":"calculation","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":500,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":500,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxProductResourceTaxCalculationLineItemList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/tax.calculation_line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/tax/calculations/[^/]+/line_items","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_tax_calculation_line_items"}},"/v1/tax/forms":{"get":{"summary":"List all tax forms","description":"Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
","operationId":"GetTaxForms","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"payee","in":"query","description":"The payee whose volume is represented on the tax form.","required":true,"style":"deepObject","explode":true,"schema":{"title":"payee_params","type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"The ID of the Stripe account whose forms will be retrieved."},"external_reference":{"maxLength":5000,"type":"string","description":"The external reference to the payee whose forms will be retrieved."},"type":{"type":"string","description":"Specifies the payee type.","enum":["account","external_reference"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["account","external_reference","type"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"type","in":"query","description":"An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["au_serr","ca_mrdp","eu_dac7","gb_mrdp","nz_mrdp","us_1099_k","us_1099_misc","us_1099_nec"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxReportingResourceTaxFormList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/tax.form"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_tax_forms"}},"/v1/tax/forms/{id}":{"get":{"summary":"Retrieve a tax form","description":"Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
","operationId":"GetTaxFormsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax.form"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_tax_form"}},"/v1/tax/forms/{id}/pdf":{"get":{"summary":"Download tax form PDF","description":"Download the PDF for a tax form.
","operationId":"GetTaxFormsIdPdf","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"servers":[{"url":"https://files.stripe.com/"}],"x-stableId":"download_pdf_tax_form"}},"/v1/tax/locations":{"get":{"summary":"List tax locations","description":"Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.
\n\nThe response includes detailed information for each tax location, such as its address, type, and description.
\n\nYou can paginate through the list by using the limit parameter to control the number of results returned in each request.
Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the ID, address, type, and description of the tax location.
","operationId":"PostTaxLocations","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["address","type"],"type":"object","properties":{"address":{"title":"tax_location_address","required":["country"],"type":"object","properties":{"city":{"description":"City, district, suburb, town, or village.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"description":"Address line 1, such as the street, PO Box, or company name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"line2":{"description":"Address line 2, such as the apartment, suite, unit, or building.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"postal_code":{"description":"ZIP or postal code.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"state":{"description":"State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as \"NY\" or \"TX\".","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"The physical address of the tax location.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"description":{"maxLength":5000,"type":"string","description":"Details to identify the tax location by its venue, types of events held, or available services, such as \"A spacious auditorium suitable for large concerts and events.\"."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"The type of tax location. The only supported value is \"performance\".","enum":["performance"]}},"additionalProperties":false,"x-stripeMostCommon":["address","description","type"]},"encoding":{"address":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax.location"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_tax_location"}},"/v1/tax/locations/{location}":{"get":{"summary":"Retrieve a tax location","description":"Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the integration guide.
","operationId":"GetTaxLocationsLocation","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"location","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax.location"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_tax_location"}},"/v1/tax/registrations":{"get":{"summary":"List registrations","description":"Returns a list of Tax Registration objects.
Creates a new Tax Registration object.
Returns a Tax Registration object.
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.
Retrieves Tax Settings for a merchant.
Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set. Check the returned Tax Settings object and validate that its status is active.
Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.
","operationId":"PostTaxTransactionsCreateFromCalculation","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["calculation","reference"],"type":"object","properties":{"calculation":{"maxLength":5000,"type":"string","description":"Tax Calculation ID to be used as input when creating the transaction."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"posted_at":{"type":"integer","description":"The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.","format":"unix-time"},"reference":{"maxLength":500,"type":"string","description":"A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals."}},"additionalProperties":false,"x-stripeMostCommon":["calculation","metadata","reference"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax.transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_tax_transaction"}},"/v1/tax/transactions/create_reversal":{"post":{"summary":"Create a reversal Transaction","description":"Partially or fully reverses a previously created Transaction.
Retrieves a Tax Transaction object.
Retrieves the line items of a committed standalone transaction as a collection.
","operationId":"GetTaxTransactionsTransactionLineItems","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":500,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":500,"type":"string"}},{"name":"transaction","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxProductResourceTaxTransactionLineItemList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/tax.transaction_line_item"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/tax/transactions/[^/]+/line_items","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_tax_transaction_line_items"}},"/v1/tax_codes":{"get":{"summary":"List all tax codes","description":"A list of all tax codes available to add to Products in order to allow specific tax calculations.
","operationId":"GetTaxCodes","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxProductResourceTaxCodeList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/tax_code"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_tax_codes"}},"/v1/tax_codes/{id}":{"get":{"summary":"Retrieve a tax code","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax_code"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_tax_code"}},"/v1/tax_ids":{"get":{"summary":"List all tax IDs","description":"Returns a list of tax IDs.
","operationId":"GetTaxIds","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"owner","in":"query","description":"The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.","required":false,"style":"deepObject","explode":true,"schema":{"title":"owner_params","required":["type"],"type":"object","properties":{"account":{"type":"string","description":"Connected Account the tax ID belongs to. Required when `type=account`"},"customer":{"maxLength":5000,"type":"string","description":"Customer the tax ID belongs to. Required when `type=customer`"},"customer_account":{"maxLength":5000,"type":"string","description":"ID of the Account representing the customer that the tax ID belongs to. Can be used in place of `customer` when `type=customer`"},"type":{"type":"string","description":"Type of owner referenced.","enum":["account","application","customer","self"]}},"x-stripeMostCommon":["account","customer","customer_account","type"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxIDsList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/tax_id"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"unified_list_tax_ids"},"post":{"summary":"Create a tax ID","description":"Creates a new account or customer tax_id object.
Retrieves an account or customer tax_id object.
Deletes an existing account or customer tax_id object.
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":[{"name":"active","in":"query","description":"Optional flag to filter by tax rates that are either active or inactive (archived).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"created","in":"query","description":"Optional range for filtering created date.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"inclusive","in":"query","description":"Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TaxRatesList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/tax_rate"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/tax_rates","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_tax_rates"},"post":{"summary":"Create a tax rate","description":"Creates a new tax rate.
","operationId":"PostTaxRates","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["display_name","inclusive","percentage"],"type":"object","properties":{"active":{"type":"boolean","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."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."},"display_name":{"maxLength":50,"type":"string","description":"The display name of the tax rate, which will be shown to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"inclusive":{"type":"boolean","description":"This specifies if the tax rate is inclusive or exclusive."},"jurisdiction":{"maxLength":50,"type":"string","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."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"percentage":{"type":"number","description":"This represents the tax rate percent out of 100."},"state":{"maxLength":5000,"type":"string","description":"[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States."},"tax_type":{"type":"string","description":"The high-level tax type, such as `vat` or `sales_tax`.","enum":["amusement_tax","communications_tax","digital_excise_tax","gst","hst","igst","jct","lease_tax","mass_transit_parking_tax","parking_tax","pst","qst","retail_delivery_fee","rst","sales_tax","service_tax","utility_users_tax","vat"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Amusement Tax","value":"amusement_tax"},{"description":"Communications Tax","value":"communications_tax"},{"description":"Digital Excise Tax","value":"digital_excise_tax"},{"description":"Goods and Services Tax","value":"gst"},{"description":"Harmonized Sales Tax","value":"hst"},{"description":"Integrated Goods and Services Tax","value":"igst"},{"description":"Japanese Consumption Tax","value":"jct"},{"description":"Chicago Lease Tax","value":"lease_tax"},{"description":"Mass Transit Parking Tax","value":"mass_transit_parking_tax"},{"description":"Parking Tax","value":"parking_tax"},{"description":"Provincial Sales Tax","value":"pst"},{"description":"Quebec Sales Tax","value":"qst"},{"description":"Retail Delivery Fee","value":"retail_delivery_fee"},{"description":"Retail Sales Tax","value":"rst"},{"description":"Sales Tax","value":"sales_tax"},{"description":"Service Tax","value":"service_tax"},{"description":"Utility Users Tax","value":"utility_users_tax"},{"description":"Value-Added Tax","value":"vat"}]}}},"additionalProperties":false,"x-stripeMostCommon":["active","country","description","display_name","inclusive","jurisdiction","metadata","percentage","state"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_tax_rate"}},"/v1/tax_rates/{tax_rate}":{"get":{"summary":"Retrieve a tax rate","description":"Retrieves a tax rate with the given ID
","operationId":"GetTaxRatesTaxRate","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"tax_rate","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_tax_rate"},"post":{"summary":"Update a tax rate","description":"Updates an existing tax rate.
","operationId":"PostTaxRatesTaxRate","parameters":[{"name":"tax_rate","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"active":{"type":"boolean","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."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."},"display_name":{"maxLength":50,"type":"string","description":"The display name of the tax rate, which will be shown to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"jurisdiction":{"maxLength":50,"type":"string","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."},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"state":{"maxLength":5000,"type":"string","description":"[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States."},"tax_type":{"type":"string","description":"The high-level tax type, such as `vat` or `sales_tax`.","enum":["amusement_tax","communications_tax","digital_excise_tax","gst","hst","igst","jct","lease_tax","mass_transit_parking_tax","parking_tax","pst","qst","retail_delivery_fee","rst","sales_tax","service_tax","utility_users_tax","vat"],"x-stripeBypassValidation":true,"x-stripeEnum":{"kind":"open","values":[{"description":"Amusement Tax","value":"amusement_tax"},{"description":"Communications Tax","value":"communications_tax"},{"description":"Digital Excise Tax","value":"digital_excise_tax"},{"description":"Goods and Services Tax","value":"gst"},{"description":"Harmonized Sales Tax","value":"hst"},{"description":"Integrated Goods and Services Tax","value":"igst"},{"description":"Japanese Consumption Tax","value":"jct"},{"description":"Chicago Lease Tax","value":"lease_tax"},{"description":"Mass Transit Parking Tax","value":"mass_transit_parking_tax"},{"description":"Parking Tax","value":"parking_tax"},{"description":"Provincial Sales Tax","value":"pst"},{"description":"Quebec Sales Tax","value":"qst"},{"description":"Retail Delivery Fee","value":"retail_delivery_fee"},{"description":"Retail Sales Tax","value":"rst"},{"description":"Sales Tax","value":"sales_tax"},{"description":"Service Tax","value":"service_tax"},{"description":"Utility Users Tax","value":"utility_users_tax"},{"description":"Value-Added Tax","value":"vat"}]}}},"additionalProperties":false,"x-stripeMostCommon":["active","country","description","display_name","jurisdiction","metadata","state"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tax_rate"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_tax_rate"}},"/v1/terminal/configurations":{"get":{"summary":"List all Configurations","description":"Returns a list of Configuration objects.
Creates a new Configuration object.
Retrieves a Configuration object.
Updates a new Configuration object.
Deletes a Configuration object.
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":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"location":{"maxLength":5000,"type":"string","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://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens)."}},"additionalProperties":false,"x-stripeMostCommon":["location"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.connection_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_terminal_connection_token"}},"/v1/terminal/locations":{"get":{"summary":"List all Locations","description":"Returns a list of Location objects.
Creates a new Location object.\nFor further details, including which address fields are required in each country, see the Manage locations guide.
Retrieves a Location object.
Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Deletes a Location object.
Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
Retrieve data collected using Reader hardware.
","operationId":"GetTerminalReaderCollectedDataReaderCollectedData","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"reader_collected_data","in":"path","description":"The ID of the ReaderCollectedData to retrieve.","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader_collected_data"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_reader_collected_data"}},"/v1/terminal/readers":{"get":{"summary":"List all Readers","description":"Returns a list of Reader objects.
Creates a new Reader object.
Retrieves a Reader object.
Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Deletes a Reader object.
Cancels the current reader action. See Programmatic Cancellation for more details.
","operationId":"PostTerminalReadersReaderCancelAction","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/terminal.reader"},{"$ref":"#/components/schemas/deleted_terminal.reader"}]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_terminal_reader_action"}},"/v1/terminal/readers/{reader}/collect_inputs":{"post":{"summary":"Collect inputs using a Reader","description":"Initiates an input collection flow on a Reader to display input forms and collect information from your customers.
","operationId":"PostTerminalReadersReaderCollectInputs","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["inputs"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"inputs":{"type":"array","description":"List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.","items":{"title":"input_params","required":["custom_text","type"],"type":"object","properties":{"custom_text":{"title":"custom_text_params","required":["title"],"type":"object","properties":{"description":{"maxLength":500,"type":"string","description":"The description which will be displayed when collecting this input"},"skip_button":{"maxLength":14,"type":"string","description":"Custom text for the skip button. Maximum 14 characters."},"submit_button":{"maxLength":30,"type":"string","description":"Custom text for the submit button. Maximum 30 characters."},"title":{"maxLength":40,"type":"string","description":"The title which will be displayed when collecting this input"}},"description":"Customize the text which will be displayed while collecting this input","x-stripeMostCommon":["description","skip_button","submit_button","title"]},"required":{"type":"boolean","description":"Indicate that this input is required, disabling the skip button"},"selection":{"title":"selection_params","required":["choices"],"type":"object","properties":{"choices":{"type":"array","description":"List of choices for the `selection` input","items":{"title":"choice_params","required":["id","text"],"type":"object","properties":{"id":{"maxLength":50,"type":"string","description":"The unique identifier for this choice"},"style":{"type":"string","description":"The style of the button which will be shown for this choice. Can be `primary` or `secondary`.","enum":["primary","secondary"]},"text":{"maxLength":30,"type":"string","description":"The text which will be shown on the button for this choice"}},"x-stripeMostCommon":["id","style","text"]}}},"description":"Options for the `selection` input","x-stripeMostCommon":["choices"]},"toggles":{"type":"array","description":"List of toggles to be displayed and customization for the toggles","items":{"title":"toggle_params","type":"object","properties":{"default_value":{"type":"string","description":"The default value of the toggle. Can be `enabled` or `disabled`.","enum":["disabled","enabled"]},"description":{"maxLength":50,"type":"string","description":"The description which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided."},"title":{"maxLength":50,"type":"string","description":"The title which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided."}},"x-stripeMostCommon":["default_value","description","title"]}},"type":{"type":"string","description":"The type of input to collect","enum":["email","numeric","phone","selection","signature","text"]}},"x-stripeMostCommon":["custom_text","required","type"]}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."}},"additionalProperties":false,"x-stripeMostCommon":["inputs","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"inputs":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"collect_terminal_reader_inputs"}},"/v1/terminal/readers/{reader}/collect_payment_method":{"post":{"summary":"Hand off a PaymentIntent to a Reader and collect card details","description":"Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.
","operationId":"PostTerminalReadersReaderCollectPaymentMethod","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["payment_intent"],"type":"object","properties":{"collect_config":{"title":"collect_config","type":"object","properties":{"allow_redisplay":{"type":"string","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.","enum":["always","limited","unspecified"]},"enable_customer_cancellation":{"type":"boolean","description":"Enables cancel button on transaction screens."},"skip_tipping":{"type":"boolean","description":"Override showing a tipping selection screen on this transaction."},"tipping":{"title":"tipping_config","type":"object","properties":{"amount_eligible":{"type":"integer","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)."}},"description":"Tipping configuration for this transaction.","x-stripeMostCommon":["amount_eligible"]}},"description":"Configuration overrides for this collection, such as tipping, surcharging, and customer cancellation settings.","x-stripeMostCommon":["allow_redisplay","enable_customer_cancellation","gift_card_brand","moto","moto_config","request_dynamic_currency_conversion","skip_donation","skip_tipping","surcharge_notice","tipping"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_intent":{"maxLength":5000,"type":"string","description":"The ID of the PaymentIntent to collect a payment method for."}},"additionalProperties":false,"x-stripeMostCommon":["payment_intent"]},"encoding":{"collect_config":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"collect_terminal_payment_method"}},"/v1/terminal/readers/{reader}/confirm_payment_intent":{"post":{"summary":"Confirm a PaymentIntent on the Reader","description":"Finalizes a payment on a Reader. See Confirming a Payment for more details.
","operationId":"PostTerminalReadersReaderConfirmPaymentIntent","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["payment_intent"],"type":"object","properties":{"confirm_config":{"title":"confirm_config","type":"object","properties":{"return_url":{"type":"string","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."}},"description":"Configuration overrides for this confirmation, such as surcharge settings and return URL.","x-stripeMostCommon":["amount_surcharge","return_url","surcharge"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_intent":{"maxLength":5000,"type":"string","description":"The ID of the PaymentIntent to confirm."}},"additionalProperties":false,"x-stripeMostCommon":["payment_intent"]},"encoding":{"confirm_config":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"confirm_terminal_payment_intent"}},"/v1/terminal/readers/{reader}/process_payment_intent":{"post":{"summary":"Hand-off a PaymentIntent to a Reader","description":"Initiates a payment flow on a Reader. See process the payment for more details.
","operationId":"PostTerminalReadersReaderProcessPaymentIntent","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["payment_intent"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_intent":{"maxLength":5000,"type":"string","description":"The ID of the PaymentIntent to process on the reader."},"process_config":{"title":"process_config","type":"object","properties":{"allow_redisplay":{"type":"string","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.","enum":["always","limited","unspecified"]},"enable_customer_cancellation":{"type":"boolean","description":"Enables cancel button on transaction screens."},"return_url":{"type":"string","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."},"skip_tipping":{"type":"boolean","description":"Override showing a tipping selection screen on this transaction."},"tipping":{"title":"tipping_config","type":"object","properties":{"amount_eligible":{"type":"integer","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)."}},"description":"Tipping configuration for this transaction.","x-stripeMostCommon":["amount_eligible"]}},"description":"Configuration overrides for this transaction, such as tipping and customer cancellation settings.","x-stripeMostCommon":["allow_redisplay","enable_customer_cancellation","gift_card_brand","moto","moto_config","return_url","skip_donation","skip_tipping","tipping"]}},"additionalProperties":false,"x-stripeMostCommon":["payment_intent"]},"encoding":{"expand":{"style":"deepObject","explode":true},"process_config":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"process_terminal_payment_intent"}},"/v1/terminal/readers/{reader}/process_setup_intent":{"post":{"summary":"Hand-off a SetupIntent to a Reader","description":"Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.
","operationId":"PostTerminalReadersReaderProcessSetupIntent","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["allow_redisplay","setup_intent"],"type":"object","properties":{"allow_redisplay":{"type":"string","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.","enum":["always","limited","unspecified"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"process_config":{"title":"process_setup_config","type":"object","properties":{"enable_customer_cancellation":{"type":"boolean","description":"Enables cancel button on transaction screens."}},"description":"Configuration overrides for this setup, such as MOTO and customer cancellation settings.","x-stripeMostCommon":["enable_customer_cancellation","moto","moto_config"]},"setup_intent":{"maxLength":5000,"type":"string","description":"The ID of the SetupIntent to process on the reader."}},"additionalProperties":false,"x-stripeMostCommon":["allow_redisplay","setup_intent"]},"encoding":{"expand":{"style":"deepObject","explode":true},"process_config":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"process_terminal_setup_intent"}},"/v1/terminal/readers/{reader}/refund_payment":{"post":{"summary":"Refund a Charge or a PaymentIntent in-person","description":"Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.
","operationId":"PostTerminalReadersReaderRefundPayment","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"A positive integer in __cents__ representing how much of this charge to refund."},"charge":{"maxLength":5000,"type":"string","description":"ID of the Charge to refund."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"maxLength":5000,"type":"string","description":"ID of the PaymentIntent to refund."},"refund_application_fee":{"type":"boolean","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."},"refund_payment_config":{"title":"refund_payment_config","type":"object","properties":{"enable_customer_cancellation":{"type":"boolean","description":"Enables cancel button on transaction screens."}},"description":"Configuration overrides for this refund, such as customer cancellation settings.","x-stripeMostCommon":["enable_customer_cancellation"]},"reverse_transfer":{"type":"boolean","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."}},"additionalProperties":false,"x-stripeMostCommon":["amount","charge","metadata","payment_intent","refund_application_fee","reverse_transfer"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"refund_payment_config":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"refund_terminal_payment"}},"/v1/terminal/readers/{reader}/set_reader_display":{"post":{"summary":"Set reader display","description":"Sets the reader display to show cart details.
","operationId":"PostTerminalReadersReaderSetReaderDisplay","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["type"],"type":"object","properties":{"cart":{"title":"cart","required":["currency","line_items","total"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"line_items":{"type":"array","description":"Array of line items to display.","items":{"title":"line_item","required":["amount","description","quantity"],"type":"object","properties":{"amount":{"type":"integer","description":"The price of the item in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."},"description":{"maxLength":5000,"type":"string","description":"The description or name of the item."},"quantity":{"type":"integer","description":"The quantity of the line item being purchased."}},"x-stripeMostCommon":["amount","description","quantity"]}},"tax":{"type":"integer","description":"The amount of tax in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."},"total":{"type":"integer","description":"Total balance of cart due in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."}},"description":"Cart details to display on the reader screen, including line items, amounts, and currency.","x-stripeMostCommon":["currency","line_items","tax","total"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"type":{"type":"string","description":"Type of information to display. Only `cart` is currently supported.","enum":["cart"]}},"additionalProperties":false,"x-stripeMostCommon":["cart","type"]},"encoding":{"cart":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"set_terminal_reader_display"}},"/v1/test/payment_intents/{intent}/trigger_action":{"post":{"summary":"Trigger an external action on a PaymentIntent.","description":"Trigger an external action on a PaymentIntent.
","operationId":"PostTestPaymentIntentsIntentTriggerAction","parameters":[{"name":"intent","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["type"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"scan_qr_code":{"title":"scan_qr_code_params","type":"object","properties":{"result":{"type":"string","description":"Whether the QR Code scan's payment should succeed or fail.","enum":["failure","success"]}},"description":"True to simulate success, false to simulate failure.","x-stripeMostCommon":["result"]},"type":{"type":"string","description":"The type of action to be simulated.","enum":["expire","fund"],"x-stripeBypassValidation":true}},"additionalProperties":false,"x-stripeMostCommon":["scan_qr_code","type"]},"encoding":{"expand":{"style":"deepObject","explode":true},"scan_qr_code":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_intent"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}},"/v1/test_helpers/confirmation_tokens":{"post":{"summary":"Create a test Confirmation Token","description":"Creates a test mode Confirmation Token server side for your integration tests.
","operationId":"PostTestHelpersConfirmationTokens","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_method":{"maxLength":5000,"type":"string","description":"ID of an existing PaymentMethod."},"payment_method_data":{"title":"payment_method_data_params","required":["type"],"type":"object","properties":{"acss_debit":{"title":"payment_method_param","required":["account_number","institution_number","transit_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Customer's bank account number."},"institution_number":{"maxLength":5000,"type":"string","description":"Institution number of the customer's bank."},"transit_number":{"maxLength":5000,"type":"string","description":"Transit number of the customer's bank."}},"description":"If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.","x-stripeMostCommon":["account_number","financial_connections_account","institution_number","transit_number"]},"affirm":{"title":"param","type":"object","properties":{},"description":"If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method."},"afterpay_clearpay":{"title":"param","type":"object","properties":{},"description":"If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method."},"alipay":{"title":"param","type":"object","properties":{},"description":"If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method."},"allow_redisplay":{"type":"string","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"]},"alma":{"title":"param","type":"object","properties":{},"description":"If this is an Alma PaymentMethod, this hash contains details about the Alma payment method."},"amazon_pay":{"title":"param","type":"object","properties":{},"description":"If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method."},"au_becs_debit":{"title":"param","required":["account_number","bsb_number"],"type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."}},"description":"If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.","x-stripeMostCommon":["account_number","bsb_number"]},"bacs_debit":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account that the funds will be debited from."},"sort_code":{"maxLength":5000,"type":"string","description":"Sort code of the bank account. (e.g., `10-20-30`)"}},"description":"If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.","x-stripeMostCommon":["account_number","sort_code"]},"bancontact":{"title":"param","type":"object","properties":{},"description":"If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method."},"billie":{"title":"param","type":"object","properties":{},"description":"If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method."},"billing_details":{"title":"billing_details_inner_params","type":"object","properties":{"address":{"description":"Billing address.","anyOf":[{"title":"billing_details_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"email":{"description":"Email address.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"name":{"description":"Full name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"phone":{"description":"Billing phone number (including extension).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"tax_id":{"maxLength":5000,"type":"string","description":"Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone","tax_id"]},"bizum":{"title":"param","type":"object","properties":{},"description":"If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method."},"blik":{"title":"param","type":"object","properties":{},"description":"If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method."},"boleto":{"title":"param","required":["tax_id"],"type":"object","properties":{"tax_id":{"maxLength":5000,"type":"string","description":"The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)"}},"description":"If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.","x-stripeMostCommon":["tax_id"]},"cashapp":{"title":"param","type":"object","properties":{},"description":"If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method."},"crypto":{"title":"param","type":"object","properties":{},"description":"If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method."},"customer_balance":{"title":"param","type":"object","properties":{},"description":"If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method."},"eps":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's 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"]}},"description":"If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.","x-stripeMostCommon":["bank"]},"fpx":{"title":"param","required":["bank"],"type":"object","properties":{"account_holder_type":{"maxLength":5000,"type":"string","description":"Account holder type for FPX transaction","enum":["company","individual"]},"bank":{"maxLength":5000,"type":"string","description":"The customer's bank.","enum":["affin_bank","agrobank","alliance_bank","ambank","bank_islam","bank_muamalat","bank_of_china","bank_rakyat","bnp_paribas","bsn","cimb","citibank","deutsche_bank","hong_leong_bank","hsbc","kfh","maybank2e","maybank2u","mbsb_bank","ocbc","pb_enterprise","public_bank","rhb","standard_chartered","uob"],"x-stripeBypassValidation":true}},"description":"If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.","x-stripeMostCommon":["account_holder_type","bank"]},"giropay":{"title":"param","type":"object","properties":{},"description":"If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method."},"gopay":{"title":"param","type":"object","properties":{},"description":"If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method."},"grabpay":{"title":"param","type":"object","properties":{},"description":"If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method."},"id_bank_transfer":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"Bank where the account is held.","enum":["bca","bni","bri","cimb","permata"],"x-stripeBypassValidation":true}},"description":"If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.","x-stripeMostCommon":["bank"]},"ideal":{"title":"param","type":"object","properties":{"bank":{"maxLength":5000,"type":"string","description":"The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.","enum":["abn_amro","adyen","asn_bank","bunq","buut","finom","handelsbanken","ing","knab","mollie","moneyou","n26","nn","rabobank","regiobank","revolut","sns_bank","triodos_bank","van_lanschot","yoursafe"]}},"description":"If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.","x-stripeMostCommon":["bank"]},"interac_present":{"title":"param","type":"object","properties":{},"description":"If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.","x-stripeMostCommon":["device_identifier","device_type","emv","location"]},"kakao_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method."},"klarna":{"title":"param","type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.","x-stripeMostCommon":["dob"]},"konbini":{"title":"param","type":"object","properties":{},"description":"If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method."},"kr_card":{"title":"param","type":"object","properties":{},"description":"If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method."},"link":{"title":"param","type":"object","properties":{},"description":"If this is an `Link` PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK)."},"mb_way":{"title":"param","type":"object","properties":{},"description":"If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"mobilepay":{"title":"param","type":"object","properties":{},"description":"If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method."},"multibanco":{"title":"param","type":"object","properties":{},"description":"If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method."},"naver_pay":{"title":"param","type":"object","properties":{"funding":{"type":"string","description":"Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.","enum":["card","points"],"x-stripeBypassValidation":true}},"description":"If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.","x-stripeMostCommon":["funding"]},"nz_bank_account":{"title":"param","required":["account_number","bank_code","branch_code","suffix"],"type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."},"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bank_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank."},"branch_code":{"maxLength":5000,"type":"string","description":"The numeric code for the bank account's bank branch."},"reference":{"maxLength":128,"type":"string"},"suffix":{"maxLength":5000,"type":"string","description":"The suffix of the bank account number."}},"description":"If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.","x-stripeMostCommon":["account_holder_name","account_number","bank_code","branch_code","reference","suffix"]},"oxxo":{"title":"param","type":"object","properties":{},"description":"If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method."},"p24":{"title":"param","type":"object","properties":{"bank":{"type":"string","description":"The customer's 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"],"x-stripeBypassValidation":true}},"description":"If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.","x-stripeMostCommon":["bank"]},"pay_by_bank":{"title":"param","type":"object","properties":{},"description":"If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method."},"payco":{"title":"param","type":"object","properties":{},"description":"If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method."},"paynow":{"title":"param","type":"object","properties":{},"description":"If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method."},"paypal":{"title":"param","type":"object","properties":{},"description":"If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method."},"paypay":{"title":"param","type":"object","properties":{},"description":"If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method."},"payto":{"title":"param","type":"object","properties":{"account_number":{"maxLength":5000,"type":"string","description":"The account number for the bank account."},"bsb_number":{"maxLength":5000,"type":"string","description":"Bank-State-Branch number of the bank account."},"pay_id":{"maxLength":5000,"type":"string","description":"The PayID alias for the bank account."}},"description":"If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.","x-stripeMostCommon":["account_number","bsb_number","pay_id"]},"pix":{"title":"param","type":"object","properties":{},"description":"If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.","x-stripeMostCommon":["tax_id"]},"promptpay":{"title":"param","type":"object","properties":{},"description":"If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method."},"qris":{"title":"param","type":"object","properties":{},"description":"If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method."},"radar_options":{"title":"radar_options_with_hidden_options","type":"object","properties":{"session":{"maxLength":5000,"type":"string","description":"A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."}},"description":"Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.","x-stripeMostCommon":["session","skip_rules"]},"rechnung":{"title":"param","required":["dob"],"type":"object","properties":{"dob":{"title":"date_of_birth","required":["day","month","year"],"type":"object","properties":{"day":{"type":"integer","description":"The day of birth, between 1 and 31."},"month":{"type":"integer","description":"The month of birth, between 1 and 12."},"year":{"type":"integer","description":"The four-digit year of birth."}},"description":"Customer's date of birth","x-stripeMostCommon":["day","month","year"]}},"description":"If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.","x-stripeMostCommon":["dob"]},"revolut_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method."},"samsung_pay":{"title":"param","type":"object","properties":{},"description":"If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method."},"satispay":{"title":"param","type":"object","properties":{},"description":"If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method."},"scalapay":{"title":"param","type":"object","properties":{},"description":"If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method."},"sepa_debit":{"title":"param","required":["iban"],"type":"object","properties":{"iban":{"maxLength":5000,"type":"string","description":"IBAN of the bank account."}},"description":"If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.","x-stripeMostCommon":["iban"]},"sequra":{"title":"param","type":"object","properties":{},"description":"If this is a SeQura PaymentMethod, this hash contains details about the SeQura payment method."},"shared_payment_granted_token":{"type":"string","description":"ID of the SharedPaymentGrantedToken used to confirm this PaymentIntent."},"shopeepay":{"title":"param","type":"object","properties":{},"description":"If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method."},"sofort":{"title":"param","required":["country"],"type":"object","properties":{"country":{"type":"string","description":"Two-letter ISO code representing the country the bank account is located in.","enum":["AT","BE","DE","ES","IT","NL"]}},"description":"If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.","x-stripeMostCommon":["country"]},"stripe_balance":{"title":"param","type":"object","properties":{"account":{"maxLength":5000,"type":"string","description":"The connected account ID whose Stripe balance to use as the source of payment"}},"description":"This hash contains details about the Stripe balance payment method.","x-stripeMostCommon":["account","financial_account"]},"sunbit":{"title":"param","type":"object","properties":{},"description":"If this is a `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method."},"swish":{"title":"param","type":"object","properties":{},"description":"If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method."},"twint":{"title":"param","type":"object","properties":{},"description":"If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method."},"type":{"type":"string","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","alma","amazon_pay","au_becs_debit","bacs_debit","bancontact","billie","bizum","blik","boleto","cashapp","crypto","customer_balance","eps","fpx","giropay","gopay","grabpay","id_bank_transfer","ideal","kakao_pay","klarna","konbini","kr_card","link","mb_way","mobilepay","multibanco","naver_pay","nz_bank_account","oxxo","p24","pay_by_bank","payco","paynow","paypal","paypay","payto","pix","promptpay","qris","rechnung","revolut_pay","samsung_pay","satispay","scalapay","sepa_debit","sequra","shopeepay","sofort","stripe_balance","sunbit","swish","twint","upi","us_bank_account","wechat_pay","zip"],"x-stripeBypassValidation":true},"upi":{"title":"param","type":"object","properties":{"mandate_options":{"title":"mandate_options","type":"object","properties":{"amount":{"type":"integer","description":"Amount to be charged for future payments."},"amount_type":{"type":"string","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"]},"description":{"maxLength":20,"type":"string","description":"A description of the mandate or subscription that is meant to be displayed to the customer."},"end_date":{"type":"integer","description":"End date of the mandate or subscription.","format":"unix-time"}},"description":"Configuration options for setting up an eMandate","x-stripeMostCommon":["amount","amount_type","description","end_date"]}},"description":"If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.","x-stripeMostCommon":["mandate_options","vpa"]},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"account_holder_type":{"type":"string","description":"Account holder type: individual or company.","enum":["company","individual"]},"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account."},"account_type":{"type":"string","description":"Account type: checkings or savings. Defaults to checking if omitted.","enum":["checking","savings"]},"financial_connections_account":{"maxLength":5000,"type":"string","description":"The ID of a Financial Connections Account to use as a payment method."},"routing_number":{"maxLength":5000,"type":"string","description":"Routing number of the bank account."}},"description":"If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.","x-stripeMostCommon":["account_holder_type","account_number","account_type","financial_connections_account","routing_number","token"]},"wechat_pay":{"title":"param","type":"object","properties":{},"description":"If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method."},"zip":{"title":"param","type":"object","properties":{},"description":"If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method."}},"description":"If provided, this hash will be used to create a PaymentMethod.","x-stripeMostCommon":["billing_details","metadata","type"]},"payment_method_options":{"title":"test_payment_method_options_param","type":"object","properties":{"card":{"title":"card_param","type":"object","properties":{"installments":{"title":"installments_param","required":["plan"],"type":"object","properties":{"plan":{"title":"installment_plan","required":["type"],"type":"object","properties":{"count":{"type":"integer","description":"For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card."},"interval":{"type":"string","description":"For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.\nOne of `month`.","enum":["month"]},"type":{"type":"string","description":"Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`.","enum":["bonus","fixed_count","revolving"]}},"description":"The selected installment plan to use for this payment attempt.\nThis parameter can only be provided during confirmation.","x-stripeMostCommon":["count","interval","type"]}},"description":"Installment configuration for payments confirmed using this ConfirmationToken.","x-stripeMostCommon":["plan"]}},"description":"Configuration for any card payments confirmed using this ConfirmationToken.","x-stripeMostCommon":["installments"]}},"description":"Payment-method-specific configuration for this ConfirmationToken.","x-stripeMostCommon":["card"]},"return_url":{"type":"string","description":"Return URL used to confirm the Intent."},"setup_future_usage":{"type":"string","description":"Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://docs.stripe.com/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"]},"shipping":{"title":"recipient_shipping_with_optional_fields_address","required":["address","name"],"type":"object","properties":{"address":{"title":"optional_fields_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"description":"Shipping address","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"name":{"maxLength":5000,"type":"string","description":"Recipient name."},"phone":{"description":"Recipient phone (including extension)","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Shipping information for this ConfirmationToken.","x-stripeMostCommon":["address","name","phone"]}},"additionalProperties":false,"x-stripeMostCommon":["payment_method","payment_method_data","payment_method_options","return_url","setup_future_usage","shipping"]},"encoding":{"expand":{"style":"deepObject","explode":true},"payment_method_data":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true},"shipping":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmation_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_test_confirmation_token"}},"/v1/test_helpers/customers/{customer}/fund_cash_balance":{"post":{"summary":"Fund a test mode cash balance","description":"Create an incoming testmode bank transfer
","operationId":"PostTestHelpersCustomersCustomerFundCashBalance","parameters":[{"name":"customer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency)."},"currency":{"type":"string","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).","format":"currency"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"reference":{"maxLength":5000,"type":"string","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://docs.stripe.com/payments/customer-balance/reconciliation) applies to different user inputs."}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_cash_balance_transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"fund_test_mode_cash_balance_transaction"}},"/v1/test_helpers/issuing/authorizations":{"post":{"summary":"Create a test-mode authorization","description":"Create a test-mode authorization.
","operationId":"PostTestHelpersIssuingAuthorizations","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["card"],"type":"object","properties":{"amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal)."},"amount_details":{"title":"amount_details_specs","type":"object","properties":{"atm_fee":{"type":"integer","description":"The ATM withdrawal fee."},"cashback_amount":{"type":"integer","description":"The amount of cash requested by the cardholder."}},"description":"Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).","x-stripeMostCommon":["atm_fee","cashback_amount"]},"authorization_method":{"type":"string","description":"How the card details were provided. Defaults to online.","enum":["chip","contactless","keyed_in","online","swipe"]},"card":{"maxLength":5000,"type":"string","description":"Card associated with this authorization."},"currency":{"type":"string","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).","format":"currency"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fleet":{"title":"fleet_testmode_authorization_specs","type":"object","properties":{"cardholder_prompt_data":{"title":"fleet_cardholder_prompt_data_specs","type":"object","properties":{"driver_id":{"maxLength":5000,"type":"string","description":"Driver ID."},"odometer":{"type":"integer","description":"Odometer reading."},"unspecified_id":{"maxLength":5000,"type":"string","description":"An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."},"user_id":{"maxLength":5000,"type":"string","description":"User ID."},"vehicle_number":{"maxLength":5000,"type":"string","description":"Vehicle number."}},"description":"Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.","x-stripeMostCommon":["driver_id","odometer","unspecified_id","user_id","vehicle_number"]},"purchase_type":{"maxLength":5000,"type":"string","description":"The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.","enum":["fuel_and_non_fuel_purchase","fuel_purchase","non_fuel_purchase"]},"reported_breakdown":{"title":"fleet_reported_breakdown_specs","type":"object","properties":{"fuel":{"title":"fleet_reported_breakdown_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"non_fuel":{"title":"fleet_reported_breakdown_non_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of non-fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"tax":{"title":"fleet_reported_breakdown_tax_specs","type":"object","properties":{"local_amount_decimal":{"type":"string","description":"Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"},"national_amount_decimal":{"type":"string","description":"Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"}},"description":"Information about tax included in this transaction.","x-stripeMostCommon":["local_amount_decimal","national_amount_decimal"]}},"description":"More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.","x-stripeMostCommon":["fuel","non_fuel","tax"]},"service_type":{"maxLength":5000,"type":"string","description":"The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.","enum":["full_service","non_fuel_transaction","self_service"]}},"description":"Fleet-specific information for authorizations using Fleet cards.","x-stripeMostCommon":["cardholder_prompt_data","dynamic_purchase_controls_supported","purchase_type","reported_breakdown","service_type"]},"fraud_disputability_likelihood":{"type":"string","description":"Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules.","enum":["neutral","unknown","very_likely","very_unlikely"]},"fuel":{"title":"fuel_specs","type":"object","properties":{"industry_product_code":{"maxLength":5000,"type":"string","description":"[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."},"quantity_decimal":{"type":"string","description":"The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.","format":"decimal"},"type":{"maxLength":5000,"type":"string","description":"The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.","enum":["diesel","other","unleaded_plus","unleaded_regular","unleaded_super"]},"unit":{"maxLength":5000,"type":"string","description":"The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.","enum":["charging_minute","imperial_gallon","kilogram","kilowatt_hour","liter","other","pound","us_gallon"]},"unit_cost_decimal":{"type":"string","description":"The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.","format":"decimal"}},"description":"Information about fuel that was purchased with this transaction.","x-stripeMostCommon":["industry_product_code","quantity_decimal","type","unit","unit_cost_decimal"]},"is_amount_controllable":{"type":"boolean","description":"If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization."},"merchant_amount":{"type":"integer","description":"The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."},"merchant_currency":{"type":"string","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).","format":"currency"},"merchant_data":{"title":"merchant_data_specs","type":"object","properties":{"category":{"maxLength":5000,"type":"string","description":"A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.","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"]},"city":{"maxLength":5000,"type":"string","description":"City where the seller is located"},"country":{"maxLength":5000,"type":"string","description":"Country where the seller is located"},"name":{"maxLength":5000,"type":"string","description":"Name of the seller"},"network_id":{"maxLength":5000,"type":"string","description":"Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code where the seller is located"},"state":{"maxLength":5000,"type":"string","description":"State where the seller is located"},"terminal_id":{"maxLength":5000,"type":"string","description":"An ID assigned by the seller to the location of the sale."},"url":{"maxLength":5000,"type":"string","description":"URL provided by the merchant on a 3DS request"}},"description":"Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.","x-stripeMostCommon":["category","city","country","name","network_id","payment_facilitator_id","postal_code","state","sub_merchant_id","terminal_id","url"]},"network_data":{"title":"network_data_specs","type":"object","properties":{"acquiring_institution_id":{"maxLength":5000,"type":"string","description":"Identifier assigned to the acquirer by the card network."}},"description":"Details about the authorization, such as identifiers, set by the card network.","x-stripeMostCommon":["acquiring_institution_id","routed_network"]},"risk_assessment":{"title":"risk_assessment_specs","type":"object","properties":{"card_testing_risk":{"title":"card_testing_risk_specs","required":["level"],"type":"object","properties":{"invalid_account_number_decline_rate_past_hour":{"type":"integer","description":"The % of declines due to a card number not existing in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of card testing activity, meaning bad actors may be attempting different card number combinations to guess a correct one. Takes on values between 0 and 100."},"invalid_credentials_decline_rate_past_hour":{"type":"integer","description":"The % of declines due to incorrect verification data (like CVV or expiry) in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of bad actors attempting to utilize valid card credentials at merchants with verification requirements. Takes on values between 0 and 100."},"level":{"type":"string","description":"The likelihood that this authorization is associated with card testing activity. This is assessed by evaluating decline activity over the last hour.","enum":["elevated","highest","low","normal","not_assessed","unknown"],"x-stripeBypassValidation":true}},"description":"Stripe's assessment of this authorization's likelihood of being card testing activity.","x-stripeMostCommon":["invalid_account_number_decline_rate_past_hour","invalid_credentials_decline_rate_past_hour","level"]},"fraud_risk":{"title":"fraud_risk_specs","required":["level"],"type":"object","properties":{"level":{"type":"string","description":"Stripe’s assessment of the likelihood of fraud on an authorization.","enum":["elevated","highest","low","normal","not_assessed","unknown"],"x-stripeBypassValidation":true},"score":{"type":"number","description":"Stripe’s numerical model score assessing the likelihood of fraudulent activity. A higher score means a higher likelihood of fraudulent activity, and anything above 25 is considered high risk."}},"description":"Stripe’s assessment of this authorization’s likelihood to be fraudulent.","x-stripeMostCommon":["level","score"]},"merchant_dispute_risk":{"title":"merchant_dispute_risk_specs","required":["level"],"type":"object","properties":{"dispute_rate":{"type":"integer","description":"The dispute rate observed across all Stripe Issuing authorizations for this merchant. For example, a value of 50 means 50% of authorizations from this merchant on Stripe Issuing have resulted in a dispute. Higher values mean a higher likelihood the authorization is disputed. Takes on values between 0 and 100."},"level":{"type":"string","description":"The likelihood that authorizations from this merchant will result in a dispute based on their history on Stripe Issuing.","enum":["elevated","highest","low","normal","not_assessed","unknown"],"x-stripeBypassValidation":true}},"description":"The dispute risk of the merchant (the seller on a purchase) on an authorization based on all Stripe Issuing activity.","x-stripeMostCommon":["dispute_rate","level"]}},"description":"Stripe’s assessment of the fraud risk for this authorization.","x-stripeMostCommon":["card_testing_risk","fraud_risk","merchant_dispute_risk"]},"verification_data":{"title":"verification_data_specs","type":"object","properties":{"address_line1_check":{"type":"string","description":"Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.","enum":["match","mismatch","not_provided"]},"address_postal_code_check":{"type":"string","description":"Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.","enum":["match","mismatch","not_provided"]},"authentication_exemption":{"title":"authentication_exemption_specs","required":["claimed_by","type"],"type":"object","properties":{"claimed_by":{"type":"string","description":"The entity that requested the exemption, either the acquiring merchant or the Issuing user.","enum":["acquirer","issuer"]},"type":{"type":"string","description":"The specific exemption claimed for this authorization.","enum":["low_value_transaction","transaction_risk_analysis","unknown"],"x-stripeBypassValidation":true}},"description":"The exemption applied to this authorization.","x-stripeMostCommon":["claimed_by","type"]},"cvc_check":{"type":"string","description":"Whether the cardholder provided a CVC and if it matched Stripe’s record.","enum":["match","mismatch","not_provided"]},"expiry_check":{"type":"string","description":"Whether the cardholder provided an expiry date and if it matched Stripe’s record.","enum":["match","mismatch","not_provided"]},"three_d_secure":{"title":"three_d_secure_specs","required":["result"],"type":"object","properties":{"result":{"type":"string","description":"The outcome of the 3D Secure authentication request.","enum":["attempt_acknowledged","authenticated","failed","required"],"x-stripeBypassValidation":true}},"description":"3D Secure details.","x-stripeMostCommon":["result"]}},"description":"Verifications that Stripe performed on information that the cardholder provided to the merchant.","x-stripeMostCommon":["address_line1_check","address_postal_code_check","authentication_exemption","cvc_check","expiry_check","three_d_secure"]},"wallet":{"type":"string","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"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","card","currency"]},"encoding":{"amount_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"fleet":{"style":"deepObject","explode":true},"fuel":{"style":"deepObject","explode":true},"merchant_data":{"style":"deepObject","explode":true},"network_data":{"style":"deepObject","explode":true},"risk_assessment":{"style":"deepObject","explode":true},"verification_data":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/authorizations/{authorization}/capture":{"post":{"summary":"Capture a test-mode authorization","description":"Capture a test-mode authorization.
","operationId":"PostTestHelpersIssuingAuthorizationsAuthorizationCapture","parameters":[{"name":"authorization","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"capture_amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal)."},"close_authorization":{"type":"boolean","description":"Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"purchase_details":{"title":"purchase_details_specs","type":"object","properties":{"fleet":{"title":"fleet_specs","type":"object","properties":{"cardholder_prompt_data":{"title":"fleet_cardholder_prompt_data_specs","type":"object","properties":{"driver_id":{"maxLength":5000,"type":"string","description":"Driver ID."},"odometer":{"type":"integer","description":"Odometer reading."},"unspecified_id":{"maxLength":5000,"type":"string","description":"An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."},"user_id":{"maxLength":5000,"type":"string","description":"User ID."},"vehicle_number":{"maxLength":5000,"type":"string","description":"Vehicle number."}},"description":"Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.","x-stripeMostCommon":["driver_id","odometer","unspecified_id","user_id","vehicle_number"]},"purchase_type":{"maxLength":5000,"type":"string","description":"The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.","enum":["fuel_and_non_fuel_purchase","fuel_purchase","non_fuel_purchase"]},"reported_breakdown":{"title":"fleet_reported_breakdown_specs","type":"object","properties":{"fuel":{"title":"fleet_reported_breakdown_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"non_fuel":{"title":"fleet_reported_breakdown_non_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of non-fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"tax":{"title":"fleet_reported_breakdown_tax_specs","type":"object","properties":{"local_amount_decimal":{"type":"string","description":"Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"},"national_amount_decimal":{"type":"string","description":"Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"}},"description":"Information about tax included in this transaction.","x-stripeMostCommon":["local_amount_decimal","national_amount_decimal"]}},"description":"More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.","x-stripeMostCommon":["fuel","non_fuel","tax"]},"service_type":{"maxLength":5000,"type":"string","description":"The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.","enum":["full_service","non_fuel_transaction","self_service"]}},"description":"Fleet-specific information for transactions using Fleet cards.","x-stripeMostCommon":["cardholder_prompt_data","purchase_type","reported_breakdown","service_type"]},"flight":{"title":"flight_specs","type":"object","properties":{"departure_at":{"type":"integer","description":"The time that the flight departed.","format":"unix-time"},"passenger_name":{"maxLength":5000,"type":"string","description":"The name of the passenger."},"refundable":{"type":"boolean","description":"Whether the ticket is refundable."},"segments":{"type":"array","description":"The legs of the trip.","items":{"title":"flight_segment_specs","type":"object","properties":{"arrival_airport_code":{"maxLength":3,"type":"string","description":"The three-letter IATA airport code of the flight's destination."},"carrier":{"maxLength":5000,"type":"string","description":"The airline carrier code."},"departure_airport_code":{"maxLength":3,"type":"string","description":"The three-letter IATA airport code that the flight departed from."},"flight_number":{"maxLength":5000,"type":"string","description":"The flight number."},"service_class":{"maxLength":5000,"type":"string","description":"The flight's service class."},"stopover_allowed":{"type":"boolean","description":"Whether a stopover is allowed on this flight."}},"x-stripeMostCommon":["arrival_airport_code","carrier","departure_airport_code","flight_number","service_class","stopover_allowed"]}},"travel_agency":{"maxLength":5000,"type":"string","description":"The travel agency that issued the ticket."}},"description":"Information about the flight that was purchased with this transaction.","x-stripeMostCommon":["departure_at","passenger_name","refundable","segments","travel_agency"]},"fuel":{"title":"fuel_specs","type":"object","properties":{"industry_product_code":{"maxLength":5000,"type":"string","description":"[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."},"quantity_decimal":{"type":"string","description":"The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.","format":"decimal"},"type":{"maxLength":5000,"type":"string","description":"The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.","enum":["diesel","other","unleaded_plus","unleaded_regular","unleaded_super"]},"unit":{"maxLength":5000,"type":"string","description":"The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.","enum":["charging_minute","imperial_gallon","kilogram","kilowatt_hour","liter","other","pound","us_gallon"]},"unit_cost_decimal":{"type":"string","description":"The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.","format":"decimal"}},"description":"Information about fuel that was purchased with this transaction.","x-stripeMostCommon":["industry_product_code","quantity_decimal","type","unit","unit_cost_decimal"]},"lodging":{"title":"lodging_specs","type":"object","properties":{"check_in_at":{"type":"integer","description":"The time of checking into the lodging.","format":"unix-time"},"nights":{"type":"integer","description":"The number of nights stayed at the lodging."}},"description":"Information about lodging that was purchased with this transaction.","x-stripeMostCommon":["check_in_at","nights"]},"receipt":{"type":"array","description":"The line items in the purchase.","items":{"title":"receipt_specs","type":"object","properties":{"description":{"maxLength":26,"type":"string"},"quantity":{"type":"string","format":"decimal"},"total":{"type":"integer"},"unit_cost":{"type":"integer"}},"x-stripeMostCommon":["description","quantity","total","unit_cost"]}},"reference":{"maxLength":5000,"type":"string","description":"A merchant-specific order number."}},"description":"Additional purchase information that is optionally provided by the merchant.","x-stripeMostCommon":["fleet","flight","fuel","healthcare","lodging","receipt","reference"]}},"additionalProperties":false,"x-stripeMostCommon":["capture_amount","close_authorization","purchase_details"]},"encoding":{"expand":{"style":"deepObject","explode":true},"purchase_details":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"capture_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/authorizations/{authorization}/expire":{"post":{"summary":"Expire a test-mode authorization","description":"Expire a test-mode Authorization.
","operationId":"PostTestHelpersIssuingAuthorizationsAuthorizationExpire","parameters":[{"name":"authorization","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"expire_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount":{"post":{"summary":"Finalize a test-mode authorization's amount","description":"Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
","operationId":"PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount","parameters":[{"name":"authorization","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["final_amount"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"final_amount":{"type":"integer","description":"The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."},"fleet":{"title":"fleet_specs","type":"object","properties":{"cardholder_prompt_data":{"title":"fleet_cardholder_prompt_data_specs","type":"object","properties":{"driver_id":{"maxLength":5000,"type":"string","description":"Driver ID."},"odometer":{"type":"integer","description":"Odometer reading."},"unspecified_id":{"maxLength":5000,"type":"string","description":"An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."},"user_id":{"maxLength":5000,"type":"string","description":"User ID."},"vehicle_number":{"maxLength":5000,"type":"string","description":"Vehicle number."}},"description":"Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.","x-stripeMostCommon":["driver_id","odometer","unspecified_id","user_id","vehicle_number"]},"purchase_type":{"maxLength":5000,"type":"string","description":"The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.","enum":["fuel_and_non_fuel_purchase","fuel_purchase","non_fuel_purchase"]},"reported_breakdown":{"title":"fleet_reported_breakdown_specs","type":"object","properties":{"fuel":{"title":"fleet_reported_breakdown_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"non_fuel":{"title":"fleet_reported_breakdown_non_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of non-fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"tax":{"title":"fleet_reported_breakdown_tax_specs","type":"object","properties":{"local_amount_decimal":{"type":"string","description":"Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"},"national_amount_decimal":{"type":"string","description":"Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"}},"description":"Information about tax included in this transaction.","x-stripeMostCommon":["local_amount_decimal","national_amount_decimal"]}},"description":"More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.","x-stripeMostCommon":["fuel","non_fuel","tax"]},"service_type":{"maxLength":5000,"type":"string","description":"The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.","enum":["full_service","non_fuel_transaction","self_service"]}},"description":"Fleet-specific information for authorizations using Fleet cards.","x-stripeMostCommon":["cardholder_prompt_data","purchase_type","reported_breakdown","service_type"]},"fuel":{"title":"fuel_specs","type":"object","properties":{"industry_product_code":{"maxLength":5000,"type":"string","description":"[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."},"quantity_decimal":{"type":"string","description":"The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.","format":"decimal"},"type":{"maxLength":5000,"type":"string","description":"The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.","enum":["diesel","other","unleaded_plus","unleaded_regular","unleaded_super"]},"unit":{"maxLength":5000,"type":"string","description":"The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.","enum":["charging_minute","imperial_gallon","kilogram","kilowatt_hour","liter","other","pound","us_gallon"]},"unit_cost_decimal":{"type":"string","description":"The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.","format":"decimal"}},"description":"Information about fuel that was purchased with this transaction.","x-stripeMostCommon":["industry_product_code","quantity_decimal","type","unit","unit_cost_decimal"]}},"additionalProperties":false,"x-stripeMostCommon":["final_amount"]},"encoding":{"expand":{"style":"deepObject","explode":true},"fleet":{"style":"deepObject","explode":true},"fuel":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"finalize_amount_on_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond":{"post":{"summary":"Respond to fraud challenge","description":"Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.
","operationId":"PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond","parameters":[{"name":"authorization","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["confirmed"],"type":"object","properties":{"confirmed":{"type":"boolean","description":"Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false)."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["confirmed"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"respond_to_fraud_challenge_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/authorizations/{authorization}/increment":{"post":{"summary":"Increment a test-mode authorization","description":"Increment a test-mode Authorization.
","operationId":"PostTestHelpersIssuingAuthorizationsAuthorizationIncrement","parameters":[{"name":"authorization","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["increment_amount"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"increment_amount":{"type":"integer","description":"The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."},"is_amount_controllable":{"type":"boolean","description":"If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization."}},"additionalProperties":false,"x-stripeMostCommon":["increment_amount","is_amount_controllable"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"increment_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/authorizations/{authorization}/reverse":{"post":{"summary":"Reverse a test-mode authorization","description":"Reverse a test-mode Authorization.
","operationId":"PostTestHelpersIssuingAuthorizationsAuthorizationReverse","parameters":[{"name":"authorization","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"reverse_amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal)."}},"additionalProperties":false,"x-stripeMostCommon":["reverse_amount"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.authorization"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"reverse_test_mode_issuing_authorization"}},"/v1/test_helpers/issuing/cards/{card}/shipping/deliver":{"post":{"summary":"Deliver a testmode card","description":"Updates the shipping status of the specified Issuing Card object to delivered.
Updates the shipping status of the specified Issuing Card object to failure.
Updates the shipping status of the specified Issuing Card object to returned.
Updates the shipping status of the specified Issuing Card object to shipped.
Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.
Updates the status of the specified testmode personalization design object to active.
Updates the status of the specified testmode personalization design object to inactive.
Updates the status of the specified testmode personalization design object to rejected.
Allows the user to capture an arbitrary amount, also known as a forced capture.
","operationId":"PostTestHelpersIssuingTransactionsCreateForceCapture","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","card"],"type":"object","properties":{"amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal)."},"card":{"maxLength":5000,"type":"string","description":"Card associated with this transaction."},"currency":{"type":"string","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).","format":"currency"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"merchant_data":{"title":"merchant_data_specs","type":"object","properties":{"category":{"maxLength":5000,"type":"string","description":"A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.","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"]},"city":{"maxLength":5000,"type":"string","description":"City where the seller is located"},"country":{"maxLength":5000,"type":"string","description":"Country where the seller is located"},"name":{"maxLength":5000,"type":"string","description":"Name of the seller"},"network_id":{"maxLength":5000,"type":"string","description":"Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code where the seller is located"},"state":{"maxLength":5000,"type":"string","description":"State where the seller is located"},"terminal_id":{"maxLength":5000,"type":"string","description":"An ID assigned by the seller to the location of the sale."},"url":{"maxLength":5000,"type":"string","description":"URL provided by the merchant on a 3DS request"}},"description":"Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.","x-stripeMostCommon":["category","city","country","name","network_id","payment_facilitator_id","postal_code","state","sub_merchant_id","terminal_id","url"]},"purchase_details":{"title":"purchase_details_specs","type":"object","properties":{"fleet":{"title":"fleet_specs","type":"object","properties":{"cardholder_prompt_data":{"title":"fleet_cardholder_prompt_data_specs","type":"object","properties":{"driver_id":{"maxLength":5000,"type":"string","description":"Driver ID."},"odometer":{"type":"integer","description":"Odometer reading."},"unspecified_id":{"maxLength":5000,"type":"string","description":"An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."},"user_id":{"maxLength":5000,"type":"string","description":"User ID."},"vehicle_number":{"maxLength":5000,"type":"string","description":"Vehicle number."}},"description":"Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.","x-stripeMostCommon":["driver_id","odometer","unspecified_id","user_id","vehicle_number"]},"purchase_type":{"maxLength":5000,"type":"string","description":"The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.","enum":["fuel_and_non_fuel_purchase","fuel_purchase","non_fuel_purchase"]},"reported_breakdown":{"title":"fleet_reported_breakdown_specs","type":"object","properties":{"fuel":{"title":"fleet_reported_breakdown_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"non_fuel":{"title":"fleet_reported_breakdown_non_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of non-fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"tax":{"title":"fleet_reported_breakdown_tax_specs","type":"object","properties":{"local_amount_decimal":{"type":"string","description":"Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"},"national_amount_decimal":{"type":"string","description":"Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"}},"description":"Information about tax included in this transaction.","x-stripeMostCommon":["local_amount_decimal","national_amount_decimal"]}},"description":"More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.","x-stripeMostCommon":["fuel","non_fuel","tax"]},"service_type":{"maxLength":5000,"type":"string","description":"The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.","enum":["full_service","non_fuel_transaction","self_service"]}},"description":"Fleet-specific information for transactions using Fleet cards.","x-stripeMostCommon":["cardholder_prompt_data","purchase_type","reported_breakdown","service_type"]},"flight":{"title":"flight_specs","type":"object","properties":{"departure_at":{"type":"integer","description":"The time that the flight departed.","format":"unix-time"},"passenger_name":{"maxLength":5000,"type":"string","description":"The name of the passenger."},"refundable":{"type":"boolean","description":"Whether the ticket is refundable."},"segments":{"type":"array","description":"The legs of the trip.","items":{"title":"flight_segment_specs","type":"object","properties":{"arrival_airport_code":{"maxLength":3,"type":"string","description":"The three-letter IATA airport code of the flight's destination."},"carrier":{"maxLength":5000,"type":"string","description":"The airline carrier code."},"departure_airport_code":{"maxLength":3,"type":"string","description":"The three-letter IATA airport code that the flight departed from."},"flight_number":{"maxLength":5000,"type":"string","description":"The flight number."},"service_class":{"maxLength":5000,"type":"string","description":"The flight's service class."},"stopover_allowed":{"type":"boolean","description":"Whether a stopover is allowed on this flight."}},"x-stripeMostCommon":["arrival_airport_code","carrier","departure_airport_code","flight_number","service_class","stopover_allowed"]}},"travel_agency":{"maxLength":5000,"type":"string","description":"The travel agency that issued the ticket."}},"description":"Information about the flight that was purchased with this transaction.","x-stripeMostCommon":["departure_at","passenger_name","refundable","segments","travel_agency"]},"fuel":{"title":"fuel_specs","type":"object","properties":{"industry_product_code":{"maxLength":5000,"type":"string","description":"[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."},"quantity_decimal":{"type":"string","description":"The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.","format":"decimal"},"type":{"maxLength":5000,"type":"string","description":"The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.","enum":["diesel","other","unleaded_plus","unleaded_regular","unleaded_super"]},"unit":{"maxLength":5000,"type":"string","description":"The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.","enum":["charging_minute","imperial_gallon","kilogram","kilowatt_hour","liter","other","pound","us_gallon"]},"unit_cost_decimal":{"type":"string","description":"The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.","format":"decimal"}},"description":"Information about fuel that was purchased with this transaction.","x-stripeMostCommon":["industry_product_code","quantity_decimal","type","unit","unit_cost_decimal"]},"lodging":{"title":"lodging_specs","type":"object","properties":{"check_in_at":{"type":"integer","description":"The time of checking into the lodging.","format":"unix-time"},"nights":{"type":"integer","description":"The number of nights stayed at the lodging."}},"description":"Information about lodging that was purchased with this transaction.","x-stripeMostCommon":["check_in_at","nights"]},"receipt":{"type":"array","description":"The line items in the purchase.","items":{"title":"receipt_specs","type":"object","properties":{"description":{"maxLength":26,"type":"string"},"quantity":{"type":"string","format":"decimal"},"total":{"type":"integer"},"unit_cost":{"type":"integer"}},"x-stripeMostCommon":["description","quantity","total","unit_cost"]}},"reference":{"maxLength":5000,"type":"string","description":"A merchant-specific order number."}},"description":"Additional purchase information that is optionally provided by the merchant.","x-stripeMostCommon":["fleet","flight","fuel","healthcare","lodging","receipt","reference"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","card","currency"]},"encoding":{"expand":{"style":"deepObject","explode":true},"merchant_data":{"style":"deepObject","explode":true},"purchase_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_test_mode_force_capture"}},"/v1/test_helpers/issuing/transactions/create_unlinked_refund":{"post":{"summary":"Create a test-mode unlinked refund","description":"Allows the user to refund an arbitrary amount, also known as a unlinked refund.
","operationId":"PostTestHelpersIssuingTransactionsCreateUnlinkedRefund","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","card"],"type":"object","properties":{"amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal)."},"card":{"maxLength":5000,"type":"string","description":"Card associated with this unlinked refund transaction."},"currency":{"type":"string","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).","format":"currency"},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"merchant_data":{"title":"merchant_data_specs","type":"object","properties":{"category":{"maxLength":5000,"type":"string","description":"A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.","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"]},"city":{"maxLength":5000,"type":"string","description":"City where the seller is located"},"country":{"maxLength":5000,"type":"string","description":"Country where the seller is located"},"name":{"maxLength":5000,"type":"string","description":"Name of the seller"},"network_id":{"maxLength":5000,"type":"string","description":"Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant."},"postal_code":{"maxLength":5000,"type":"string","description":"Postal code where the seller is located"},"state":{"maxLength":5000,"type":"string","description":"State where the seller is located"},"terminal_id":{"maxLength":5000,"type":"string","description":"An ID assigned by the seller to the location of the sale."},"url":{"maxLength":5000,"type":"string","description":"URL provided by the merchant on a 3DS request"}},"description":"Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.","x-stripeMostCommon":["category","city","country","name","network_id","payment_facilitator_id","postal_code","state","sub_merchant_id","terminal_id","url"]},"purchase_details":{"title":"purchase_details_specs","type":"object","properties":{"fleet":{"title":"fleet_specs","type":"object","properties":{"cardholder_prompt_data":{"title":"fleet_cardholder_prompt_data_specs","type":"object","properties":{"driver_id":{"maxLength":5000,"type":"string","description":"Driver ID."},"odometer":{"type":"integer","description":"Odometer reading."},"unspecified_id":{"maxLength":5000,"type":"string","description":"An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."},"user_id":{"maxLength":5000,"type":"string","description":"User ID."},"vehicle_number":{"maxLength":5000,"type":"string","description":"Vehicle number."}},"description":"Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.","x-stripeMostCommon":["driver_id","odometer","unspecified_id","user_id","vehicle_number"]},"purchase_type":{"maxLength":5000,"type":"string","description":"The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.","enum":["fuel_and_non_fuel_purchase","fuel_purchase","non_fuel_purchase"]},"reported_breakdown":{"title":"fleet_reported_breakdown_specs","type":"object","properties":{"fuel":{"title":"fleet_reported_breakdown_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"non_fuel":{"title":"fleet_reported_breakdown_non_fuel_specs","type":"object","properties":{"gross_amount_decimal":{"type":"string","description":"Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.","format":"decimal"}},"description":"Breakdown of non-fuel portion of the purchase.","x-stripeMostCommon":["gross_amount_decimal"]},"tax":{"title":"fleet_reported_breakdown_tax_specs","type":"object","properties":{"local_amount_decimal":{"type":"string","description":"Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"},"national_amount_decimal":{"type":"string","description":"Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.","format":"decimal"}},"description":"Information about tax included in this transaction.","x-stripeMostCommon":["local_amount_decimal","national_amount_decimal"]}},"description":"More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.","x-stripeMostCommon":["fuel","non_fuel","tax"]},"service_type":{"maxLength":5000,"type":"string","description":"The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.","enum":["full_service","non_fuel_transaction","self_service"]}},"description":"Fleet-specific information for transactions using Fleet cards.","x-stripeMostCommon":["cardholder_prompt_data","purchase_type","reported_breakdown","service_type"]},"flight":{"title":"flight_specs","type":"object","properties":{"departure_at":{"type":"integer","description":"The time that the flight departed.","format":"unix-time"},"passenger_name":{"maxLength":5000,"type":"string","description":"The name of the passenger."},"refundable":{"type":"boolean","description":"Whether the ticket is refundable."},"segments":{"type":"array","description":"The legs of the trip.","items":{"title":"flight_segment_specs","type":"object","properties":{"arrival_airport_code":{"maxLength":3,"type":"string","description":"The three-letter IATA airport code of the flight's destination."},"carrier":{"maxLength":5000,"type":"string","description":"The airline carrier code."},"departure_airport_code":{"maxLength":3,"type":"string","description":"The three-letter IATA airport code that the flight departed from."},"flight_number":{"maxLength":5000,"type":"string","description":"The flight number."},"service_class":{"maxLength":5000,"type":"string","description":"The flight's service class."},"stopover_allowed":{"type":"boolean","description":"Whether a stopover is allowed on this flight."}},"x-stripeMostCommon":["arrival_airport_code","carrier","departure_airport_code","flight_number","service_class","stopover_allowed"]}},"travel_agency":{"maxLength":5000,"type":"string","description":"The travel agency that issued the ticket."}},"description":"Information about the flight that was purchased with this transaction.","x-stripeMostCommon":["departure_at","passenger_name","refundable","segments","travel_agency"]},"fuel":{"title":"fuel_specs","type":"object","properties":{"industry_product_code":{"maxLength":5000,"type":"string","description":"[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."},"quantity_decimal":{"type":"string","description":"The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.","format":"decimal"},"type":{"maxLength":5000,"type":"string","description":"The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.","enum":["diesel","other","unleaded_plus","unleaded_regular","unleaded_super"]},"unit":{"maxLength":5000,"type":"string","description":"The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.","enum":["charging_minute","imperial_gallon","kilogram","kilowatt_hour","liter","other","pound","us_gallon"]},"unit_cost_decimal":{"type":"string","description":"The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.","format":"decimal"}},"description":"Information about fuel that was purchased with this transaction.","x-stripeMostCommon":["industry_product_code","quantity_decimal","type","unit","unit_cost_decimal"]},"lodging":{"title":"lodging_specs","type":"object","properties":{"check_in_at":{"type":"integer","description":"The time of checking into the lodging.","format":"unix-time"},"nights":{"type":"integer","description":"The number of nights stayed at the lodging."}},"description":"Information about lodging that was purchased with this transaction.","x-stripeMostCommon":["check_in_at","nights"]},"receipt":{"type":"array","description":"The line items in the purchase.","items":{"title":"receipt_specs","type":"object","properties":{"description":{"maxLength":26,"type":"string"},"quantity":{"type":"string","format":"decimal"},"total":{"type":"integer"},"unit_cost":{"type":"integer"}},"x-stripeMostCommon":["description","quantity","total","unit_cost"]}},"reference":{"maxLength":5000,"type":"string","description":"A merchant-specific order number."}},"description":"Additional purchase information that is optionally provided by the merchant.","x-stripeMostCommon":["fleet","flight","fuel","healthcare","lodging","receipt","reference"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","card","currency"]},"encoding":{"expand":{"style":"deepObject","explode":true},"merchant_data":{"style":"deepObject","explode":true},"purchase_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_test_mode_unlinked_refund"}},"/v1/test_helpers/issuing/transactions/{transaction}/refund":{"post":{"summary":"Refund a test-mode transaction","description":"Refund a test-mode Transaction.
","operationId":"PostTestHelpersIssuingTransactionsTransactionRefund","parameters":[{"name":"transaction","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"refund_amount":{"type":"integer","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://docs.stripe.com/currencies#zero-decimal)."}},"additionalProperties":false,"x-stripeMostCommon":["refund_amount"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/issuing.transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"refund_test_mode_issuing_transaction"}},"/v1/test_helpers/refunds/{refund}/expire":{"post":{"summary":"Expire a pending refund.","description":"Expire a refund with a status of requires_action.
Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration
","operationId":"PostTestHelpersSharedPaymentGrantedTokens","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["payment_method","usage_limits"],"type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"The Customer that the SharedPaymentGrantedToken belongs to. Should match the Customer that the PaymentMethod is attached to if any."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"payment_method":{"maxLength":5000,"type":"string","description":"The PaymentMethod that is going to be shared by the SharedPaymentGrantedToken."},"shared_metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to the SharedPaymentGrantedToken.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"usage_limits":{"title":"usage_limits_param","required":["currency","max_amount"],"type":"object","properties":{"currency":{"type":"string","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).","format":"currency"},"expires_at":{"type":"integer","description":"Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.","format":"unix-time"},"max_amount":{"type":"integer","description":"Max amount that can be captured using this SharedPaymentToken"}},"description":"Limits on how this SharedPaymentGrantedToken can be used.","x-stripeMostCommon":["currency","expires_at","max_amount","recurring","recurring_interval"]}},"additionalProperties":false,"x-stripeMostCommon":["customer","payment_method","shared_metadata","usage_limits"]},"encoding":{"expand":{"style":"deepObject","explode":true},"shared_metadata":{"style":"deepObject","explode":true},"usage_limits":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shared_payment.granted_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"shared_payment_granted_token_test_create_method"}},"/v1/test_helpers/shared_payment/granted_tokens/{shared_payment_granted_token}/revoke":{"post":{"summary":"Revoke a test SharedPaymentGrantedToken","description":"Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration
","operationId":"PostTestHelpersSharedPaymentGrantedTokensSharedPaymentGrantedTokenRevoke","parameters":[{"name":"shared_payment_granted_token","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/shared_payment.granted_token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"shared_payment_granted_token_test_revoke_method"}},"/v1/test_helpers/terminal/readers/{reader}/present_payment_method":{"post":{"summary":"Simulate presenting a payment method","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":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount_tip":{"type":"integer","description":"Simulated on-reader tip amount."},"card":{"title":"card","required":["exp_month","exp_year","number"],"type":"object","properties":{"cvc":{"maxLength":5000,"type":"string","description":"Card security code."},"exp_month":{"type":"integer","description":"Two-digit number representing the card's expiration month."},"exp_year":{"type":"integer","description":"Two- or four-digit number representing the card's expiration year."},"number":{"maxLength":5000,"type":"string","description":"The card number, as a string without any separators."}},"description":"Simulated data for the card payment method.","x-stripeMostCommon":["cvc","exp_month","exp_year","number"]},"card_present":{"title":"card_present","type":"object","properties":{"number":{"maxLength":5000,"type":"string","description":"The card number, as a string without any separators."}},"description":"Simulated data for the card_present payment method.","x-stripeMostCommon":["number"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"interac_present":{"title":"interac_present","type":"object","properties":{"number":{"maxLength":5000,"type":"string","description":"The Interac card number."}},"description":"Simulated data for the interac_present payment method.","x-stripeMostCommon":["number"]},"type":{"type":"string","description":"Simulated payment type.","enum":["card","card_present","interac_present"],"x-stripeBypassValidation":true}},"additionalProperties":false,"x-stripeMostCommon":["card_present","type"]},"encoding":{"card":{"style":"deepObject","explode":true},"card_present":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"interac_present":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"present_terminal_payment_method"}},"/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection":{"post":{"summary":"Simulate a successful input collection","description":"Use this endpoint to trigger a successful input collection on a simulated reader.
","operationId":"PostTestHelpersTerminalReadersReaderSucceedInputCollection","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"skip_non_required_inputs":{"type":"string","description":"This parameter defines the skip behavior for input collection.","enum":["all","none"]}},"additionalProperties":false,"x-stripeMostCommon":["skip_non_required_inputs"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"succeed_terminal_input_collection"}},"/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection":{"post":{"summary":"Simulate an input collection timeout","description":"Use this endpoint to complete an input collection with a timeout error on a simulated reader.
","operationId":"PostTestHelpersTerminalReadersReaderTimeoutInputCollection","parameters":[{"name":"reader","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal.reader"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"timeout_terminal_input_collection"}},"/v1/test_helpers/test_clocks":{"get":{"summary":"List all test clocks","description":"Returns a list of your test clocks.
","operationId":"GetTestHelpersTestClocks","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"BillingClocksResourceBillingClockList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/test_helpers.test_clock"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/test_helpers/test_clocks","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_test_clocks"},"post":{"summary":"Create a test clock","description":"Creates a new test clock that can be attached to new customers and quotes.
","operationId":"PostTestHelpersTestClocks","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["frozen_time"],"type":"object","properties":{"customer":{"maxLength":5000,"type":"string","description":"Existing customer this test clock will be attached to. Once attached, customers can't be removed from a test clock."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"frozen_time":{"type":"integer","description":"The initial frozen time for this test clock.","format":"unix-time"},"name":{"maxLength":300,"type":"string","description":"The name for this test clock."}},"additionalProperties":false,"x-stripeMostCommon":["frozen_time","name"]},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/test_helpers.test_clock"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_test_clock"}},"/v1/test_helpers/test_clocks/{test_clock}":{"get":{"summary":"Retrieve a test clock","description":"Retrieves a test clock.
","operationId":"GetTestHelpersTestClocksTestClock","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"test_clock","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/test_helpers.test_clock"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_test_clock"},"delete":{"summary":"Delete a test clock","description":"Deletes a test clock.
","operationId":"DeleteTestHelpersTestClocksTestClock","parameters":[{"name":"test_clock","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_test_helpers.test_clock"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_test_clock"}},"/v1/test_helpers/test_clocks/{test_clock}/advance":{"post":{"summary":"Advance a test clock","description":"Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.
Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
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":{"schema":{"required":["amount","currency","financial_account","network"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount (in cents) to be transferred."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"financial_account":{"type":"string","description":"The FinancialAccount to send funds to."},"initiating_payment_method_details":{"title":"source_params","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The source type.","enum":["us_bank_account"]},"us_bank_account":{"title":"us_bank_account_source_params","type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The bank account holder's name."},"account_number":{"maxLength":5000,"type":"string","description":"The bank account number."},"routing_number":{"maxLength":5000,"type":"string","description":"The bank account's routing number."}},"description":"Optional fields for `us_bank_account`.","x-stripeMostCommon":["account_holder_name","account_number","routing_number"]}},"description":"Initiating payment method details for the object.","x-stripeMostCommon":["type","us_bank_account"]},"network":{"type":"string","description":"Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.","enum":["ach","rtp","us_domestic_wire"]},"network_details":{"title":"network_details_source","required":["type"],"type":"object","properties":{"ach":{"title":"ach_network_details_source","type":"object","properties":{"addenda":{"maxLength":5000,"type":"string","description":"ACH Addenda record"}},"description":"Optional fields for `ach`.","x-stripeMostCommon":["addenda"]},"type":{"type":"string","description":"The type of flow that originated the ReceivedCredit.","enum":["ach"]}},"description":"Details about the network used for the ReceivedCredit.","x-stripeMostCommon":["ach","type"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","financial_account","initiating_payment_method_details","network","network_details"]},"encoding":{"expand":{"style":"deepObject","explode":true},"initiating_payment_method_details":{"style":"deepObject","explode":true},"network_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.received_credit"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"testmode_create_treasury_received_credit"}},"/v1/test_helpers/treasury/received_debits":{"post":{"summary":"Test mode: Create a ReceivedDebit","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":{"schema":{"required":["amount","currency","financial_account","network"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount (in cents) to be transferred."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"financial_account":{"type":"string","description":"The FinancialAccount to pull funds from."},"initiating_payment_method_details":{"title":"source_params","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The source type.","enum":["us_bank_account"]},"us_bank_account":{"title":"us_bank_account_source_params","type":"object","properties":{"account_holder_name":{"maxLength":5000,"type":"string","description":"The bank account holder's name."},"account_number":{"maxLength":5000,"type":"string","description":"The bank account number."},"routing_number":{"maxLength":5000,"type":"string","description":"The bank account's routing number."}},"description":"Optional fields for `us_bank_account`.","x-stripeMostCommon":["account_holder_name","account_number","routing_number"]}},"description":"Initiating payment method details for the object.","x-stripeMostCommon":["type","us_bank_account"]},"network":{"type":"string","description":"Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.","enum":["ach"]},"network_details":{"title":"network_details_source","required":["type"],"type":"object","properties":{"ach":{"title":"ach_network_details_source","type":"object","properties":{"addenda":{"maxLength":5000,"type":"string","description":"Addenda record data associated with this ReceivedDebit."}},"description":"Optional fields for `ach`.","x-stripeMostCommon":["addenda"]},"type":{"type":"string","description":"The type of flow that originated the ReceivedDebit.","enum":["ach"]}},"description":"Details about the network used for the ReceivedDebit.","x-stripeMostCommon":["ach","type"]}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","financial_account","initiating_payment_method_details","network","network_details"]},"encoding":{"expand":{"style":"deepObject","explode":true},"initiating_payment_method_details":{"style":"deepObject","explode":true},"network_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.received_debit"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"testmode_create_treasury_received_debit"}},"/v1/three_d_secure/authentications":{"get":{"summary":"List all 3D Secure Authentications","description":"Returns a list of 3D Secure Authentications.
","operationId":"GetThreeDSecureAuthentications","parameters":[{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return 3D Secure Authentications for specified status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","error","failed","requires_challenge","requires_submission","succeeded"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"ThreeDSecureStandaloneResourceThreeDSecureAuthenticationList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/three_d_secure.authentication"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/three_d_secure/authentications","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"three_d_secure_authentication_all"},"post":{"summary":"Create a 3DS Authentication","description":"This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.
\n\nYou can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.
","operationId":"PostThreeDSecureAuthentications","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["channel","message_category"],"type":"object","properties":{"acquirer_details":{"title":"acquirer_details","required":["acquirer_bin","acquirer_country","acquirer_merchant_id"],"type":"object","properties":{"acquirer_bin":{"maxLength":11,"type":"string","description":"The Acquirer BIN (specific to the directory_server)."},"acquirer_country":{"maxLength":5000,"type":"string","description":"The two-letter country code of the acquirer ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"acquirer_merchant_id":{"maxLength":35,"type":"string","description":"The Merchant ID (or Card Acceptor ID) that your acquirer assigned you (specific to the directory_server)."},"mcc":{"maxLength":5000,"type":"string","description":"The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) as defined by each payment system or directory server."},"merchant_name":{"maxLength":40,"type":"string","description":"The merchant name assigned by the acquirer or payment system. Same name used in the authorization message as defined in [ISO 8583](https://en.wikipedia.org/wiki/ISO_8583)."},"requestor_id":{"maxLength":35,"type":"string","description":"Requestor ID if you’re enrolled in the card network’s 3DS program. Otherwise, you can omit this field because Stripe assigns a Requestor ID with the card networks."}},"description":"Contains additional details about the acquirer for this 3DS Authentication.\n\nRefer to the [Pass acquirer details and directory server section of the standalone 3DS guide](/payments/3d-secure/standalone-3d-secure#pass-acquirer-details-and-directory-server) for more information.","x-stripeMostCommon":["acquirer_bin","acquirer_country","acquirer_merchant_id","mcc","merchant_name","requestor_id"]},"amount":{"type":"integer","description":"A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). You can't include this parameter if `message_category` is `non_payment_authentication`"},"channel":{"title":"channel","required":["type"],"type":"object","properties":{"browser":{"title":"browser","required":["accept_header","ip_address","javascript_enabled","language","user_agent"],"type":"object","properties":{"accept_header":{"maxLength":2048,"type":"string","description":"The HTTP accept headers from the cardholder's browser. Collected server-side."},"color_depth":{"type":"integer","description":"The color depth of the cardholder’s screen.\n\nReturned from the `screen.colorDepth` property."},"device_id":{"maxLength":64,"type":"string","description":"Unique and immutable identifier linked to a device that is consistent across 3DS transactions for the specific user device. For example: hardware device ID or a platform-calculated device fingerprint."},"ip_address":{"maxLength":45,"type":"string","description":"The IP address of the browser. Included in the HTTP request to your server before you create the 3DS Authentication.\n\nCollected server-side."},"java_enabled":{"type":"boolean","description":"The cardholder browser’s ability to execute Java. Returned from the navigator.javaEnabled property."},"javascript_enabled":{"type":"boolean","description":"The cardholder browser’s ability to execute JavaScript."},"language":{"maxLength":35,"type":"string","description":"An IETF BCP 47 language tag representing the browser language. Typically returned from the `navigator.language` property, but might also be returned from `navigator.languages` or `navigator.browserLanguage`.\n\n In some cases, this value might be an array. To cast it to a string or null value, you can use the `getBrowserLanguage()` [example function](/payments/3d-secure/standalone-3d-secure#pass-client-side-collected-channel-information)."},"screen_height":{"type":"integer","description":"The total height of the cardholder’s screen in pixels.\n\nReturned from the `screen.height` property."},"screen_width":{"type":"integer","description":"The total width of the cardholder’s screen in pixels.\n\nReturned from the `screen.width` property."},"timezone_offset":{"type":"integer","description":"The time difference between UTC time and the local time of the cardholder’s browser, in minutes.\n\nReturned by `new Date().getTimezoneOffset()`"},"user_agent":{"maxLength":2048,"type":"string","description":"The browser user agent. You can retrieve this value on the client side using the `navigator.userAgent` property, or in the HTTP request to your server before you create the 3DS Authentication."}},"description":"Contains additional details about the browser details you collected.","x-stripeMostCommon":["accept_header","color_depth","device_id","ip_address","java_enabled","javascript_enabled","language","screen_height","screen_width","timezone_offset","user_agent"]},"three_r_i":{"title":"three_ri","required":["previous_authentication","type"],"type":"object","properties":{"previous_authentication":{"maxLength":5000,"type":"string","description":"ID of a prior `Authentication`. For example, the first recurring transaction that was authenticated by the cardholder."},"type":{"type":"string","description":"It provides additional information to the ACS to determine the best approach for handling a 3RI request.","enum":["delayed_shipment","other_payment","recurring","split_shipment"]}},"description":"Contains additional details about the 3DS Requestor Initiated (3RI) channel.","x-stripeMostCommon":["previous_authentication","type"]},"type":{"type":"string","description":"Type of channel you would prefer to use for this 3DS Authentication.","enum":["browser","three_r_i"]}},"description":"Contains additional details on the channel used for this 3DS Authentication.","x-stripeMostCommon":["browser","three_r_i","type"]},"currency":{"type":"string","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).","format":"currency"},"directory_server":{"type":"string","description":"The 3DS directory server with which this 3DS Authentication was processed.","enum":["american_express","cartes_bancaires","discover","mastercard","visa"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"flow_preference":{"title":"flow_preference","required":["type"],"type":"object","properties":{"challenge":{"title":"challenge","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Type of challenge flow you requested for this 3DS Authentication.","enum":["mandated","preferred"]}},"description":"Contains additional details about your challenge flow preference for this 3DS Authentication.","x-stripeMostCommon":["type"]},"data_share":{"title":"data_share","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Type of data share only flow you requested for this 3DS Authentication.","enum":["ds_specific","emv_standard"]}},"description":"Contains additional details about your data share only flow preference for this 3DS Authentication.","x-stripeMostCommon":["type"]},"frictionless":{"title":"frictionless","required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Type of frictionless flow you requested for this 3DS Authentication.","enum":["low_risk","none"]}},"description":"Contains additional details about your frictionless flow preference for this 3DS Authentication.","x-stripeMostCommon":["type"]},"type":{"type":"string","description":"Type of flow you requested for this 3DS Authentication.","enum":["challenge","data_share","frictionless"]}},"description":"Contains additional details on your flow preference for this 3DS Authentication.\n\nRefer to the [Specify a flow preference section of the standalone 3DS guide](/payments/3d-secure/standalone-3d-secure#specify-a-flow-preference) for more information.","x-stripeMostCommon":["challenge","data_share","frictionless","type"]},"future_usage":{"title":"future_usage","required":["type"],"type":"object","properties":{"installment":{"title":"installment","required":["amount","expiry","number"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer representing the future authorizations' amount in the [smallest currency unit](/currencies#zero-decimal)."},"expiry":{"title":"expiry","required":["type"],"type":"object","properties":{"date":{"maxLength":5000,"type":"string","description":"The date before which the last authorization related to this authentication will occur."},"type":{"type":"string","description":"The type of expiry for the future use of this authentication.","enum":["date","never"]}},"description":"Information about the expiry of the future usage of this authentication.","x-stripeMostCommon":["date","type"]},"interval":{"type":"string","description":"The unit of time for `interval_count`.","enum":["day"]},"interval_count":{"type":"integer","description":"The minimum number of time intervals between authorizations. Must be greater than 0, and defaults to 1."},"number":{"type":"integer","description":"The maximum number of installments. Must be greater than 1."}},"description":"Parameters related to an installment payment.","x-stripeMostCommon":["amount","expiry","interval","interval_count","number"]},"recurring":{"title":"recurring","required":["amount","expiry"],"type":"object","properties":{"amount":{"type":"integer","description":"A non-negative integer representing the future authorizations' amount in the [smallest currency unit](/currencies#zero-decimal)."},"expiry":{"title":"expiry","required":["type"],"type":"object","properties":{"date":{"maxLength":5000,"type":"string","description":"The date before which the last authorization related to this authentication will occur."},"type":{"type":"string","description":"The type of expiry for the future use of this authentication.","enum":["date","never"]}},"description":"Information about the expiry of the future usage of this authentication.","x-stripeMostCommon":["date","type"]},"interval":{"type":"string","description":"The unit of time for `interval_count`.","enum":["day"]},"interval_count":{"type":"integer","description":"The minimum number of time intervals between authorizations. Must be greater than 0, and defaults to 1."}},"description":"Parameters related to a recurring payment.","x-stripeMostCommon":["amount","expiry","interval","interval_count"]},"type":{"type":"string","description":"The type of future usage declared for this 3DS Authentication","enum":["card_on_file","installment","recurring"]}},"description":"Contains information about future usage of this 3DS Authentication","x-stripeMostCommon":["installment","recurring","type"]},"message_category":{"type":"string","description":"Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.","enum":["non_payment_authentication","payment_authentication"]},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment_method":{"maxLength":255,"type":"string","description":"ID of the payment method (a PaymentMethod object) to attach to this 3DS Authentication."},"payment_method_data":{"title":"payment_method_data","required":["card","type"],"type":"object","properties":{"billing_details":{"title":"billing_details","type":"object","properties":{"address":{"title":"address","type":"object","properties":{"city":{"maxLength":50,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":50,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":50,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":16,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":3,"type":"string","description":"Country subdivision code defined in ISO 3166-2."}},"description":"Billing address.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"email":{"type":"string","description":"Email address."},"name":{"maxLength":5000,"type":"string","description":"Full name."},"phone":{"type":"string","description":"Billing phone number (including extension)."}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone"]},"card":{"anyOf":[{"title":"card","required":["exp_month","exp_year","number"],"type":"object","properties":{"cvc":{"maxLength":5000,"type":"string"},"exp_month":{"type":"integer"},"exp_year":{"type":"integer"},"number":{"maxLength":5000,"type":"string"}},"x-stripeMostCommon":["cvc","exp_month","exp_year","number"],"x-stripeParam":{"class_name":"CardDetails"}},{"title":"card_token","required":["token"],"type":"object","properties":{"token":{"maxLength":5000,"type":"string"}},"x-stripeMostCommon":["token"],"x-stripeParam":{"class_name":"Token"}}]},"type":{"type":"string","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":["card"]}},"description":"Hash used to generate the PaymentMethod to be used for this Authentication. This is mutually exclusive with the `payment_method` parameter.","x-stripeMostCommon":["billing_details","card","encrypted","type"]},"reason":{"type":"string","description":"The reason for invoking standalone 3DS. This is tailored specifically for cases when you want Stripe to help determine the standalone 3DS flow to fit your use case instead of needing to select a specific 3DS flow.\n\nThis parameter is exclusive with `flow_preference`. You can either use `reason` for controlling 3DS according to your business requirements, or use `flow_preference` for having fine-grained control over your 3DS flow preference.","enum":["cardholder_authentication","issuer_requested","liability_shift","processing_costs","regulatory_compliance"],"x-stripeEnum":{"kind":"open","values":[{"description":"The authentication is performed to attempt to require the cardholder to actively complete a challenge.","value":"cardholder_authentication"},{"description":"The authentication is performed when the issuer soft declines the transaction. This option should be used when you have tried authorization without 3DS authentication and the bank responded in a soft decline. Stripe will then trigger 3DS, post which you can retry authorization with the issuer.","value":"issuer_requested"},{"description":"The authentication is performed to try to shift liability away from the merchant and onto the issuer to reduce the cost implications from disputes.\n\n**Note**: If you don't select `liability_shift` as your reason, the 3DS flow won't prioritize liability shift as a desired outcome. And even when `liability_shift` is selected, liability shift is not guaranteed, since that decision is made by the network and not Stripe([source](/payments/3d-secure/authentication-flow#disputed-payments)).","value":"liability_shift"},{"description":"The authentication is performed to optimize payments processing cost.","value":"processing_costs"},{"description":"The authentication is performed solely to enable compliance with local regulations such as SCA (Strong Customer Authentication). Use this option when your sole requirement is compliance with local regulations, such as SCA or other 3DS-related mandates. The authentication will be performed only as necessary for compliance purposes.\n\n**Note:** This `reason` parameter value will always apply even when you do not choose this value explicitly.","value":"regulatory_compliance"}]}},"shipping_address":{"title":"address","type":"object","properties":{"city":{"maxLength":50,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":50,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":50,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":16,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":3,"type":"string","description":"Country subdivision code defined in ISO 3166-2."}},"description":"The shipping address requested by the cardholder. You should try to include as complete address information as possible.","x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},"submit":{"type":"string","description":"Set to `always` to skip the fingerprinting step and submit this Authentication immediately or `if_fingerprinting_not_supported` to submit this Authentication only if fingerprinting is not available. This parameter defaults to `never`.\n\nRefer to the [Submit at creation section of the standalone 3DS guide](/payments/3d-secure/standalone-3d-secure#submit-at-creation) for more information.","enum":["always","if_fingerprinting_not_supported","never"]}},"additionalProperties":false,"x-stripeMostCommon":["acquirer_details","amount","channel","currency","directory_server","flow_preference","future_usage","message_category","metadata","payment_method","payment_method_data","reason","shipping_address","submit"]},"encoding":{"acquirer_details":{"style":"deepObject","explode":true},"channel":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"flow_preference":{"style":"deepObject","explode":true},"future_usage":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_method_data":{"style":"deepObject","explode":true},"shipping_address":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/three_d_secure.authentication"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"three_d_secure_authentication_create"}},"/v1/three_d_secure/authentications/{authentication}":{"get":{"summary":"Retrieve a 3DS Authentication","description":"This endpoint retrieves a 3DS Authentication.
","operationId":"GetThreeDSecureAuthenticationsAuthentication","parameters":[{"name":"authentication","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/three_d_secure.authentication"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"three_d_secure_authentication_retrieve"}},"/v1/three_d_secure/authentications/{authentication}/cancel":{"post":{"summary":"Cancel a 3DS Authentication","description":"This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status:\nrequires_submission or requires_challenge.
This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.
Creates a single-use token that represents a bank account’s details.\nYou can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.
Retrieves the token with the given ID.
","operationId":"GetTokensToken","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"token","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/token"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_token"}},"/v1/topups":{"get":{"summary":"List all top-ups","description":"Returns a list of top-ups.
","operationId":"GetTopups","parameters":[{"name":"amount","in":"query","description":"A positive integer representing how much to transfer.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"created","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string","enum":["canceled","failed","pending","succeeded"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TopupList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/topup"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/topups","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_topups"},"post":{"summary":"Create a top-up","description":"Top up the balance of an account
","operationId":"PostTopups","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","currency"],"type":"object","properties":{"amount":{"type":"integer","description":"A positive integer representing how much to transfer."},"currency":{"type":"string","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)."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"payment_method":{"maxLength":5000,"type":"string","description":"The ID of a PaymentMethod representing the payment method to be used for the top-up. A PaymentMethod of type `us_bank_account` can be used."},"payment_method_options":{"title":"payment_method_options_param","type":"object","properties":{"us_bank_account":{"title":"us_bank_account_param","required":["network"],"type":"object","properties":{"network":{"type":"string","enum":["ach"],"x-stripeBypassValidation":true}},"x-stripeMostCommon":["network"]}},"description":"Payment method-specific configuration for this top-up.","x-stripeMostCommon":["us_bank_account"]},"source":{"maxLength":5000,"type":"string","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. While testing, this can be a test bank token (see [Testing Top-ups](https://docs.stripe.com/connect/testing#testing-top-ups))."},"statement_descriptor":{"maxLength":15,"type":"string","description":"Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters."},"transfer_group":{"type":"string","description":"A string that identifies this top-up as part of a group."}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"payment_method_options":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topup"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_topup"}},"/v1/topups/{topup}":{"get":{"summary":"Retrieve a top-up","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"topup","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topup"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_topup"},"post":{"summary":"Update a top-up","description":"Updates the metadata of a top-up. Other top-up details are not editable by design.
","operationId":"PostTopupsTopup","parameters":[{"name":"topup","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["description","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topup"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_topup"}},"/v1/topups/{topup}/cancel":{"post":{"summary":"Cancel a top-up","description":"Cancels a top-up. Only pending top-ups can be canceled.
","operationId":"PostTopupsTopupCancel","parameters":[{"name":"topup","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topup"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_connect_topup"}},"/v1/transfers":{"get":{"summary":"List all transfers","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":[{"name":"created","in":"query","description":"Only return transfers that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]},"x-stripeLessCommon":true},{"name":"destination","in":"query","description":"Only return transfers for the destination specified by this account ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"transfer_group","in":"query","description":"Only return transfers with the specified transfer group.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TransferList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/transfer"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/transfers","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_connect_transfers"},"post":{"summary":"Create a transfer","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":{"schema":{"required":["currency","destination"],"type":"object","properties":{"amount":{"type":"integer","description":"A positive integer in cents (or local equivalent) representing how much to transfer."},"currency":{"type":"string","description":"Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"destination":{"type":"string","description":"The ID of a connected Stripe account. See the Connect documentation for details."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"fx_quote":{"maxLength":5000,"type":"string","description":"The FX rate in the quote is validated and used to convert the transfer amount to the destination currency."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_transaction":{"type":"string","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://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability) for details."},"source_type":{"maxLength":5000,"type":"string","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"],"x-stripeBypassValidation":true},"transfer_group":{"type":"string","description":"A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details."}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","destination","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_transfer"}},"/v1/transfers/{id}/reversals":{"get":{"summary":"List all reversals","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.
When you create a new reversal, you must specify a transfer to create it on.
\n\nWhen 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.
\n\nOnce 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":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"amount":{"type":"integer","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."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]},"refund_application_fee":{"type":"boolean","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."}},"additionalProperties":false,"x-stripeMostCommon":["amount","description","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_connect_transfer_reversal"}},"/v1/transfers/{transfer}":{"get":{"summary":"Retrieve a transfer","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_transfer"},"post":{"summary":"Update a transfer","description":"Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n\nThis request accepts only metadata as an argument.
","operationId":"PostTransfersTransfer","parameters":[{"name":"transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["description","metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_transfer"}},"/v1/transfers/{transfer}/reversals/{id}":{"get":{"summary":"Retrieve a reversal","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_connect_transfer_reversal"},"post":{"summary":"Update a reversal","description":"Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n\nThis request only accepts metadata and description as arguments.
","operationId":"PostTransfersTransferReversalsId","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.","anyOf":[{"type":"object","additionalProperties":{"type":"string"}},{"type":"string","enum":[""]}]}},"additionalProperties":false,"x-stripeMostCommon":["metadata"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_connect_transfer_reversal"}},"/v1/treasury/credit_reversals":{"get":{"summary":"List all CreditReversals","description":"Returns a list of CreditReversals.
","operationId":"GetTreasuryCreditReversals","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"received_credit","in":"query","description":"Only return CreditReversals for the ReceivedCredit ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return CreditReversals for a given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","posted","processing"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryReceivedCreditsResourceCreditReversalList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.credit_reversal"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_credit_reversals"},"post":{"summary":"Create a CreditReversal","description":"Reverses a ReceivedCredit and creates a CreditReversal object.
","operationId":"PostTreasuryCreditReversals","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["received_credit"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"received_credit":{"maxLength":5000,"type":"string","description":"The ReceivedCredit to reverse."}},"additionalProperties":false,"x-stripeMostCommon":["metadata","received_credit"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.credit_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_treasury_credit_reversal"}},"/v1/treasury/credit_reversals/{credit_reversal}":{"get":{"summary":"Retrieve a CreditReversal","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":[{"name":"credit_reversal","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.credit_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_credit_reversal"}},"/v1/treasury/debit_reversals":{"get":{"summary":"List all DebitReversals","description":"Returns a list of DebitReversals.
","operationId":"GetTreasuryDebitReversals","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"received_debit","in":"query","description":"Only return DebitReversals for the ReceivedDebit ID.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"resolution","in":"query","description":"Only return DebitReversals for a given resolution.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["lost","won"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return DebitReversals for a given status.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","completed","processing"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryReceivedDebitsResourceDebitReversalList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.debit_reversal"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_debit_reversals"},"post":{"summary":"Create a DebitReversal","description":"Reverses a ReceivedDebit and creates a DebitReversal object.
","operationId":"PostTreasuryDebitReversals","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["received_debit"],"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"received_debit":{"maxLength":5000,"type":"string","description":"The ReceivedDebit to reverse."}},"additionalProperties":false,"x-stripeMostCommon":["metadata","received_debit"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.debit_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_treasury_debit_reversal"}},"/v1/treasury/debit_reversals/{debit_reversal}":{"get":{"summary":"Retrieve a DebitReversal","description":"Retrieves a DebitReversal object.
","operationId":"GetTreasuryDebitReversalsDebitReversal","parameters":[{"name":"debit_reversal","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.debit_reversal"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_debit_reversal"}},"/v1/treasury/financial_accounts":{"get":{"summary":"List all FinancialAccounts","description":"Returns a list of FinancialAccounts.
","operationId":"GetTreasuryFinancialAccounts","parameters":[{"name":"created","in":"query","description":"Only return FinancialAccounts that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","description":"An object ID cursor for use in pagination.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit ranging from 1 to 100 (defaults to 10).","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","description":"An object ID cursor for use in pagination.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return FinancialAccounts that have the given status: `open` or `closed`","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["closed","open"],"x-stripeBypassValidation":true},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryFinancialAccountsResourceFinancialAccountList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/treasury.financial_account"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/treasury/financial_accounts","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_financial_accounts"},"post":{"summary":"Create a FinancialAccount","description":"Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.
","operationId":"PostTreasuryFinancialAccounts","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["supported_currencies"],"type":"object","properties":{"display_name":{"description":"The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"features":{"title":"feature_access","type":"object","properties":{"card_issuing":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.","x-stripeMostCommon":["requested"]},"deposit_insurance":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.","x-stripeMostCommon":["requested"]},"financial_addresses":{"title":"financial_addresses","type":"object","properties":{"aba":{"title":"aba_access","required":["requested"],"type":"object","properties":{"bank":{"type":"string","description":"Requested bank partner","enum":["evolve","fifth_third","goldman_sachs"]},"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Adds an ABA FinancialAddress to the FinancialAccount.","x-stripeMostCommon":["bank","forwarding","requested"]}},"description":"Contains Features that add FinancialAddresses to the FinancialAccount.","x-stripeMostCommon":["aba"]},"inbound_transfers":{"title":"inbound_transfers","type":"object","properties":{"ach":{"title":"access_with_ach_details_inbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH Debits via the InboundTransfers API.","x-stripeMostCommon":["platform_review","requested","same_day"]}},"description":"Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.","x-stripeMostCommon":["ach","us_check"]},"intra_stripe_flows":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).","x-stripeMostCommon":["requested"]},"outbound_payments":{"title":"outbound_payments","type":"object","properties":{"ach":{"title":"access_with_ach_details_outbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH transfers via the OutboundPayments API.","x-stripeMostCommon":["requested","same_day"]},"us_domestic_wire":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables US domestic wire transfers via the OutboundPayments API.","x-stripeMostCommon":["requested"]}},"description":"Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.","x-stripeMostCommon":["ach","us_check","us_domestic_wire"]},"outbound_transfers":{"title":"outbound_transfers","type":"object","properties":{"ach":{"title":"access_with_ach_details_outbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH transfers via the OutboundTransfers API.","x-stripeMostCommon":["requested","same_day"]},"us_domestic_wire":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables US domestic wire transfers via the OutboundTransfers API.","x-stripeMostCommon":["requested"]}},"description":"Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.","x-stripeMostCommon":["ach","us_domestic_wire"]}},"description":"Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.","x-stripeMostCommon":["card_issuing","deposit_insurance","financial_addresses","inbound_transfers","intra_stripe_flows","outbound_payments","outbound_transfers"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":"The nickname for the FinancialAccount.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"platform_restrictions":{"title":"platform_restrictions","type":"object","properties":{"inbound_flows":{"type":"string","description":"Restricts all inbound money movement.","enum":["restricted","unrestricted"]},"outbound_flows":{"type":"string","description":"Restricts all outbound money movement.","enum":["restricted","unrestricted"]}},"description":"The set of functionalities that the platform can restrict on the FinancialAccount.","x-stripeMostCommon":["inbound_flows","outbound_flows","received_credits","received_debits"]},"supported_currencies":{"type":"array","description":"The currencies the FinancialAccount can hold a balance in.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false,"x-stripeMostCommon":["display_name","features","metadata","nickname","platform_restrictions","supported_currencies"]},"encoding":{"display_name":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"features":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"nickname":{"style":"deepObject","explode":true},"platform_restrictions":{"style":"deepObject","explode":true},"supported_currencies":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.financial_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_treasury_financial_account"}},"/v1/treasury/financial_accounts/{financial_account}":{"get":{"summary":"Retrieve a FinancialAccount","description":"Retrieves the details of a FinancialAccount.
","operationId":"GetTreasuryFinancialAccountsFinancialAccount","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.financial_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_financial_account"},"post":{"summary":"Update a FinancialAccount","description":"Updates the details of a FinancialAccount.
","operationId":"PostTreasuryFinancialAccountsFinancialAccount","parameters":[{"name":"financial_account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"display_name":{"description":"The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"features":{"title":"feature_access","type":"object","properties":{"card_issuing":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.","x-stripeMostCommon":["requested"]},"deposit_insurance":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.","x-stripeMostCommon":["requested"]},"financial_addresses":{"title":"financial_addresses","type":"object","properties":{"aba":{"title":"aba_access","required":["requested"],"type":"object","properties":{"bank":{"type":"string","description":"Requested bank partner","enum":["evolve","fifth_third","goldman_sachs"]},"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Adds an ABA FinancialAddress to the FinancialAccount.","x-stripeMostCommon":["bank","forwarding","requested"]}},"description":"Contains Features that add FinancialAddresses to the FinancialAccount.","x-stripeMostCommon":["aba"]},"inbound_transfers":{"title":"inbound_transfers","type":"object","properties":{"ach":{"title":"access_with_ach_details_inbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH Debits via the InboundTransfers API.","x-stripeMostCommon":["platform_review","requested","same_day"]}},"description":"Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.","x-stripeMostCommon":["ach","us_check"]},"intra_stripe_flows":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).","x-stripeMostCommon":["requested"]},"outbound_payments":{"title":"outbound_payments","type":"object","properties":{"ach":{"title":"access_with_ach_details_outbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH transfers via the OutboundPayments API.","x-stripeMostCommon":["requested","same_day"]},"us_domestic_wire":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables US domestic wire transfers via the OutboundPayments API.","x-stripeMostCommon":["requested"]}},"description":"Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.","x-stripeMostCommon":["ach","us_check","us_domestic_wire"]},"outbound_transfers":{"title":"outbound_transfers","type":"object","properties":{"ach":{"title":"access_with_ach_details_outbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH transfers via the OutboundTransfers API.","x-stripeMostCommon":["requested","same_day"]},"us_domestic_wire":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables US domestic wire transfers via the OutboundTransfers API.","x-stripeMostCommon":["requested"]}},"description":"Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.","x-stripeMostCommon":["ach","us_domestic_wire"]}},"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.","x-stripeMostCommon":["card_issuing","deposit_insurance","financial_addresses","inbound_transfers","intra_stripe_flows","outbound_payments","outbound_transfers"]},"forwarding_settings":{"title":"forwarding_settings","required":["type"],"type":"object","properties":{"financial_account":{"type":"string","description":"The financial_account id"},"payment_method":{"maxLength":5000,"type":"string","description":"The payment_method or bank account id. This needs to be a verified bank account."},"type":{"type":"string","description":"The type of the bank account provided. This can be either \"financial_account\" or \"payment_method\"","enum":["financial_account","payment_method"]}},"description":"A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0","x-stripeMostCommon":["financial_account","payment_method","type"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":"The nickname for the FinancialAccount.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"platform_restrictions":{"title":"platform_restrictions","type":"object","properties":{"inbound_flows":{"type":"string","description":"Restricts all inbound money movement.","enum":["restricted","unrestricted"]},"outbound_flows":{"type":"string","description":"Restricts all outbound money movement.","enum":["restricted","unrestricted"]}},"description":"The set of functionalities that the platform can restrict on the FinancialAccount.","x-stripeMostCommon":["inbound_flows","outbound_flows","received_credits","received_debits"]}},"additionalProperties":false,"x-stripeMostCommon":["display_name","features","forwarding_settings","metadata","nickname","platform_restrictions"]},"encoding":{"display_name":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"features":{"style":"deepObject","explode":true},"forwarding_settings":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"nickname":{"style":"deepObject","explode":true},"platform_restrictions":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.financial_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_treasury_financial_account"}},"/v1/treasury/financial_accounts/{financial_account}/close":{"post":{"summary":"Close a FinancialAccount","description":"Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
","operationId":"PostTreasuryFinancialAccountsFinancialAccountClose","parameters":[{"name":"financial_account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"forwarding_settings":{"title":"forwarding_settings","required":["type"],"type":"object","properties":{"financial_account":{"type":"string","description":"The financial_account id"},"payment_method":{"maxLength":5000,"type":"string","description":"The payment_method or bank account id. This needs to be a verified bank account."},"type":{"type":"string","description":"The type of the bank account provided. This can be either \"financial_account\" or \"payment_method\"","enum":["financial_account","payment_method"]}},"description":"A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0","x-stripeMostCommon":["financial_account","payment_method","type"]}},"additionalProperties":false,"x-stripeMostCommon":["forwarding_settings"]},"encoding":{"expand":{"style":"deepObject","explode":true},"forwarding_settings":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.financial_account"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"close_treasury_financial_account"}},"/v1/treasury/financial_accounts/{financial_account}/features":{"get":{"summary":"Retrieve FinancialAccount Features","description":"Retrieves Features information associated with the FinancialAccount.
","operationId":"GetTreasuryFinancialAccountsFinancialAccountFeatures","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.financial_account_features"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_financial_account_features"},"post":{"summary":"Update FinancialAccount Features","description":"Updates the Features associated with a FinancialAccount.
","operationId":"PostTreasuryFinancialAccountsFinancialAccountFeatures","parameters":[{"name":"financial_account","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"card_issuing":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.","x-stripeMostCommon":["requested"]},"deposit_insurance":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.","x-stripeMostCommon":["requested"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"financial_addresses":{"title":"financial_addresses","type":"object","properties":{"aba":{"title":"aba_access","required":["requested"],"type":"object","properties":{"bank":{"type":"string","description":"Requested bank partner","enum":["evolve","fifth_third","goldman_sachs"]},"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Adds an ABA FinancialAddress to the FinancialAccount.","x-stripeMostCommon":["bank","forwarding","requested"]}},"description":"Contains Features that add FinancialAddresses to the FinancialAccount.","x-stripeMostCommon":["aba"]},"inbound_transfers":{"title":"inbound_transfers","type":"object","properties":{"ach":{"title":"access_with_ach_details_inbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH Debits via the InboundTransfers API.","x-stripeMostCommon":["platform_review","requested","same_day"]}},"description":"Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.","x-stripeMostCommon":["ach","us_check"]},"intra_stripe_flows":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).","x-stripeMostCommon":["requested"]},"outbound_payments":{"title":"outbound_payments","type":"object","properties":{"ach":{"title":"access_with_ach_details_outbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH transfers via the OutboundPayments API.","x-stripeMostCommon":["requested","same_day"]},"us_domestic_wire":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables US domestic wire transfers via the OutboundPayments API.","x-stripeMostCommon":["requested"]}},"description":"Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money.","x-stripeMostCommon":["ach","us_check","us_domestic_wire"]},"outbound_transfers":{"title":"outbound_transfers","type":"object","properties":{"ach":{"title":"access_with_ach_details_outbound","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables ACH transfers via the OutboundTransfers API.","x-stripeMostCommon":["requested","same_day"]},"us_domestic_wire":{"title":"access","required":["requested"],"type":"object","properties":{"requested":{"type":"boolean","description":"Whether the FinancialAccount should have the Feature."}},"description":"Enables US domestic wire transfers via the OutboundTransfers API.","x-stripeMostCommon":["requested"]}},"description":"Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.","x-stripeMostCommon":["ach","us_domestic_wire"]}},"additionalProperties":false,"x-stripeMostCommon":["card_issuing","deposit_insurance","financial_addresses","inbound_transfers","intra_stripe_flows","outbound_payments","outbound_transfers"]},"encoding":{"card_issuing":{"style":"deepObject","explode":true},"deposit_insurance":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"financial_addresses":{"style":"deepObject","explode":true},"inbound_transfers":{"style":"deepObject","explode":true},"intra_stripe_flows":{"style":"deepObject","explode":true},"outbound_payments":{"style":"deepObject","explode":true},"outbound_transfers":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.financial_account_features"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"update_treasury_financial_account_features"}},"/v1/treasury/inbound_transfers":{"get":{"summary":"List all InboundTransfers","description":"Returns a list of InboundTransfers sent from the specified FinancialAccount.
","operationId":"GetTreasuryInboundTransfers","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","failed","processing","succeeded"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryInboundTransfersResourceInboundTransferList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.inbound_transfer"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_inbound_transfers"},"post":{"summary":"Create an InboundTransfer","description":"Creates an InboundTransfer.
","operationId":"PostTreasuryInboundTransfers","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","currency","financial_account","origin_payment_method"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount (in cents) to be transferred."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"financial_account":{"type":"string","description":"The FinancialAccount to send funds to."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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_payment_method":{"maxLength":5000,"type":"string","description":"The origin payment method to be debited for the InboundTransfer."},"statement_descriptor":{"maxLength":10,"type":"string","description":"The complete description that appears on your customers' statements. Maximum 10 characters. Can only include -#.$&*, spaces, and alphanumeric characters."}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","financial_account","metadata","origin_payment_method","statement_descriptor"]},"encoding":{"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.inbound_transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_treasury_inbound_transfer"}},"/v1/treasury/inbound_transfers/{id}":{"get":{"summary":"Retrieve an InboundTransfer","description":"Retrieves the details of an existing InboundTransfer.
","operationId":"GetTreasuryInboundTransfersId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.inbound_transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_inbound_transfer"}},"/v1/treasury/inbound_transfers/{inbound_transfer}/cancel":{"post":{"summary":"Cancel an InboundTransfer","description":"Cancels an InboundTransfer.
","operationId":"PostTreasuryInboundTransfersInboundTransferCancel","parameters":[{"name":"inbound_transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.inbound_transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_treasury_inbound_transfer"}},"/v1/treasury/outbound_payments":{"get":{"summary":"List all OutboundPayments","description":"Returns a list of OutboundPayments sent from the specified FinancialAccount.
","operationId":"GetTreasuryOutboundPayments","parameters":[{"name":"created","in":"query","description":"Only return OutboundPayments that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"customer","in":"query","description":"Only return OutboundPayments sent to this customer.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","failed","posted","processing","returned"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryOutboundPaymentsResourceOutboundPaymentList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.outbound_payment"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/treasury/outbound_payments","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_outbound_payments"},"post":{"summary":"Create an OutboundPayment","description":"Creates an OutboundPayment.
","operationId":"PostTreasuryOutboundPayments","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","currency","financial_account"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount (in cents) to be transferred."},"currency":{"type":"string","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).","format":"currency"},"customer":{"maxLength":5000,"type":"string","description":"ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in."},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"destination_payment_method":{"maxLength":5000,"type":"string","description":"The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`."},"destination_payment_method_data":{"title":"payment_method_data","required":["type"],"type":"object","properties":{"billing_details":{"title":"billing_details_inner_params","type":"object","properties":{"address":{"description":"Billing address.","anyOf":[{"title":"billing_details_address","type":"object","properties":{"city":{"maxLength":5000,"type":"string","description":"City, district, suburb, town, or village."},"country":{"maxLength":5000,"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."},"line1":{"maxLength":5000,"type":"string","description":"Address line 1, such as the street, PO Box, or company name."},"line2":{"maxLength":5000,"type":"string","description":"Address line 2, such as the apartment, suite, unit, or building."},"postal_code":{"maxLength":5000,"type":"string","description":"ZIP or postal code."},"state":{"maxLength":5000,"type":"string","description":"State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."}},"x-stripeMostCommon":["city","country","line1","line2","postal_code","state"]},{"type":"string","enum":[""]}]},"email":{"description":"Email address.","anyOf":[{"type":"string"},{"type":"string","enum":[""]}]},"name":{"description":"Full name.","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]},"phone":{"description":"Billing phone number (including extension).","anyOf":[{"maxLength":5000,"type":"string"},{"type":"string","enum":[""]}]}},"description":"Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.","x-stripeMostCommon":["address","email","name","phone"]},"financial_account":{"type":"string","description":"Required if type is set to `financial_account`. The FinancialAccount ID to send funds to."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. 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":{"type":"string","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":["financial_account","us_bank_account"],"x-stripeBypassValidation":true},"us_bank_account":{"title":"payment_method_param","type":"object","properties":{"account_holder_type":{"type":"string","description":"Account holder type: individual or company.","enum":["company","individual"]},"account_number":{"maxLength":5000,"type":"string","description":"Account number of the bank account."},"account_type":{"type":"string","description":"Account type: checkings or savings. Defaults to checking if omitted.","enum":["checking","savings"]},"financial_connections_account":{"maxLength":5000,"type":"string","description":"The ID of a Financial Connections Account to use as a payment method."},"routing_number":{"maxLength":5000,"type":"string","description":"Routing number of the bank account."}},"description":"Required hash if type is set to `us_bank_account`.","x-stripeMostCommon":["account_holder_type","account_number","account_type","financial_connections_account","routing_number","token"]}},"description":"Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.","x-stripeMostCommon":["billing_details","metadata","type"]},"destination_payment_method_options":{"title":"payment_method_options","type":"object","properties":{"us_bank_account":{"description":"Optional fields for `us_bank_account`.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"network":{"type":"string","description":"Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.","enum":["ach","us_domestic_wire"]}},"x-stripeMostCommon":["ach","network"]},{"type":"string","enum":[""]}]}},"description":"Payment method-specific configuration for this OutboundPayment.","x-stripeMostCommon":["us_bank_account"]},"end_user_details":{"title":"end_user_details_params","required":["present"],"type":"object","properties":{"ip_address":{"type":"string","description":"IP address of the user initiating the OutboundPayment. Must be supplied if `present` is set to `true`."},"present":{"type":"boolean","description":"`True` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`."}},"description":"End user details.","x-stripeMostCommon":["ip_address","present"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"financial_account":{"type":"string","description":"The FinancialAccount to pull funds from."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"purpose":{"type":"string","description":"The purpose of the OutboundPayment, if applicable. This list is not exhaustive, do not specify this parameter if your purpose does not match any that are provided.","enum":["payroll"]},"statement_descriptor":{"maxLength":5000,"type":"string","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. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is \"payment\"."}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","customer","description","destination_payment_method","destination_payment_method_data","destination_payment_method_options","end_user_details","financial_account","metadata","purpose","statement_descriptor"]},"encoding":{"destination_payment_method_data":{"style":"deepObject","explode":true},"destination_payment_method_options":{"style":"deepObject","explode":true},"end_user_details":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.outbound_payment"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_treasury_outbound_payment"}},"/v1/treasury/outbound_payments/{id}":{"get":{"summary":"Retrieve an OutboundPayment","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.outbound_payment"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_outbound_payment"}},"/v1/treasury/outbound_payments/{id}/cancel":{"post":{"summary":"Cancel an OutboundPayment","description":"Cancel an OutboundPayment.
","operationId":"PostTreasuryOutboundPaymentsIdCancel","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.outbound_payment"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_treasury_outbound_payment"}},"/v1/treasury/outbound_transfers":{"get":{"summary":"List all OutboundTransfers","description":"Returns a list of OutboundTransfers sent from the specified FinancialAccount.
","operationId":"GetTreasuryOutboundTransfers","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["canceled","failed","posted","processing","returned"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryOutboundTransfersResourceOutboundTransferList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.outbound_transfer"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_outbound_transfers"},"post":{"summary":"Create an OutboundTransfer","description":"Creates an OutboundTransfer.
","operationId":"PostTreasuryOutboundTransfers","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["amount","currency","financial_account"],"type":"object","properties":{"amount":{"type":"integer","description":"Amount (in cents) to be transferred."},"currency":{"type":"string","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).","format":"currency"},"description":{"maxLength":5000,"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users."},"destination_payment_method":{"maxLength":5000,"type":"string","description":"The PaymentMethod to use as the payment instrument for the OutboundTransfer."},"destination_payment_method_data":{"title":"payment_method_data","required":["type"],"type":"object","properties":{"financial_account":{"type":"string","description":"Required if type is set to `financial_account`. The FinancialAccount ID to send funds to."},"type":{"type":"string","description":"The type of the destination.","enum":["financial_account"]}},"description":"Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.","x-stripeMostCommon":["type"]},"destination_payment_method_options":{"title":"payment_method_options","type":"object","properties":{"us_bank_account":{"description":"Optional fields for `us_bank_account`.","anyOf":[{"title":"payment_method_options_param","type":"object","properties":{"network":{"type":"string","description":"Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.","enum":["ach","us_domestic_wire"]}},"x-stripeMostCommon":["ach","network"]},{"type":"string","enum":[""]}]}},"description":"Hash describing payment method configuration details.","x-stripeMostCommon":["us_bank_account"]},"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}},"financial_account":{"type":"string","description":"The FinancialAccount to pull funds from."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"network_details":{"title":"network_details_source","required":["type"],"type":"object","properties":{"ach":{"title":"ach_network_details_source","type":"object","properties":{"addenda":{"maxLength":5000,"type":"string","description":"Addenda record data associated with this OutboundTransfer."}},"description":"Optional fields for `ach`.","x-stripeMostCommon":["addenda"]},"type":{"type":"string","description":"The type of flow that originated the OutboundTransfer.","enum":["ach"]}},"description":"Details about the network used for the OutboundTransfer.","x-stripeMostCommon":["ach","type"]},"statement_descriptor":{"maxLength":5000,"type":"string","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\". Can only include -#.$&*, spaces, and alphanumeric characters."}},"additionalProperties":false,"x-stripeMostCommon":["amount","currency","description","destination_payment_method","destination_payment_method_data","destination_payment_method_options","financial_account","metadata","network_details","statement_descriptor"]},"encoding":{"destination_payment_method_data":{"style":"deepObject","explode":true},"destination_payment_method_options":{"style":"deepObject","explode":true},"expand":{"style":"deepObject","explode":true},"metadata":{"style":"deepObject","explode":true},"network_details":{"style":"deepObject","explode":true}}}},"required":true},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.outbound_transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"create_treasury_outbound_transfer"}},"/v1/treasury/outbound_transfers/{outbound_transfer}":{"get":{"summary":"Retrieve an OutboundTransfer","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":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"outbound_transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.outbound_transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_outbound_transfer"}},"/v1/treasury/outbound_transfers/{outbound_transfer}/cancel":{"post":{"summary":"Cancel an OutboundTransfer","description":"An OutboundTransfer can be canceled if the funds have not yet been paid out.
","operationId":"PostTreasuryOutboundTransfersOutboundTransferCancel","parameters":[{"name":"outbound_transfer","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"expand":{"type":"array","description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"}}},"additionalProperties":false},"encoding":{"expand":{"style":"deepObject","explode":true}}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.outbound_transfer"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"cancel_treasury_outbound_transfer"}},"/v1/treasury/received_credits":{"get":{"summary":"List all ReceivedCredits","description":"Returns a list of ReceivedCredits.
","operationId":"GetTreasuryReceivedCredits","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"The FinancialAccount that received the funds.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"linked_flows","in":"query","description":"Only return ReceivedCredits described by the flow.","required":false,"style":"deepObject","explode":true,"schema":{"title":"linked_flows_param","required":["source_flow_type"],"type":"object","properties":{"source_flow_type":{"type":"string","description":"The source flow type.","enum":["credit_reversal","other","outbound_payment","outbound_transfer","payout"]}},"x-stripeMostCommon":["source_flow_type"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return ReceivedCredits that have the given status: `succeeded` or `failed`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["failed","succeeded"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryReceivedCreditsResourceReceivedCreditList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.received_credit"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_received_credits"}},"/v1/treasury/received_credits/{id}":{"get":{"summary":"Retrieve a ReceivedCredit","description":"Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
","operationId":"GetTreasuryReceivedCreditsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.received_credit"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_received_credit"}},"/v1/treasury/received_debits":{"get":{"summary":"List all ReceivedDebits","description":"Returns a list of ReceivedDebits.
","operationId":"GetTreasuryReceivedDebits","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"The FinancialAccount that funds were pulled from.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return ReceivedDebits that have the given status: `succeeded` or `failed`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["failed","succeeded"],"x-stripeBypassValidation":true}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryReceivedDebitsResourceReceivedDebitList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.received_debit"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_received_debits"}},"/v1/treasury/received_debits/{id}":{"get":{"summary":"Retrieve a ReceivedDebit","description":"Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list
","operationId":"GetTreasuryReceivedDebitsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.received_debit"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_received_debit"}},"/v1/treasury/transaction_entries":{"get":{"summary":"List all TransactionEntries","description":"Retrieves a list of TransactionEntry objects.
","operationId":"GetTreasuryTransactionEntries","parameters":[{"name":"created","in":"query","description":"Only return TransactionEntries that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"effective_at","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"order_by","in":"query","description":"The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["created","effective_at"]}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"transaction","in":"query","description":"Only return TransactionEntries associated with this Transaction.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryTransactionsResourceTransactionEntryList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.transaction_entry"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/treasury/transaction_entries","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_transaction_entries"}},"/v1/treasury/transaction_entries/{id}":{"get":{"summary":"Retrieve a TransactionEntry","description":"Retrieves a TransactionEntry object.
","operationId":"GetTreasuryTransactionEntriesId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.transaction_entry"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_transaction_entry"}},"/v1/treasury/transactions":{"get":{"summary":"List all Transactions","description":"Retrieves a list of Transaction objects.
","operationId":"GetTreasuryTransactions","parameters":[{"name":"created","in":"query","description":"Only return Transactions that were created during the given date interval.","required":false,"style":"deepObject","explode":true,"schema":{"anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"financial_account","in":"query","description":"Returns objects associated with this FinancialAccount.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"order_by","in":"query","description":"The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["created","posted_at"],"x-stripeBypassValidation":true}},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"status","in":"query","description":"Only return Transactions that have the given status: `open`, `posted`, or `void`.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["open","posted","void"]}},{"name":"status_transitions","in":"query","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.","required":false,"style":"deepObject","explode":true,"schema":{"title":"status_transition_timestamp_specs","type":"object","properties":{"posted_at":{"description":"Returns Transactions with `posted_at` within the specified range.","anyOf":[{"title":"range_query_specs","type":"object","properties":{"gt":{"type":"integer","description":"Minimum value to filter by (exclusive)"},"gte":{"type":"integer","description":"Minimum value to filter by (inclusive)"},"lt":{"type":"integer","description":"Maximum value to filter by (exclusive)"},"lte":{"type":"integer","description":"Maximum value to filter by (inclusive)"}},"x-stripeMostCommon":["gt","gte","lt","lte"]},{"type":"integer"}]}},"x-stripeMostCommon":["posted_at"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"TreasuryTransactionsResourceTransactionList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","description":"Details about each object.","items":{"$ref":"#/components/schemas/treasury.transaction"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_treasury_transactions"}},"/v1/treasury/transactions/{id}":{"get":{"summary":"Retrieve a Transaction","description":"Retrieves the details of an existing Transaction.
","operationId":"GetTreasuryTransactionsId","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/treasury.transaction"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_treasury_transaction"}},"/v1/webhook_endpoints":{"get":{"summary":"List all webhook endpoints","description":"Returns a list of your webhook endpoints.
","operationId":"GetWebhookEndpoints","parameters":[{"name":"ending_before","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true},{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"limit","in":"query","description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","required":false,"style":"form","explode":true,"schema":{"type":"integer"},"x-stripeLessCommon":true},{"name":"starting_after","in":"query","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.","required":false,"style":"form","explode":true,"schema":{"maxLength":5000,"type":"string"},"x-stripeLessCommon":true}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"title":"NotificationWebhookEndpointList","required":["data","has_more","object","url"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/webhook_endpoint"}},"has_more":{"type":"boolean","description":"True if this list has another page of items after this one that can be fetched."},"object":{"type":"string","description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"]},"url":{"maxLength":5000,"pattern":"^/v1/webhook_endpoints","type":"string","description":"The URL where this list can be accessed."}},"description":"","x-expandableFields":["data"],"x-stripeMostCommon":["data","has_more","object","url"]}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"list_webhook_endpoints"},"post":{"summary":"Create a webhook endpoint","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.
Retrieves the webhook endpoint with the given ID.
","operationId":"GetWebhookEndpointsWebhookEndpoint","parameters":[{"name":"expand","in":"query","description":"Specifies which fields in the response should be expanded.","required":false,"style":"deepObject","explode":true,"schema":{"type":"array","items":{"maxLength":5000,"type":"string"}},"x-stripeLessCommon":true},{"name":"webhook_endpoint","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_endpoint"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"retrieve_webhook_endpoint"},"post":{"summary":"Update a webhook endpoint","description":"Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
","operationId":"DeleteWebhookEndpointsWebhookEndpoint","parameters":[{"name":"webhook_endpoint","in":"path","required":true,"style":"simple","explode":false,"schema":{"maxLength":5000,"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{},"additionalProperties":false},"encoding":{}}},"required":false},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_webhook_endpoint"}}}},"default":{"description":"Error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"x-stableId":"delete_webhook_endpoint"}},"/v2/billing/bill_settings":{"get":{"summary":"List Bill Settings","description":"List all BillSetting objects.","operationId":"GetV2BillingBillSettings","parameters":[{"name":"limit","in":"query","description":"Optionally set the maximum number of results per page. Defaults to 20.","required":false,"style":"form","schema":{"type":"integer"}},{"name":"lookup_keys","in":"query","description":"Only return the settings with these lookup_keys, if any exist.\nYou can specify up to 10 lookup_keys.","required":false,"style":"deepObject","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"required":["data","next_page_url","previous_page_url"],"type":"object","properties":{"data":{"type":"array","description":"The list of retrieved Bill Settings.","items":{"$ref":"#/components/schemas/v2.billing.bill_setting"}},"next_page_url":{"type":"string","description":"URL to fetch the next page of the list. If there are no more pages, the value is null.","nullable":true},"previous_page_url":{"type":"string","description":"URL to fetch the previous page of the list. If there are no previous pages, the value is null.","nullable":true}}},"examples":{"example":{"value":{"data":[{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}]}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_list_bill_settings","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{},"gated":true},"response":{"data":[{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}]}}],"x-stripeErrors":[],"x-stripeNotPublic":true},"post":{"summary":"Create a Bill Setting","description":"Create a BillSetting object.","operationId":"PostV2BillingBillSettings","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"calculation":{"type":"object","properties":{"tax":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Determines if tax is calculated automatically based on a PTC or manually based on rules defined by the business. Defaults to \"manual\".","enum":["automatic","manual"],"x-stripeEnum":{"kind":"open","values":[{"description":"Tax is calculated automatically based on a PTC.","value":"automatic"},{"description":"Tax is calculated based on rules defined by the business.","value":"manual"}]}}},"description":"Settings for calculating tax."}},"description":"Settings related to calculating a bill."},"display_name":{"type":"string","description":"An optional customer-facing display name for the CollectionSetting object.\nMaximum length of 250 characters."},"invoice":{"type":"object","properties":{"time_until_due":{"required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"The interval unit for the time until due.","enum":["day","month","week","year"],"x-stripeEnum":{"kind":"closed","values":[{"description":"Daily interval.","value":"day"},{"description":"Monthly interval.","value":"month"},{"description":"Weekly interval.","value":"week"},{"description":"Yearly interval.","value":"year"}]}},"interval_count":{"type":"integer","description":"The number of interval units. For example, if interval=day and interval_count=30,\nthe invoice is due in 30 days."}},"description":"The amount of time until the invoice is overdue for payment."}},"description":"Settings related to invoice behavior."},"invoice_rendering_template":{"type":"string","description":"The ID of the invoice rendering template to be used when generating invoices."},"lookup_key":{"type":"string","description":"A lookup key used to retrieve settings dynamically from a static string.\nThis may be up to 200 characters."}}},"examples":{"example":{"value":{"pathParams":{},"requestBody":{"display_name":"Automatic tax settings","calculation":{"tax":{"type":"automatic"}}},"gated":true}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.bill_setting"},"examples":{"example":{"value":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.automatic_tax_no_merchant_location"},{"$ref":"#/components/schemas/v2.error.invalid_bill_setting_time_until_due"},{"$ref":"#/components/schemas/v2.error.invalid_invoice_rendering_template_for_bill_setting"},{"$ref":"#/components/schemas/v2.error.invoice_rendering_template_not_found_for_bill_setting"},{"$ref":"#/components/schemas/v2.error.lookup_key_already_used_for_bill_setting"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_create_bill_setting","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{"display_name":"Automatic tax settings","calculation":{"tax":{"type":"automatic"}}},"gated":true},"response":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}],"x-stripeErrors":[{"code":"automatic_tax_no_merchant_location","description":"Returned when the merchant doesn't have a valid origin address.","httpStatusCode":400},{"code":"invalid_bill_setting_time_until_due","description":"Returned when the time until due is outside the supported range.","httpStatusCode":400},{"code":"invalid_invoice_rendering_template_for_bill_setting","description":"Returned when the invoice rendering template is archived.","httpStatusCode":400},{"code":"invoice_rendering_template_not_found_for_bill_setting","description":"Returned when the invoice rendering template cannot be found.","httpStatusCode":400},{"code":"lookup_key_already_used_for_bill_setting","description":"Returned when the lookup key is already used for a bill setting.","httpStatusCode":400}],"x-stripeNotPublic":true}},"/v2/billing/bill_settings/{bill_setting_id}/versions":{"get":{"summary":"List Bill Setting Versions","description":"List all BillSettingVersions by BillSetting ID.","operationId":"GetV2BillingBillSettingsBillSettingIdVersions","parameters":[{"name":"bill_setting_id","in":"path","description":"ID of the BillSettings to retrieve versions for.","required":true,"style":"simple","schema":{"type":"string","x-stripeParam":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.bill_setting"}}}},{"name":"limit","in":"query","description":"Optionally set the maximum number of results per page. Defaults to 20.","required":false,"style":"form","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"required":["data","next_page_url","previous_page_url"],"type":"object","properties":{"data":{"type":"array","description":"The list of retrieved Bill Setting Versions.","items":{"$ref":"#/components/schemas/v2.billing.bill_setting_version"}},"next_page_url":{"type":"string","description":"URL to fetch the next page of the list. If there are no more pages, the value is null.","nullable":true},"previous_page_url":{"type":"string","description":"URL to fetch the previous page of the list. If there are no previous pages, the value is null.","nullable":true}}},"examples":{"example":{"value":{"data":[{"calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T00:00:00.000Z","id":"bblsetv_test_61T2gNXz4yci3XdEH16Sg5eV2tSQs27bdBltKwQGm4k4","invoice":{"time_until_due":{"interval":"day","interval_count":1}},"invoice_rendering_template":"inrtem_test_1RYqt9H5wvQ9UC0Vtppz2bSj","object":"v2.billing.bill_setting_version","livemode":true}],"next_page_url":null,"previous_page_url":null}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.bill_setting_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_list_bill_setting_versions","x-stripeDocsSamples":[{"request":{"pathParams":{"bill_setting_id":"bblset_test_61T2gNXemFgqleYpd16Sg5eV2tSQs27bdBltKwQGm6qO"},"requestBody":{}},"response":{"data":[{"calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T00:00:00.000Z","id":"bblsetv_test_61T2gNXz4yci3XdEH16Sg5eV2tSQs27bdBltKwQGm4k4","invoice":{"time_until_due":{"interval":"day","interval_count":1}},"invoice_rendering_template":"inrtem_test_1RYqt9H5wvQ9UC0Vtppz2bSj","object":"v2.billing.bill_setting_version","livemode":true}],"next_page_url":null,"previous_page_url":null}}],"x-stripeErrors":[{"code":"bill_setting_not_found","description":"Returned when the bill setting cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true}},"/v2/billing/bill_settings/{bill_setting_id}/versions/{id}":{"get":{"summary":"Retrieve a Bill Setting Version","description":"Retrieve a BillSettingVersion by ID.","operationId":"GetV2BillingBillSettingsBillSettingIdVersionsId","parameters":[{"name":"bill_setting_id","in":"path","description":"The ID of the BillSetting object to retrieve the version from.","required":true,"style":"simple","schema":{"type":"string","x-stripeParam":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.bill_setting"}}}},{"name":"id","in":"path","description":"The ID of the BillSettingVersion object to retrieve.","required":true,"style":"simple","schema":{"type":"string","x-stripeParam":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.bill_setting_version"}}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.bill_setting_version"},"examples":{"example":{"value":{"calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T00:00:00.000Z","id":"bblsetv_test_61T2gNXz4yci3XdEH16Sg5eV2tSQs27bdBltKwQGm4k4","invoice":{"time_until_due":{"interval":"day","interval_count":1}},"invoice_rendering_template":"inrtem_test_1RYqt9H5wvQ9UC0Vtppz2bSj","object":"v2.billing.bill_setting_version","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.bill_setting_not_found"},{"$ref":"#/components/schemas/v2.error.bill_setting_version_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_retrieve_bill_setting_version","x-stripeDocsSamples":[{"request":{"pathParams":{"bill_setting_id":"bblset_test_61T2gNXemFgqleYpd16Sg5eV2tSQs27bdBltKwQGm6qO","id":"bblsetv_test_61T2gNXz4yci3XdEH16Sg5eV2tSQs27bdBltKwQGm4k4"},"requestBody":{}},"response":{"calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T00:00:00.000Z","id":"bblsetv_test_61T2gNXz4yci3XdEH16Sg5eV2tSQs27bdBltKwQGm4k4","invoice":{"time_until_due":{"interval":"day","interval_count":1}},"invoice_rendering_template":"inrtem_test_1RYqt9H5wvQ9UC0Vtppz2bSj","object":"v2.billing.bill_setting_version","livemode":true}}],"x-stripeErrors":[{"code":"bill_setting_not_found","description":"Returned when the bill setting cannot be found.","httpStatusCode":404},{"code":"bill_setting_version_not_found","description":"Returned when the bill setting version cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true}},"/v2/billing/bill_settings/{id}":{"get":{"summary":"Retrieve a Bill Setting","description":"Retrieve a BillSetting object by ID.","operationId":"GetV2BillingBillSettingsId","parameters":[{"name":"id","in":"path","description":"The ID of the BillSetting object to retrieve.","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.bill_setting"},"examples":{"example":{"value":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.bill_setting_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_retrieve_bill_setting","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI"},"requestBody":{},"gated":true},"response":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}],"x-stripeErrors":[{"code":"bill_setting_not_found","description":"Returned when the bill setting cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true},"post":{"summary":"Update a Bill Setting","description":"Update fields on an existing BillSetting object.","operationId":"PostV2BillingBillSettingsId","parameters":[{"name":"id","in":"path","description":"The ID of the BillSetting object to update.","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"calculation":{"type":"object","properties":{"tax":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Determines if tax is calculated automatically based on a PTC or manually based on rules defined by the business. Defaults to \"manual\".","enum":["automatic","manual"],"x-stripeEnum":{"kind":"open","values":[{"description":"Tax is calculated automatically based on a PTC.","value":"automatic"},{"description":"Tax is calculated based on rules defined by the business.","value":"manual"}]}}},"description":"Settings for calculating tax."}},"description":"Settings related to calculating a bill."},"display_name":{"type":"string","description":"An optional customer-facing display name for the BillSetting object.\nTo remove the display name, set it to an empty string in the request.\nMaximum length of 250 characters."},"invoice":{"type":"object","properties":{"time_until_due":{"required":["interval","interval_count"],"type":"object","properties":{"interval":{"type":"string","description":"The interval unit for the time until due.","enum":["day","month","week","year"],"x-stripeEnum":{"kind":"closed","values":[{"description":"Daily interval.","value":"day"},{"description":"Monthly interval.","value":"month"},{"description":"Weekly interval.","value":"week"},{"description":"Yearly interval.","value":"year"}]}},"interval_count":{"type":"integer","description":"The number of interval units. For example, if interval=day and interval_count=30,\nthe invoice is due in 30 days."}},"description":"The amount of time until the invoice is overdue for payment."}},"description":"Settings related to invoice behavior."},"invoice_rendering_template":{"type":"string","description":"The ID of the invoice rendering template to be used when generating invoices."},"live_version":{"type":"string","description":"Optionally change the live version of the BillSetting. Providing `live_version = \"latest\"` sets the\nBillSetting' `live_version` to its latest version."},"lookup_key":{"type":"string","description":"A lookup key used to retrieve settings dynamically from a static string.\nThis may be up to 200 characters."}}},"examples":{"example":{"value":{"pathParams":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI"},"requestBody":{"display_name":"New name"},"gated":true}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.bill_setting"},"examples":{"example":{"value":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"New name","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.automatic_tax_no_merchant_location"},{"$ref":"#/components/schemas/v2.error.bill_setting_not_found"},{"$ref":"#/components/schemas/v2.error.invalid_bill_setting_time_until_due"},{"$ref":"#/components/schemas/v2.error.invalid_invoice_rendering_template_for_bill_setting"},{"$ref":"#/components/schemas/v2.error.invoice_rendering_template_not_found_for_bill_setting"},{"$ref":"#/components/schemas/v2.error.lookup_key_already_used_for_bill_setting"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_update_bill_setting","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI"},"requestBody":{"display_name":"New name"},"gated":true},"response":{"id":"bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.bill_setting","calculation":{"tax":{"type":"automatic"}},"created":"2025-01-01T10:00:00.000Z","display_name":"New name","latest_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}],"x-stripeErrors":[{"code":"automatic_tax_no_merchant_location","description":"Returned when the merchant doesn't have a valid origin address.","httpStatusCode":400},{"code":"bill_setting_not_found","description":"Returned when the bill setting cannot be found.","httpStatusCode":404},{"code":"invalid_bill_setting_time_until_due","description":"Returned when the time until due is outside the supported range.","httpStatusCode":400},{"code":"invalid_invoice_rendering_template_for_bill_setting","description":"Returned when the invoice rendering template is archived.","httpStatusCode":400},{"code":"invoice_rendering_template_not_found_for_bill_setting","description":"Returned when the invoice rendering template cannot be found.","httpStatusCode":400},{"code":"lookup_key_already_used_for_bill_setting","description":"Returned when the lookup key is already used for a bill setting.","httpStatusCode":400}],"x-stripeNotPublic":true}},"/v2/billing/cadences":{"get":{"summary":"List billing cadences","description":"List Billing Cadences.","operationId":"GetV2BillingCadences","parameters":[{"name":"include","in":"query","description":"Additional resource to include in the response.","required":false,"style":"deepObject","schema":{"type":"array","items":{"type":"string","enum":["settings_data"],"x-stripeEnum":{"kind":"open","values":[{"description":"Include parameter to expose expanded settings data on the cadence.","value":"settings_data"}]}}}},{"name":"limit","in":"query","description":"Optionally set the maximum number of results per page. Defaults to 20.","required":false,"style":"form","schema":{"type":"integer"}},{"name":"lookup_keys","in":"query","description":"Only return the cadences with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.\nMutually exclusive with `test_clock` and `payer`.","required":false,"style":"deepObject","schema":{"type":"array","items":{"type":"string"}}},{"name":"payer","in":"query","description":"If provided, only cadences that specifically reference the payer will be returned. Mutually exclusive with `test_clock` and `lookup_keys`.","required":false,"style":"deepObject","schema":{"required":["type"],"type":"object","properties":{"customer":{"type":"string","description":"The ID of the Customer object. If provided, only cadences that specifically reference the provided customer ID will be returned."},"type":{"type":"string","description":"A string identifying the type of the payer. Currently the only supported value is `customer`.","enum":["customer"],"x-stripeEnum":{"kind":"open","values":[{"description":"The payer is associated with a Customer.","value":"customer"}]}}}}},{"name":"test_clock","in":"query","description":"If provided, only cadences that specifically reference the provided test clock ID (via the\ncustomer's test clock) will be returned.\nMutually exclusive with `payer`.","required":false,"style":"form","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"required":["data","next_page_url","previous_page_url"],"type":"object","properties":{"data":{"type":"array","description":"The retrieved cadences.","items":{"$ref":"#/components/schemas/v2.billing.cadence"}},"next_page_url":{"type":"string","description":"URL to fetch the next page of the list. If there are no more pages, the value is null.","nullable":true},"previous_page_url":{"type":"string","description":"URL to fetch the previous page of the list. If there are no previous pages, the value is null.","nullable":true}}},"examples":{"example":{"value":{"data":[{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"active","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}]}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.customer_not_found"},{"$ref":"#/components/schemas/v2.error.invalid_billing_cadence_filters"},{"$ref":"#/components/schemas/v2.error.test_clock_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_list_cadences","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{}},"response":{"data":[{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"active","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}]}}],"x-stripeErrors":[{"code":"customer_not_found","description":"Returned when the customer for the provided ID cannot be found.","httpStatusCode":404},{"code":"invalid_billing_cadence_filters","description":"Returned when incorrect filters are set when retrieving billing cadences.","httpStatusCode":400},{"code":"test_clock_not_found","description":"Returned when the TestClock for the provided ID cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true},"post":{"summary":"Create a Billing Cadence","description":"Create a Billing Cadence object.","operationId":"PostV2BillingCadences","requestBody":{"content":{"application/json":{"schema":{"required":["billing_cycle","payer"],"type":"object","properties":{"billing_cycle":{"required":["type"],"type":"object","properties":{"day":{"type":"object","properties":{"time":{"required":["hour","minute","second"],"type":"object","properties":{"hour":{"type":"integer","description":"The hour at which the billing cycle ends.\nThis must be an integer between 0 and 23, inclusive.\n0 represents midnight, and 23 represents 11 PM."},"minute":{"type":"integer","description":"The minute at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."},"second":{"type":"integer","description":"The second at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."}},"description":"The time at which the billing cycle ends.\nThis field is optional, and if not provided, it defaults to\nthe time at which the cadence was created in UTC timezone."}},"description":"Specific configuration for determining billing dates when type=day."},"interval_count":{"type":"integer","description":"The number of intervals (specified in the interval attribute) between\ncadence billings. For example, type=month and interval_count=3 bills every\n3 months. If not provided, this defaults to 1."},"month":{"required":["day_of_month"],"type":"object","properties":{"day_of_month":{"type":"integer","description":"The day to anchor the billing on for a type=\"month\" billing cycle from\n1-31. If this number is greater than the number of days in the month being\nbilled, this anchors to the last day of the month. If not provided,\nthis defaults to the day the cadence was created."},"month_of_year":{"type":"integer","description":"The month to anchor the billing on for a type=\"month\" billing cycle from\n1-12. If not provided, this defaults to the month the cadence was created.\nThis setting can only be used for monthly billing cycles with `interval_count` of 2, 3, 4 or 6.\nAll occurrences are calculated from the month provided."},"time":{"required":["hour","minute","second"],"type":"object","properties":{"hour":{"type":"integer","description":"The hour at which the billing cycle ends.\nThis must be an integer between 0 and 23, inclusive.\n0 represents midnight, and 23 represents 11 PM."},"minute":{"type":"integer","description":"The minute at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."},"second":{"type":"integer","description":"The second at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."}},"description":"The time at which the billing cycle ends.\nThis field is optional, and if not provided, it defaults to\nthe time at which the cadence was created in UTC timezone."}},"description":"Specific configuration for determining billing dates when type=month."},"type":{"type":"string","description":"The frequency at which a cadence bills.","enum":["day","month","week","year"],"x-stripeEnum":{"kind":"open","values":[{"description":"Bill the payer daily.","value":"day"},{"description":"Bill the payer monthly.","value":"month"},{"description":"Bill the payer weekly.","value":"week"},{"description":"Bill the payer yearly.","value":"year"}]}},"week":{"required":["day_of_week"],"type":"object","properties":{"day_of_week":{"type":"integer","description":"The day of the week to bill the type=week billing cycle on.\nNumbered from 1-7 for Monday to Sunday respectively, based on the ISO-8601\nweek day numbering. If not provided, this defaults to the day the\ncadence was created."},"time":{"required":["hour","minute","second"],"type":"object","properties":{"hour":{"type":"integer","description":"The hour at which the billing cycle ends.\nThis must be an integer between 0 and 23, inclusive.\n0 represents midnight, and 23 represents 11 PM."},"minute":{"type":"integer","description":"The minute at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."},"second":{"type":"integer","description":"The second at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."}},"description":"The time at which the billing cycle ends.\nThis field is optional, and if not provided, it defaults to\nthe time at which the cadence was created in UTC timezone."}},"description":"Specific configuration for determining billing dates when type=week."},"year":{"type":"object","properties":{"day_of_month":{"type":"integer","description":"The day to anchor the billing on for a type=\"month\" billing cycle from\n1-31. If this number is greater than the number of days in the month being\nbilled, this anchors to the last day of the month. If not provided,\nthis defaults to the day the cadence was created."},"month_of_year":{"type":"integer","description":"The month to bill on from 1-12. If not provided, this defaults to the\nmonth the cadence was created."},"time":{"required":["hour","minute","second"],"type":"object","properties":{"hour":{"type":"integer","description":"The hour at which the billing cycle ends.\nThis must be an integer between 0 and 23, inclusive.\n0 represents midnight, and 23 represents 11 PM."},"minute":{"type":"integer","description":"The minute at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."},"second":{"type":"integer","description":"The second at which the billing cycle ends.\nMust be an integer between 0 and 59, inclusive."}},"description":"The time at which the billing cycle ends.\nThis field is optional, and if not provided, it defaults to\nthe time at which the cadence was created in UTC timezone."}},"description":"Specific configuration for determining billing dates when type=year."}},"description":"The billing cycle is the object that defines future billing cycle dates."},"lookup_key":{"type":"string","description":"A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Set of [key-value pairs](/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."},"payer":{"required":["billing_profile"],"type":"object","properties":{"billing_profile":{"type":"string","description":"The ID of the Billing Profile object which determines how a bill is paid.","x-stripeNotPublic":true,"x-stripeProperty":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.profile"}}}},"description":"The payer determines the entity financially responsible for the bill."},"settings":{"type":"object","properties":{"bill":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the referenced settings object.","x-stripeNotPublic":true},"version":{"type":"string","description":"An optional field to specify the version of the Settings to use.\nIf not provided, this defaults to the live version any time the settings are used.","x-stripeNotPublic":true}},"description":"Settings that configure bill generation, which includes calculating totals, tax, and presenting invoices.\nIf no setting is provided here, the settings from the customer referenced on the payer will be used.\nIf no customer settings are present, the merchant default settings will be used.","x-stripeNotPublic":true},"collection":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the referenced settings object.","x-stripeNotPublic":true},"version":{"type":"string","description":"An optional field to specify the version of the Settings to use.\nIf not provided, this defaults to the live version any time the settings are used.","x-stripeNotPublic":true}},"description":"Settings that configure and manage the behavior of collecting payments.\nIf no setting is provided here, the settings from the customer referenced from the payer will be used if they exist.\nIf no customer settings are present, the merchant default settings will be used.","x-stripeNotPublic":true}},"description":"The settings associated with the cadence.","x-stripeNotPublic":true}}},"examples":{"example":{"value":{"pathParams":{},"requestBody":{"payer":{"billing_profile":"bilp_test_61Rc0IonJY96mpyHA16RM8VQ"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3}}}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.cadence"},"examples":{"example":{"value":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","billing_profile":"bilp_test_61Rc0IonJY96mpyHA16RM8VQ","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"active","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.bill_settings_not_found"},{"$ref":"#/components/schemas/v2.error.bill_settings_version_not_found"},{"$ref":"#/components/schemas/v2.error.billing_profile_not_found_for_cadence"},{"$ref":"#/components/schemas/v2.error.collection_settings_not_found"},{"$ref":"#/components/schemas/v2.error.collection_settings_version_not_found"},{"$ref":"#/components/schemas/v2.error.customer_not_found"},{"$ref":"#/components/schemas/v2.error.customer_tax_location_invalid"},{"$ref":"#/components/schemas/v2.error.invalid_billing_cycle_dates"},{"$ref":"#/components/schemas/v2.error.invalid_customer"},{"$ref":"#/components/schemas/v2.error.lookup_key_already_used"},{"$ref":"#/components/schemas/v2.error.month_of_year_not_supported_for_interval_count"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_create_cadence","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{"payer":{"billing_profile":"bilp_test_61Rc0IonJY96mpyHA16RM8VQ"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3}}}},"response":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","billing_profile":"bilp_test_61Rc0IonJY96mpyHA16RM8VQ","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"active","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}}],"x-stripeErrors":[{"code":"bill_settings_not_found","description":"Returned when the bill settings ID cannot be found.","httpStatusCode":404},{"code":"bill_settings_version_not_found","description":"Returned when the provided bill settings version ID cannot be found.","httpStatusCode":404},{"code":"billing_profile_not_found_for_cadence","description":"Returned when the provided billing profile ID cannot be found.","httpStatusCode":400},{"code":"collection_settings_not_found","description":"Returned when the collection settings ID cannot be found.","httpStatusCode":404},{"code":"collection_settings_version_not_found","description":"Returned when the provided collection settings version ID cannot be found.","httpStatusCode":404},{"code":"customer_not_found","description":"Returned when the customer for the provided ID cannot be found.","httpStatusCode":404},{"code":"customer_tax_location_invalid","description":"Returned when creating or updating a cadence with a customer whose tax location isn't recognized.","httpStatusCode":400},{"code":"invalid_billing_cycle_dates","description":"Returned by billing cadences when invalid dates for a billing cycle are set.","httpStatusCode":400},{"code":"invalid_customer","description":"Returned when creating or updating a cadence with a deleted customer.","httpStatusCode":400},{"code":"lookup_key_already_used","description":"Returned when another object of the same type already has the given lookup key.","httpStatusCode":400},{"code":"month_of_year_not_supported_for_interval_count","description":"Returned by billing cadences when billing_cycle.month.month_of_year is used with an invalid `interval_count`.","httpStatusCode":400}],"x-stripeNotPublic":true}},"/v2/billing/cadences/{id}":{"get":{"summary":"Retrieve a Billing Cadence","description":"Retrieve a Billing Cadence object.","operationId":"GetV2BillingCadencesId","parameters":[{"name":"id","in":"path","description":"The ID of the billing cadence to retrieve.","required":true,"style":"simple","schema":{"type":"string"}},{"name":"include","in":"query","description":"Additional resource to include in the response.","required":false,"style":"deepObject","schema":{"type":"array","items":{"type":"string","enum":["settings_data"],"x-stripeEnum":{"kind":"open","values":[{"description":"Include parameter to expose expanded settings data on the cadence.","value":"settings_data"}]}}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.cadence"},"examples":{"example":{"value":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"active","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.billing_cadence_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_retrieve_cadence","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie"},"requestBody":{}},"response":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"active","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}}],"x-stripeErrors":[{"code":"billing_cadence_not_found","description":"Returned when the provided billing_cadence ID cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true},"post":{"summary":"Update a Billing Cadence","description":"Update a Billing Cadence object.","operationId":"PostV2BillingCadencesId","parameters":[{"name":"id","in":"path","description":"The ID of the billing Cadence object to update.","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lookup_key":{"type":"string","description":"A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters."},"metadata":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Set of [key-value pairs](/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."},"payer":{"type":"object","properties":{"billing_profile":{"type":"string","description":"The ID of the Billing Profile object which determines how a bill is paid.","x-stripeNotPublic":true,"x-stripeProperty":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.profile"}}}},"description":"The payer determines the entity financially responsible for the bill.","x-stripeNotPublic":true},"settings":{"type":"object","properties":{"bill":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the referenced settings object.","x-stripeNotPublic":true},"version":{"type":"string","description":"An optional field to specify the version of Settings to use.\nIf not provided, this defaults to the `live_version` specified on the setting, any time the settings are used.\nUsing a specific version here prevents the settings from updating, and is discouraged for cadences.\nTo clear a pinned version, set the version to null.","x-stripeNotPublic":true}},"description":"Settings that configure bills generation, which includes calculating totals, tax, and presenting invoices. If null is provided, the current bill settings will be removed from the billing cadence.","x-stripeNotPublic":true},"collection":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the referenced settings object.","x-stripeNotPublic":true},"version":{"type":"string","description":"An optional field to specify the version of Settings to use.\nIf not provided, this defaults to the `live_version` specified on the setting, any time the settings are used.\nUsing a specific version here prevents the settings from updating, and is discouraged for cadences.\nTo clear a pinned version, set the version to null.","x-stripeNotPublic":true}},"description":"Settings that configure and manage the behavior of collecting payments. If null is provided, the current collection settings will be removed from the billing cadence.","x-stripeNotPublic":true}},"description":"The settings associated with the cadence.","x-stripeNotPublic":true}}},"examples":{"example":{"value":{"pathParams":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie"},"requestBody":{"metadata":{"key":"value"}}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.cadence"},"examples":{"example":{"value":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":1,"minute":0}}},"metadata":{"key":"value"},"status":"active","next_billing_date":"2025-01-03T01:00:00.000Z","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":false}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.bill_settings_not_found"},{"$ref":"#/components/schemas/v2.error.bill_settings_version_not_found"},{"$ref":"#/components/schemas/v2.error.billing_cadence_not_found"},{"$ref":"#/components/schemas/v2.error.billing_profile_not_found_for_cadence"},{"$ref":"#/components/schemas/v2.error.collection_settings_not_found"},{"$ref":"#/components/schemas/v2.error.collection_settings_version_not_found"},{"$ref":"#/components/schemas/v2.error.customer_not_found"},{"$ref":"#/components/schemas/v2.error.customer_tax_location_invalid"},{"$ref":"#/components/schemas/v2.error.invalid_customer"},{"$ref":"#/components/schemas/v2.error.invalid_test_clock_on_payer"},{"$ref":"#/components/schemas/v2.error.lookup_key_already_used"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_update_cadence","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie"},"requestBody":{"metadata":{"key":"value"}}},"response":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":1,"minute":0}}},"metadata":{"key":"value"},"status":"active","next_billing_date":"2025-01-03T01:00:00.000Z","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":false}}],"x-stripeErrors":[{"code":"bill_settings_not_found","description":"Returned when the bill settings ID cannot be found.","httpStatusCode":404},{"code":"bill_settings_version_not_found","description":"Returned when the provided bill settings version ID cannot be found.","httpStatusCode":404},{"code":"billing_cadence_not_found","description":"Returned when the provided billing_cadence ID cannot be found.","httpStatusCode":404},{"code":"billing_profile_not_found_for_cadence","description":"Returned when the provided billing profile ID cannot be found.","httpStatusCode":400},{"code":"collection_settings_not_found","description":"Returned when the collection settings ID cannot be found.","httpStatusCode":404},{"code":"collection_settings_version_not_found","description":"Returned when the provided collection settings version ID cannot be found.","httpStatusCode":404},{"code":"customer_not_found","description":"Returned when the customer for the provided ID cannot be found.","httpStatusCode":404},{"code":"customer_tax_location_invalid","description":"Returned when creating or updating a cadence with a customer whose tax location isn't recognized.","httpStatusCode":400},{"code":"invalid_customer","description":"Returned when creating or updating a cadence with a deleted customer.","httpStatusCode":400},{"code":"invalid_test_clock_on_payer","description":"Returned when the payer that is being updated on a billing cadence has a test_clock that conflicts with the current test_clock.","httpStatusCode":400},{"code":"lookup_key_already_used","description":"Returned when another object of the same type already has the given lookup key.","httpStatusCode":400}],"x-stripeNotPublic":true}},"/v2/billing/cadences/{id}/cancel":{"post":{"summary":"Cancel a Billing Cadence","description":"Cancel the Billing Cadence.","operationId":"PostV2BillingCadencesIdCancel","parameters":[{"name":"id","in":"path","description":"The ID of the billing Cadence to cancel.","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.cadence"},"examples":{"example":{"value":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"canceled","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.billing_cadence_active"},{"$ref":"#/components/schemas/v2.error.billing_cadence_canceled"},{"$ref":"#/components/schemas/v2.error.billing_cadence_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_cancel_cadence","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie"},"requestBody":{}},"response":{"id":"bc_test_61Rc0IonJY96mpyHA16RM8VQESSQ4t1K5KYFAmKUSCie","object":"v2.billing.cadence","payer":{"type":"customer","customer":"cus_61Rc0HZtJCE9h"},"billing_cycle":{"type":"month","interval_count":1,"month":{"day_of_month":3,"time":{"hour":0,"minute":0}}},"metadata":{},"status":"canceled","test_clock":"clock_1QScHiH5wvQ9UC0VklUiPqw4","created":"2024-11-26T16:33:03.000Z","livemode":true}}],"x-stripeErrors":[{"code":"billing_cadence_active","description":"Returned when trying to cancel a billing cadence that has active and/or unbilled subscriptions.","httpStatusCode":400},{"code":"billing_cadence_canceled","description":"Returned when trying to cancel a billing cadence that has already been canceled.","httpStatusCode":400},{"code":"billing_cadence_not_found","description":"Returned when the provided billing_cadence ID cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true}},"/v2/billing/collection_settings":{"get":{"summary":"List Collection Settings","description":"List all CollectionSetting objects.","operationId":"GetV2BillingCollectionSettings","parameters":[{"name":"limit","in":"query","description":"Optionally set the maximum number of results per page. Defaults to 20.","required":false,"style":"form","schema":{"type":"integer"}},{"name":"lookup_keys","in":"query","description":"Only return the settings with these lookup_keys, if any exist.\nYou can specify up to 10 lookup_keys.","required":false,"style":"deepObject","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"required":["data","next_page_url","previous_page_url"],"type":"object","properties":{"data":{"type":"array","description":"The list of retrieved CollectionSetting.","items":{"$ref":"#/components/schemas/v2.billing.collection_setting"}},"next_page_url":{"type":"string","description":"URL to fetch the next page of the list. If there are no more pages, the value is null.","nullable":true},"previous_page_url":{"type":"string","description":"URL to fetch the previous page of the list. If there are no previous pages, the value is null.","nullable":true}}},"examples":{"example":{"value":{"data":[{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"automatic","created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}]}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_list_collection_settings","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{},"gated":true},"response":{"data":[{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"automatic","created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}]}}],"x-stripeErrors":[],"x-stripeNotPublic":true},"post":{"summary":"Create a Collection Setting","description":"Create a CollectionSetting object.","operationId":"PostV2BillingCollectionSettings","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"collection_method":{"type":"string","description":"Either automatic, or send_invoice. When charging automatically, Stripe attempts to pay this\nbill at the end of the period using the payment method attached to the billing profile. When sending an invoice,\nStripe emails your billing profile an invoice with payment instructions.\nDefaults to automatic.","enum":["automatic","send_invoice"],"x-stripeEnum":{"kind":"closed","values":[{"description":"Automatically charge for collection.","value":"automatic"},{"description":"Send invoice for collection.","value":"send_invoice"}]}},"display_name":{"type":"string","description":"An optional customer-facing display name for the CollectionSetting object.\nMaximum length of 250 characters."},"email_delivery":{"type":"object","properties":{"payment_due":{"required":["enabled","include_payment_link"],"type":"object","properties":{"enabled":{"type":"boolean","description":"If true an email for the invoice would be generated and sent out."},"include_payment_link":{"type":"boolean","description":"If true the payment link to hosted invoice page would be included in email and PDF of the invoice."}},"description":"Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state."}},"description":"Email delivery setting."},"lookup_key":{"type":"string","description":"A lookup key used to retrieve settings dynamically from a static string.\nThis may be up to 200 characters."},"payment_method_configuration":{"type":"string","description":"The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers."},"payment_method_options":{"type":"object","properties":{"acss_debit":{"type":"object","properties":{"mandate_options":{"type":"object","properties":{"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"],"x-stripeEnum":{"kind":"open","values":[{"description":"Transactions are made for business reasons.","value":"business"},{"description":"Transactions are made for personal reasons.","value":"personal"}]}}},"description":"Additional fields for Mandate creation."},"verification_method":{"type":"string","description":"Verification method.","enum":["automatic","instant","microdeposits"],"x-stripeEnum":{"kind":"open","values":[{"description":"Instant verification with fallback to microdeposits.","value":"automatic"},{"description":"Instant verification.","value":"instant"},{"description":"Microdeposits.","value":"microdeposits"}]}}},"description":"This sub-hash contains details about the Canadian pre-authorized debit payment method options."},"bancontact":{"type":"object","properties":{"preferred_language":{"type":"string","description":"Preferred language of the Bancontact authorization page that the customer is redirected to.","enum":["de","en","fr","nl"],"x-stripeEnum":{"kind":"open","values":[{"description":"German.","value":"de"},{"description":"English.","value":"en"},{"description":"French.","value":"fr"},{"description":"Dutch.","value":"nl"}]}}},"description":"This sub-hash contains details about the Bancontact payment method."},"card":{"type":"object","properties":{"mandate_options":{"type":"object","properties":{"amount":{"type":"string","description":"Amount to be charged for future payments.","format":"int64"},"amount_type":{"type":"string","description":"The AmountType for the mandate. One of `fixed` or `maximum`.","enum":["fixed","maximum"],"x-stripeEnum":{"kind":"open","values":[{"description":"If `fixed`, the `amount` param refers to the exact amount to be charged in future payments.","value":"fixed"},{"description":"If `maximum`, the amount charged can be up to the value passed for the `amount` param.","value":"maximum"}]}},"description":{"type":"string","description":"A description of the mandate that is meant to be displayed to the customer."}},"description":"Configuration options for setting up an eMandate for cards issued in India."},"network":{"type":"string","description":"Selected network to process the payment on. Depends on the available networks of the card."},"request_three_d_secure":{"type":"string","description":"An advanced option 3D Secure. We strongly recommend that you rely on our SCA Engine to automatically prompt your customers\nfor authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication).\nHowever, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.\nRead our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"],"x-stripeEnum":{"kind":"open","values":[{"description":"Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any\nadditional input from the customer. 3DS is always attempted if supported for the card, but Stripe can't guarantee your preference because\nthe issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our [guide](https://stripe.com/guides/3d-secure-2#frictionless-authentication).","value":"any"},{"description":"Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements. This is the default option.","value":"automatic"},{"description":"Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can't\nguarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our [guide](https://stripe.com/guides/3d-secure-2#frictionless-authentication).","value":"challenge"}]}}},"description":"This sub-hash contains details about the Card payment method options."},"customer_balance":{"type":"object","properties":{"bank_transfer":{"type":"object","properties":{"eu_bank_transfer":{"required":["country"],"type":"object","properties":{"country":{"type":"string","description":"The desired country code of the bank account information.","enum":["BE","DE","ES","FR","IE","NL"],"x-stripeEnum":{"kind":"open","values":[{"description":"Belgium.","value":"BE"},{"description":"Germany.","value":"DE"},{"description":"Spain.","value":"ES"},{"description":"France.","value":"FR"},{"description":"Ireland.","value":"IE"},{"description":"Netherlands.","value":"NL"}]}}},"description":"Configuration for `eu_bank_transfer` funding type. Required if `type` is `eu_bank_transfer`."},"type":{"type":"string","description":"The bank transfer type that can be used for funding.","enum":["eu_bank_transfer","gb_bank_transfer","jp_bank_transfer","mx_bank_transfer","us_bank_transfer"],"x-stripeEnum":{"kind":"open","values":[{"description":"EU Bank Transfer.","value":"eu_bank_transfer"},{"description":"GB Bank Transfer.","value":"gb_bank_transfer"},{"description":"JP Bank Transfer.","value":"jp_bank_transfer"},{"description":"MX Bank Transfer.","value":"mx_bank_transfer"},{"description":"US Bank Transfer.","value":"us_bank_transfer"}]}}},"description":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`."},"funding_type":{"type":"string","description":"The funding method type to be used when there are not enough funds in the customer balance. Currently the only supported value is `bank_transfer`.","enum":["bank_transfer"],"x-stripeEnum":{"kind":"open","values":[{"description":"Bank Transfer funding type.","value":"bank_transfer"}]}}},"description":"This sub-hash contains details about the Bank transfer payment method options."},"konbini":{"type":"object","properties":{},"description":"This sub-hash contains details about the Konbini payment method options."},"sepa_debit":{"type":"object","properties":{},"description":"This sub-hash contains details about the SEPA Direct Debit payment method options."},"us_bank_account":{"required":["financial_connections","verification_method"],"type":"object","properties":{"financial_connections":{"type":"object","properties":{"filters":{"type":"object","properties":{"account_subcategories":{"type":"array","description":"The account subcategories to use to filter for selectable accounts.","items":{"type":"string","enum":["checking","savings"],"x-stripeEnum":{"kind":"open","values":[{"description":"Bank account subcategory is checking.","value":"checking"},{"description":"Bank account subcategory is savings.","value":"savings"}]}}}},"description":"Provide filters for the linked accounts that the customer can select for the payment method."},"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included.","items":{"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeEnum":{"kind":"open","values":[{"description":"Balances permission.","value":"balances"},{"description":"Ownership permission.","value":"ownership"},{"description":"Payment method permission.","value":"payment_method"},{"description":"Transactions permission.","value":"transactions"}]}}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","ownership","transactions"],"x-stripeEnum":{"kind":"open","values":[{"description":"Requests to prefetch balance data on accounts collected in this session.","value":"balances"},{"description":"Requests to prefetch ownership data on accounts collected in this session.","value":"ownership"},{"description":"Requests to prefetch transaction data on accounts collected in this session.","value":"transactions"}]}}}},"description":"Additional fields for Financial Connections Session creation."},"verification_method":{"type":"string","description":"Verification method.","enum":["automatic","instant","microdeposits"],"x-stripeEnum":{"kind":"open","values":[{"description":"Instant verification with fallback to microdeposits.","value":"automatic"},{"description":"Instant verification only.","value":"instant"},{"description":"Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.","value":"microdeposits"}]}}},"description":"This sub-hash contains details about the ACH direct debit payment method options."}},"description":"Payment Method specific configuration to be stored on the object."}}},"examples":{"example":{"value":{"pathParams":{},"requestBody":{"collection_method":"automatic","display_name":"Automatic collection settings"},"gated":true}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.collection_setting"},"examples":{"example":{"value":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"automatic","created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.email_delivery_incompatible_with_collection_method"},{"$ref":"#/components/schemas/v2.error.invalid_payment_method_configuration_for_collection_setting"},{"$ref":"#/components/schemas/v2.error.lookup_key_already_used_for_collection_setting"},{"$ref":"#/components/schemas/v2.error.payment_method_configuration_not_found_for_collection_setting"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_create_collection_setting","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{"collection_method":"automatic","display_name":"Automatic collection settings"},"gated":true},"response":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"automatic","created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}],"x-stripeErrors":[{"code":"email_delivery_incompatible_with_collection_method","description":"Returned when the email delivery is incompatible with the collection method.","httpStatusCode":400},{"code":"invalid_payment_method_configuration_for_collection_setting","description":"Returned when the payment method configuration is not active.","httpStatusCode":400},{"code":"lookup_key_already_used_for_collection_setting","description":"Returned when the lookup key is already used for a collection setting.","httpStatusCode":400},{"code":"payment_method_configuration_not_found_for_collection_setting","description":"Returned when the payment method configuration cannot be found.","httpStatusCode":400}],"x-stripeNotPublic":true}},"/v2/billing/collection_settings/{collection_setting_id}/versions":{"get":{"summary":"List Collection Setting Versions","description":"List all CollectionSettingVersions by CollectionSetting ID.","operationId":"GetV2BillingCollectionSettingsCollectionSettingIdVersions","parameters":[{"name":"collection_setting_id","in":"path","description":"ID of the CollectionSettings to retrieve versions for.","required":true,"style":"simple","schema":{"type":"string","x-stripeParam":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.collection_setting"}}}},{"name":"limit","in":"query","description":"Optionally set the maximum number of results per page. Defaults to 20.","required":false,"style":"form","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"required":["data","next_page_url","previous_page_url"],"type":"object","properties":{"data":{"type":"array","description":"The list of retrieved CollectionSettingVersions.","items":{"$ref":"#/components/schemas/v2.billing.collection_setting_version"}},"next_page_url":{"type":"string","description":"URL to fetch the next page of the list. If there are no more pages, the value is null.","nullable":true},"previous_page_url":{"type":"string","description":"URL to fetch the previous page of the list. If there are no previous pages, the value is null.","nullable":true}}},"examples":{"example":{"value":{"data":[{"collection_method":"automatic","created":"2025-01-01T00:00:00.000Z","id":"bclsetv_test_61T2gtFFCeOrTS7PB16Sg5eV2tSQs27bdBltKwQGm1No","object":"v2.billing.collection_setting_version","payment_method_configuration":"pmc_234","payment_method_options":{"acss_debit":{"mandate_options":{"transaction_type":"business"},"verification_method":"automatic"},"bancontact":{"preferred_language":"de"},"card":{"mandate_options":{"amount":1000,"amount_type":"maximum","description":"Test mandate"},"network":"visa","request_three_d_secure":"any"},"customer_balance":{"bank_transfer":{"eu_bank_transfer":{"country":"BE"},"type":"eu_bank_transfer"},"funding_type":"bank_transfer"},"konbini":{},"sepa_debit":{},"us_bank_account":{"financial_connections":{"filters":{"account_subcategories":["checking"]},"permissions":["balances"],"prefetch":["balances"]},"verification_method":"automatic"}},"livemode":true}],"next_page_url":null,"previous_page_url":null}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.collection_setting_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_list_collection_setting_versions","x-stripeDocsSamples":[{"request":{"pathParams":{"collection_setting_id":"bclset_test_61T2gtFM6pBAo30oj16Sg5eV2tSQs27bdBltKwQGmSI4"},"requestBody":{}},"response":{"data":[{"collection_method":"automatic","created":"2025-01-01T00:00:00.000Z","id":"bclsetv_test_61T2gtFFCeOrTS7PB16Sg5eV2tSQs27bdBltKwQGm1No","object":"v2.billing.collection_setting_version","payment_method_configuration":"pmc_234","payment_method_options":{"acss_debit":{"mandate_options":{"transaction_type":"business"},"verification_method":"automatic"},"bancontact":{"preferred_language":"de"},"card":{"mandate_options":{"amount":1000,"amount_type":"maximum","description":"Test mandate"},"network":"visa","request_three_d_secure":"any"},"customer_balance":{"bank_transfer":{"eu_bank_transfer":{"country":"BE"},"type":"eu_bank_transfer"},"funding_type":"bank_transfer"},"konbini":{},"sepa_debit":{},"us_bank_account":{"financial_connections":{"filters":{"account_subcategories":["checking"]},"permissions":["balances"],"prefetch":["balances"]},"verification_method":"automatic"}},"livemode":true}],"next_page_url":null,"previous_page_url":null}}],"x-stripeErrors":[{"code":"collection_setting_not_found","description":"Returned when the collection setting cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true}},"/v2/billing/collection_settings/{collection_setting_id}/versions/{id}":{"get":{"summary":"Retrieve a Collection Setting Version","description":"Retrieve a CollectionSetting Version by ID.","operationId":"GetV2BillingCollectionSettingsCollectionSettingIdVersionsId","parameters":[{"name":"collection_setting_id","in":"path","description":"The ID of the CollectionSetting that has the version.","required":true,"style":"simple","schema":{"type":"string","x-stripeParam":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.collection_setting"}}}},{"name":"id","in":"path","description":"The ID of the CollectionSettingVersion.","required":true,"style":"simple","schema":{"type":"string","x-stripeParam":{"referenced_resource":{"$ref":"#/components/schemas/v2.billing.collection_setting_version"}}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.collection_setting_version"},"examples":{"example":{"value":{"collection_method":"automatic","created":"2025-01-01T00:00:00.000Z","id":"bclsetv_test_61T2gtFFCeOrTS7PB16Sg5eV2tSQs27bdBltKwQGm1No","object":"v2.billing.collection_setting_version","payment_method_configuration":"pmc_234","payment_method_options":{"acss_debit":{"mandate_options":{"transaction_type":"business"},"verification_method":"automatic"},"bancontact":{"preferred_language":"de"},"card":{"mandate_options":{"amount":1000,"amount_type":"maximum","description":"Test mandate"},"network":"visa","request_three_d_secure":"any"},"customer_balance":{"bank_transfer":{"eu_bank_transfer":{"country":"BE"},"type":"eu_bank_transfer"},"funding_type":"bank_transfer"},"konbini":{},"sepa_debit":{},"us_bank_account":{"financial_connections":{"filters":{"account_subcategories":["checking"]},"permissions":["balances"],"prefetch":["balances"]},"verification_method":"automatic"}},"livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.collection_setting_not_found"},{"$ref":"#/components/schemas/v2.error.collection_setting_version_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_retrieve_collection_setting_version","x-stripeDocsSamples":[{"request":{"pathParams":{"collection_setting_id":"bclset_test_61T2gtFM6pBAo30oj16Sg5eV2tSQs27bdBltKwQGmSI4","id":"bclsetv_test_61T2gtFFCeOrTS7PB16Sg5eV2tSQs27bdBltKwQGm1No"},"requestBody":{}},"response":{"collection_method":"automatic","created":"2025-01-01T00:00:00.000Z","id":"bclsetv_test_61T2gtFFCeOrTS7PB16Sg5eV2tSQs27bdBltKwQGm1No","object":"v2.billing.collection_setting_version","payment_method_configuration":"pmc_234","payment_method_options":{"acss_debit":{"mandate_options":{"transaction_type":"business"},"verification_method":"automatic"},"bancontact":{"preferred_language":"de"},"card":{"mandate_options":{"amount":1000,"amount_type":"maximum","description":"Test mandate"},"network":"visa","request_three_d_secure":"any"},"customer_balance":{"bank_transfer":{"eu_bank_transfer":{"country":"BE"},"type":"eu_bank_transfer"},"funding_type":"bank_transfer"},"konbini":{},"sepa_debit":{},"us_bank_account":{"financial_connections":{"filters":{"account_subcategories":["checking"]},"permissions":["balances"],"prefetch":["balances"]},"verification_method":"automatic"}},"livemode":true}}],"x-stripeErrors":[{"code":"collection_setting_not_found","description":"Returned when the collection setting cannot be found.","httpStatusCode":404},{"code":"collection_setting_version_not_found","description":"Returned when the collection setting version cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true}},"/v2/billing/collection_settings/{id}":{"get":{"summary":"Retrieve a Collection Setting","description":"Retrieve a CollectionSetting by ID.","operationId":"GetV2BillingCollectionSettingsId","parameters":[{"name":"id","in":"path","description":"The ID of the CollectionSetting.","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.collection_setting"},"examples":{"example":{"value":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"automatic","created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.collection_setting_not_found"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_retrieve_collection_setting","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI"},"requestBody":{},"gated":true},"response":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"automatic","created":"2025-01-01T10:00:00.000Z","display_name":"Automatic tax settings","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}],"x-stripeErrors":[{"code":"collection_setting_not_found","description":"Returned when the collection setting cannot be found.","httpStatusCode":404}],"x-stripeNotPublic":true},"post":{"summary":"Update a Collection Setting","description":"Update fields on an existing CollectionSetting.","operationId":"PostV2BillingCollectionSettingsId","parameters":[{"name":"id","in":"path","description":"The ID of the CollectionSetting.","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"collection_method":{"type":"string","description":"Either automatic, or send_invoice. When charging automatically, Stripe attempts to pay this\nbill at the end of the period using the payment method attached to the billing profile. When sending an invoice,\nStripe emails your billing profile an invoice with payment instructions.","enum":["automatic","send_invoice"],"x-stripeEnum":{"kind":"closed","values":[{"description":"Automatically charge for collection.","value":"automatic"},{"description":"Send invoice for collection.","value":"send_invoice"}]}},"display_name":{"type":"string","description":"An optional customer-facing display name for the CollectionSetting object.\nTo remove the display name, set it to an empty string in the request.\nMaximum length of 250 characters."},"email_delivery":{"type":"object","properties":{"payment_due":{"required":["enabled","include_payment_link"],"type":"object","properties":{"enabled":{"type":"boolean","description":"If true an email for the invoice would be generated and sent out."},"include_payment_link":{"type":"boolean","description":"If true the payment link to hosted invoice page would be included in email and PDF of the invoice."}},"description":"Controls emails for when the payment is due. For example after the invoice is finalized and transitions to Open state."}},"description":"Email delivery settings."},"live_version":{"type":"string","description":"Optionally change the live version of the CollectionSetting. Billing Cadences and other objects that refer to this\nCollectionSetting uses this version when no overrides are set. Providing `live_version = \"latest\"` sets the\nCollectionSetting's `live_version` to its latest version."},"lookup_key":{"type":"string","description":"A lookup key used to retrieve settings dynamically from a static string.\nThis may be up to 200 characters."},"payment_method_configuration":{"type":"string","description":"The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers."},"payment_method_options":{"type":"object","properties":{"acss_debit":{"type":"object","properties":{"mandate_options":{"type":"object","properties":{"transaction_type":{"type":"string","description":"Transaction type of the mandate.","enum":["business","personal"],"x-stripeEnum":{"kind":"open","values":[{"description":"Transactions are made for business reasons.","value":"business"},{"description":"Transactions are made for personal reasons.","value":"personal"}]}}},"description":"Additional fields for Mandate creation."},"verification_method":{"type":"string","description":"Verification method.","enum":["automatic","instant","microdeposits"],"x-stripeEnum":{"kind":"open","values":[{"description":"Instant verification with fallback to microdeposits.","value":"automatic"},{"description":"Instant verification.","value":"instant"},{"description":"Microdeposits.","value":"microdeposits"}]}}},"description":"This sub-hash contains details about the Canadian pre-authorized debit payment method options."},"bancontact":{"type":"object","properties":{"preferred_language":{"type":"string","description":"Preferred language of the Bancontact authorization page that the customer is redirected to.","enum":["de","en","fr","nl"],"x-stripeEnum":{"kind":"open","values":[{"description":"German.","value":"de"},{"description":"English.","value":"en"},{"description":"French.","value":"fr"},{"description":"Dutch.","value":"nl"}]}}},"description":"This sub-hash contains details about the Bancontact payment method."},"card":{"type":"object","properties":{"mandate_options":{"type":"object","properties":{"amount":{"type":"string","description":"Amount to be charged for future payments.","format":"int64"},"amount_type":{"type":"string","description":"The AmountType for the mandate. One of `fixed` or `maximum`.","enum":["fixed","maximum"],"x-stripeEnum":{"kind":"open","values":[{"description":"If `fixed`, the `amount` param refers to the exact amount to be charged in future payments.","value":"fixed"},{"description":"If `maximum`, the amount charged can be up to the value passed for the `amount` param.","value":"maximum"}]}},"description":{"type":"string","description":"A description of the mandate that is meant to be displayed to the customer."}},"description":"Configuration options for setting up an eMandate for cards issued in India."},"network":{"type":"string","description":"Selected network to process the payment on. Depends on the available networks of the card."},"request_three_d_secure":{"type":"string","description":"An advanced option 3D Secure. We strongly recommend that you rely on our SCA Engine to automatically prompt your customers\nfor authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication).\nHowever, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.\nRead our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.","enum":["any","automatic","challenge"],"x-stripeEnum":{"kind":"open","values":[{"description":"Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any\nadditional input from the customer. 3DS is always attempted if supported for the card, but Stripe can't guarantee your preference because\nthe issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our [guide](https://stripe.com/guides/3d-secure-2#frictionless-authentication).","value":"any"},{"description":"Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements. This is the default option.","value":"automatic"},{"description":"Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can't\nguarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our [guide](https://stripe.com/guides/3d-secure-2#frictionless-authentication).","value":"challenge"}]}}},"description":"This sub-hash contains details about the Card payment method options."},"customer_balance":{"type":"object","properties":{"bank_transfer":{"type":"object","properties":{"eu_bank_transfer":{"required":["country"],"type":"object","properties":{"country":{"type":"string","description":"The desired country code of the bank account information.","enum":["BE","DE","ES","FR","IE","NL"],"x-stripeEnum":{"kind":"open","values":[{"description":"Belgium.","value":"BE"},{"description":"Germany.","value":"DE"},{"description":"Spain.","value":"ES"},{"description":"France.","value":"FR"},{"description":"Ireland.","value":"IE"},{"description":"Netherlands.","value":"NL"}]}}},"description":"Configuration for `eu_bank_transfer` funding type. Required if `type` is `eu_bank_transfer`."},"type":{"type":"string","description":"The bank transfer type that can be used for funding.","enum":["eu_bank_transfer","gb_bank_transfer","jp_bank_transfer","mx_bank_transfer","us_bank_transfer"],"x-stripeEnum":{"kind":"open","values":[{"description":"EU Bank Transfer.","value":"eu_bank_transfer"},{"description":"GB Bank Transfer.","value":"gb_bank_transfer"},{"description":"JP Bank Transfer.","value":"jp_bank_transfer"},{"description":"MX Bank Transfer.","value":"mx_bank_transfer"},{"description":"US Bank Transfer.","value":"us_bank_transfer"}]}}},"description":"Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`."},"funding_type":{"type":"string","description":"The funding method type to be used when there are not enough funds in the customer balance. Currently the only supported value is `bank_transfer`.","enum":["bank_transfer"],"x-stripeEnum":{"kind":"open","values":[{"description":"Bank Transfer funding type.","value":"bank_transfer"}]}}},"description":"This sub-hash contains details about the Bank transfer payment method options."},"konbini":{"type":"object","properties":{},"description":"This sub-hash contains details about the Konbini payment method options."},"sepa_debit":{"type":"object","properties":{},"description":"This sub-hash contains details about the SEPA Direct Debit payment method options."},"us_bank_account":{"required":["financial_connections","verification_method"],"type":"object","properties":{"financial_connections":{"type":"object","properties":{"filters":{"type":"object","properties":{"account_subcategories":{"type":"array","description":"The account subcategories to use to filter for selectable accounts.","items":{"type":"string","enum":["checking","savings"],"x-stripeEnum":{"kind":"open","values":[{"description":"Bank account subcategory is checking.","value":"checking"},{"description":"Bank account subcategory is savings.","value":"savings"}]}}}},"description":"Provide filters for the linked accounts that the customer can select for the payment method."},"permissions":{"type":"array","description":"The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included.","items":{"type":"string","enum":["balances","ownership","payment_method","transactions"],"x-stripeEnum":{"kind":"open","values":[{"description":"Balances permission.","value":"balances"},{"description":"Ownership permission.","value":"ownership"},{"description":"Payment method permission.","value":"payment_method"},{"description":"Transactions permission.","value":"transactions"}]}}},"prefetch":{"type":"array","description":"List of data features that you would like to retrieve upon account creation.","items":{"type":"string","enum":["balances","ownership","transactions"],"x-stripeEnum":{"kind":"open","values":[{"description":"Requests to prefetch balance data on accounts collected in this session.","value":"balances"},{"description":"Requests to prefetch ownership data on accounts collected in this session.","value":"ownership"},{"description":"Requests to prefetch transaction data on accounts collected in this session.","value":"transactions"}]}}}},"description":"Additional fields for Financial Connections Session creation."},"verification_method":{"type":"string","description":"Verification method.","enum":["automatic","instant","microdeposits"],"x-stripeEnum":{"kind":"open","values":[{"description":"Instant verification with fallback to microdeposits.","value":"automatic"},{"description":"Instant verification only.","value":"instant"},{"description":"Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.","value":"microdeposits"}]}}},"description":"This sub-hash contains details about the ACH direct debit payment method options."}},"description":"Payment Method specific configuration to be stored on the object."}}},"examples":{"example":{"value":{"pathParams":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI"},"requestBody":{"display_name":"New name","collection_method":"send_invoice"},"gated":true}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.collection_setting"},"examples":{"example":{"value":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"send_invoice","created":"2025-01-01T10:00:00.000Z","display_name":"New name","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.collection_method_incompatible_with_email_delivery"},{"$ref":"#/components/schemas/v2.error.collection_setting_not_found"},{"$ref":"#/components/schemas/v2.error.email_delivery_incompatible_with_collection_method"},{"$ref":"#/components/schemas/v2.error.invalid_payment_method_configuration_for_collection_setting"},{"$ref":"#/components/schemas/v2.error.lookup_key_already_used_for_collection_setting"},{"$ref":"#/components/schemas/v2.error.payment_method_configuration_not_found_for_collection_setting"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_update_collection_setting","x-stripeDocsSamples":[{"request":{"pathParams":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI"},"requestBody":{"display_name":"New name","collection_method":"send_invoice"},"gated":true},"response":{"id":"bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI","object":"v2.billing.collection_setting","collection_method":"send_invoice","created":"2025-01-01T10:00:00.000Z","display_name":"New name","latest_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","live_version":"bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum","livemode":true}}],"x-stripeErrors":[{"code":"collection_method_incompatible_with_email_delivery","description":"Returned when the collection method is incompatible with the email delivery.","httpStatusCode":400},{"code":"collection_setting_not_found","description":"Returned when the collection setting cannot be found.","httpStatusCode":404},{"code":"email_delivery_incompatible_with_collection_method","description":"Returned when the email delivery is incompatible with the collection method.","httpStatusCode":400},{"code":"invalid_payment_method_configuration_for_collection_setting","description":"Returned when the payment method configuration is not active.","httpStatusCode":400},{"code":"lookup_key_already_used_for_collection_setting","description":"Returned when the lookup key is already used for a collection setting.","httpStatusCode":400},{"code":"payment_method_configuration_not_found_for_collection_setting","description":"Returned when the payment method configuration cannot be found.","httpStatusCode":400}],"x-stripeNotPublic":true}},"/v2/billing/meter_event_adjustments":{"post":{"summary":"Create a Meter Event Adjustment","description":"Creates a meter event adjustment to cancel a previously sent meter event.","operationId":"PostV2BillingMeterEventAdjustments","requestBody":{"content":{"application/json":{"schema":{"required":["cancel","event_name","type"],"type":"object","properties":{"cancel":{"required":["identifier"],"type":"object","properties":{"identifier":{"type":"string","description":"The identifier that was originally assigned to the meter event. You can only cancel events within 24 hours of Stripe receiving them."}},"description":"Specifies which event to cancel."},"event_name":{"type":"string","description":"The name of the meter event. Corresponds with the `event_name` field on a meter."},"type":{"type":"string","description":"Specifies the type of cancellation. Currently supports canceling a single event.","enum":["cancel"],"x-stripeEnum":{"kind":"open","values":[{"description":"Cancel a single meter event by identifier.","value":"cancel"}]}}}},"examples":{"example":{"value":{"pathParams":{},"requestBody":{"event_name":"ai_search_api","type":"cancel","cancel":{"identifier":"idmp_12345678"}}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.meter_event_adjustment"},"examples":{"example":{"value":{"object":"v2.billing.meter_event_adjustment","id":"mtr_event_adj_12345678","livemode":false,"created":"2024-06-01T12:00:00.000Z","status":"pending","event_name":"ai_search_api","type":"cancel","cancel":{"identifier":"idmp_12345678"}}}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/v2.error.invalid_cancel_configuration"},{"$ref":"#/components/schemas/v2.error"}]}}}}},"x-stableId":"v2_method_create_usage_adjustment_v2_synchronous","x-stripeDocsSamples":[{"request":{"pathParams":{},"requestBody":{"event_name":"ai_search_api","type":"cancel","cancel":{"identifier":"idmp_12345678"}}},"response":{"object":"v2.billing.meter_event_adjustment","id":"mtr_event_adj_12345678","livemode":false,"created":"2024-06-01T12:00:00.000Z","status":"pending","event_name":"ai_search_api","type":"cancel","cancel":{"identifier":"idmp_12345678"}}}],"x-stripeErrors":[{"code":"invalid_cancel_configuration","description":"The adjustment configuration is invalid for the adjustment type.","httpStatusCode":400}]}},"/v2/billing/meter_event_session":{"post":{"summary":"Create a Meter Event Stream Authentication Session","description":"Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you need to create a new meter event session when your token expires.","operationId":"PostV2BillingMeterEventSession","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2.billing.meter_event_session"},"examples":{"example":{"value":{"id":"