From 42970bd8f104cea73a73ec3e27acd67bfa8abad8 Mon Sep 17 00:00:00 2001 From: Yordis Prieto Date: Thu, 22 Aug 2024 16:21:39 -0400 Subject: [PATCH] fix: run sdk codegen for latest version Signed-off-by: Yordis Prieto --- .latest-tag-stripe-openapi-sdk | 2 +- priv/openapi/spec3.sdk.json | 30694 ++++++++++++++++++++++++++----- 2 files changed, 26601 insertions(+), 4095 deletions(-) diff --git a/.latest-tag-stripe-openapi-sdk b/.latest-tag-stripe-openapi-sdk index d1b8380a..931be459 100644 --- a/.latest-tag-stripe-openapi-sdk +++ b/.latest-tag-stripe-openapi-sdk @@ -1 +1 @@ -v755 +v1214 diff --git a/priv/openapi/spec3.sdk.json b/priv/openapi/spec3.sdk.json index 4a5eabbe..d2074d19 100644 --- a/priv/openapi/spec3.sdk.json +++ b/priv/openapi/spec3.sdk.json @@ -2,7 +2,7 @@ "components": { "schemas": { "account": { - "description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that\naccount has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links)\nfor a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**\nbelow. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).", + "description": "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).", "properties": { "business_profile": { "anyOf": [ @@ -14,7 +14,7 @@ "nullable": true }, "business_type": { - "description": "The business type.", + "description": "The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "enum": [ "company", "government_entity", @@ -54,7 +54,7 @@ "type": "string" }, "details_submitted": { - "description": "Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.", + "description": "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.", "type": "boolean" }, "email": { @@ -64,7 +64,7 @@ "type": "string" }, "external_accounts": { - "description": "External accounts (bank accounts and debit cards) currently attached to this account", + "description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", @@ -148,10 +148,11 @@ "$ref": "#/components/schemas/account_tos_acceptance" }, "type": { - "description": "The Stripe account type. Can be `standard`, `express`, or `custom`.", + "description": "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.", "enum": [ "custom", "express", + "none", "standard" ], "type": "string" @@ -177,6 +178,13 @@ ], "x-resourceId": "account", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/accounts/{account}" + }, { "method_name": "retrieve", "method_on": "service", @@ -184,6 +192,13 @@ "operation": "get", "path": "/v1/account" }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/accounts" + }, { "method_name": "retrieve", "method_on": "service", @@ -192,18 +207,18 @@ "path": "/v1/accounts/{account}" }, { - "method_name": "update", + "method_name": "capabilities", "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/accounts/{account}" + "method_type": "custom", + "operation": "get", + "path": "/v1/accounts/{account}/capabilities" }, { - "method_name": "list", + "method_name": "persons", "method_on": "service", - "method_type": "list", + "method_type": "custom", "operation": "get", - "path": "/v1/accounts" + "path": "/v1/accounts/{account}/persons" }, { "method_name": "create", @@ -213,10 +228,10 @@ "path": "/v1/accounts" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", + "method_type": "update", + "operation": "post", "path": "/v1/accounts/{account}" }, { @@ -225,20 +240,6 @@ "method_type": "custom", "operation": "post", "path": "/v1/accounts/{account}/reject" - }, - { - "method_name": "persons", - "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/accounts/{account}/persons" - }, - { - "method_name": "capabilities", - "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/accounts/{account}/capabilities" } ], "x-stripeResource": { @@ -377,6 +378,35 @@ "type": "account.updated" } }, + "account_annual_revenue": { + "description": "", + "properties": { + "amount": { + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", + "nullable": true, + "type": "integer" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "nullable": true, + "type": "string" + }, + "fiscal_year_end": { + "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "amount", + "currency", + "fiscal_year_end" + ], + "title": "AccountAnnualRevenue", + "type": "object", + "x-expandableFields": [] + }, "account_bacs_debit_payments_settings": { "description": "", "properties": { @@ -473,8 +503,22 @@ "account_business_profile": { "description": "", "properties": { + "annual_revenue": { + "anyOf": [ + { + "$ref": "#/components/schemas/account_annual_revenue" + } + ], + "description": "The applicant's gross annual revenue for its preceding fiscal year.", + "nullable": true + }, + "estimated_worker_count": { + "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", + "nullable": true, + "type": "integer" + }, "mcc": { - "description": "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "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.", "maxLength": 5000, "nullable": true, "type": "string" @@ -529,6 +573,8 @@ } }, "required": [ + "annual_revenue", + "estimated_worker_count", "mcc", "name", "support_address", @@ -540,6 +586,7 @@ "title": "AccountBusinessProfile", "type": "object", "x-expandableFields": [ + "annual_revenue", "monthly_estimated_revenue", "support_address" ] @@ -574,6 +621,15 @@ ], "type": "string" }, + "amazon_pay_payments": { + "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "au_becs_debit_payments": { "description": "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.", "enum": [ @@ -682,6 +738,15 @@ ], "type": "string" }, + "gb_bank_transfer_payments": { + "description": "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "giropay_payments": { "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.", "enum": [ @@ -727,6 +792,15 @@ ], "type": "string" }, + "jp_bank_transfer_payments": { + "description": "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "klarna_payments": { "description": "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.", "enum": [ @@ -763,6 +837,33 @@ ], "type": "string" }, + "mobilepay_payments": { + "description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, + "multibanco_payments": { + "description": "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, + "mx_bank_transfer_payments": { + "description": "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "oxxo_payments": { "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.", "enum": [ @@ -808,6 +909,15 @@ ], "type": "string" }, + "sepa_bank_transfer_payments": { + "description": "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "sepa_debit_payments": { "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.", "enum": [ @@ -826,6 +936,15 @@ ], "type": "string" }, + "swish_payments": { + "description": "The status of the Swish capability of the account, or whether the account can directly process Swish payments.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "tax_reporting_us_1099_k": { "description": "The status of the tax reporting 1099-K (US) capability of the account.", "enum": [ @@ -862,6 +981,15 @@ ], "type": "string" }, + "twint_payments": { + "description": "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "us_bank_account_ach_payments": { "description": "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.", "enum": [ @@ -871,6 +999,15 @@ ], "type": "string" }, + "us_bank_transfer_payments": { + "description": "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "zip_payments": { "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges.", "enum": [ @@ -911,8 +1048,19 @@ "type": "array" }, "disabled_reason": { - "description": "This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.", - "maxLength": 5000, + "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.", + "enum": [ + "other", + "paused.inactivity", + "pending.onboarding", + "pending.review", + "platform_disabled", + "platform_paused", + "rejected.inactivity", + "rejected.other", + "rejected.unsupported_business", + "requirements.fields_needed" + ], "nullable": true, "type": "string" }, @@ -940,7 +1088,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -991,8 +1139,19 @@ "type": "array" }, "disabled_reason": { - "description": "If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`.\n\n`rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service:\n\n- [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses)\n\nIf you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance.", - "maxLength": 5000, + "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).", + "enum": [ + "other", + "paused.inactivity", + "pending.onboarding", + "pending.review", + "platform_disabled", + "platform_paused", + "rejected.inactivity", + "rejected.other", + "rejected.unsupported_business", + "requirements.fields_needed" + ], "nullable": true, "type": "string" }, @@ -1020,7 +1179,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -1197,7 +1356,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -1223,6 +1382,42 @@ "errors" ] }, + "account_invoices_settings": { + "description": "", + "properties": { + "default_account_tax_ids": { + "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/tax_id" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/tax_id" + } + ] + } + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "default_account_tax_ids" + ], + "title": "AccountInvoicesSettings", + "type": "object", + "x-expandableFields": [ + "default_account_tax_ids" + ] + }, "account_link": { "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)", "properties": { @@ -1277,7 +1472,7 @@ "description": "", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -1303,25 +1498,25 @@ "type": "string" }, "statement_descriptor_kana": { - "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only)", + "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kanji": { - "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only)", + "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kana": { - "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.", + "description": "The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_prefix_kanji": { - "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.", + "description": "The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 5000, "nullable": true, "type": "string" @@ -1342,7 +1537,7 @@ "description": "", "properties": { "debit_negative_balances": { - "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`.", + "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.", "type": "boolean" }, "schedule": { @@ -1425,7 +1620,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -1565,13 +1760,15 @@ "verification_failed_keyed_match", "verification_failed_name_match", "verification_failed_other", + "verification_failed_representative_authority", "verification_failed_residential_address", "verification_failed_tax_id_match", "verification_failed_tax_id_not_issued", "verification_missing_directors", "verification_missing_executives", "verification_missing_owners", - "verification_requires_additional_memorandum_of_associations" + "verification_requires_additional_memorandum_of_associations", + "verification_requires_additional_proof_of_registration" ], "type": "string", "x-stripeBypassValidation": true @@ -1688,6 +1885,9 @@ "dashboard": { "$ref": "#/components/schemas/account_dashboard_settings" }, + "invoices": { + "$ref": "#/components/schemas/account_invoices_settings" + }, "payments": { "$ref": "#/components/schemas/account_payments_settings" }, @@ -1715,6 +1915,7 @@ "card_issuing", "card_payments", "dashboard", + "invoices", "payments", "payouts", "sepa_debit_payments", @@ -1796,10 +1997,27 @@ "account_unification_account_controller": { "description": "", "properties": { + "fees": { + "$ref": "#/components/schemas/account_unification_account_controller_fees" + }, "is_controller": { "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.", "type": "boolean" }, + "losses": { + "$ref": "#/components/schemas/account_unification_account_controller_losses" + }, + "requirement_collection": { + "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.", + "enum": [ + "application", + "stripe" + ], + "type": "string" + }, + "stripe_dashboard": { + "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard" + }, "type": { "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.", "enum": [ @@ -1814,6 +2032,71 @@ ], "title": "AccountUnificationAccountController", "type": "object", + "x-expandableFields": [ + "fees", + "losses", + "stripe_dashboard" + ] + }, + "account_unification_account_controller_fees": { + "description": "", + "properties": { + "payer": { + "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).", + "enum": [ + "account", + "application", + "application_custom", + "application_express" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "payer" + ], + "title": "AccountUnificationAccountControllerFees", + "type": "object", + "x-expandableFields": [] + }, + "account_unification_account_controller_losses": { + "description": "", + "properties": { + "payments": { + "description": "A value indicating who is liable when this account can't pay back negative balances from payments.", + "enum": [ + "application", + "stripe" + ], + "type": "string" + } + }, + "required": [ + "payments" + ], + "title": "AccountUnificationAccountControllerLosses", + "type": "object", + "x-expandableFields": [] + }, + "account_unification_account_controller_stripe_dashboard": { + "description": "", + "properties": { + "type": { + "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application.", + "enum": [ + "express", + "full", + "none" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "AccountUnificationAccountControllerStripeDashboard", + "type": "object", "x-expandableFields": [] }, "address": { @@ -1916,6 +2199,7 @@ "charge_already_refunded", "charge_disputed", "charge_exceeds_source_limit", + "charge_exceeds_transaction_limit", "charge_expired_for_capture", "charge_invalid_parameter", "charge_not_refundable", @@ -1931,6 +2215,10 @@ "expired_card", "financial_connections_account_inactive", "financial_connections_no_successful_transaction_refresh", + "forwarding_api_inactive", + "forwarding_api_invalid_parameter", + "forwarding_api_upstream_connection_error", + "forwarding_api_upstream_connection_timeout", "idempotency_key_in_use", "incorrect_address", "incorrect_cvc", @@ -1949,6 +2237,7 @@ "invalid_cvc", "invalid_expiry_month", "invalid_expiry_year", + "invalid_mandate_reference_prefix_format", "invalid_number", "invalid_source_usage", "invalid_tax_location", @@ -2026,6 +2315,7 @@ "setup_intent_mandate_invalid", "setup_intent_setup_attempt_expired", "setup_intent_unexpected_state", + "shipping_address_invalid", "shipping_calculation_failed", "sku_inactive", "state_unsupported", @@ -2036,6 +2326,7 @@ "terminal_location_country_unsupported", "terminal_reader_busy", "terminal_reader_hardware_fault", + "terminal_reader_invalid_location_for_payment", "terminal_reader_offline", "terminal_reader_timeout", "testmode_charges_only", @@ -2161,17 +2452,17 @@ "x-resourceId": "apple_pay_domain", "x-stripeOperations": [ { - "method_name": "list", + "method_name": "delete", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/apple_pay/domains" + "method_type": "delete", + "operation": "delete", + "path": "/v1/apple_pay/domains/{domain}" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/apple_pay/domains" }, { @@ -2182,11 +2473,11 @@ "path": "/v1/apple_pay/domains/{domain}" }, { - "method_name": "delete", + "method_name": "create", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/apple_pay/domains/{domain}" + "method_type": "create", + "operation": "post", + "path": "/v1/apple_pay/domains" } ], "x-stripeResource": { @@ -2327,6 +2618,15 @@ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, + "fee_source": { + "anyOf": [ + { + "$ref": "#/components/schemas/platform_earning_fee_source" + } + ], + "description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -2416,6 +2716,7 @@ "charge", "created", "currency", + "fee_source", "id", "livemode", "object", @@ -2430,6 +2731,7 @@ "application", "balance_transaction", "charge", + "fee_source", "originating_transaction", "refunds" ], @@ -2563,7 +2865,6 @@ "livemode", "name", "object", - "payload", "scope" ], "title": "SecretServiceResourceSecret", @@ -2573,6 +2874,13 @@ ], "x-resourceId": "apps.secret", "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/apps/secrets" + }, { "method_name": "find", "method_on": "service", @@ -2593,13 +2901,6 @@ "method_type": "custom", "operation": "post", "path": "/v1/apps/secrets/delete" - }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/apps/secrets" } ], "x-stripeResource": { @@ -2615,6 +2916,15 @@ "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true + }, "status": { "description": "The status of the most recent automated tax calculation for this invoice.", "enum": [ @@ -2628,11 +2938,14 @@ }, "required": [ "enabled", + "liability", "status" ], "title": "AutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "balance": { "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)", @@ -2645,7 +2958,7 @@ "type": "array" }, "connect_reserved": { - "description": "Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.", + "description": "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, @@ -2782,6 +3095,13 @@ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, + "net_available": { + "description": "Breakdown of balance by destination.", + "items": { + "$ref": "#/components/schemas/balance_net_available" + }, + "type": "array" + }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } @@ -2793,6 +3113,7 @@ "title": "BalanceAmountNet", "type": "object", "x-expandableFields": [ + "net_available", "source_types" ] }, @@ -2816,6 +3137,32 @@ "available" ] }, + "balance_net_available": { + "description": "", + "properties": { + "amount": { + "description": "Net balance amount, subtracting fees from platform-set pricing.", + "type": "integer" + }, + "destination": { + "description": "ID of the external account for this net balance (not expandable).", + "maxLength": 5000, + "type": "string" + }, + "source_types": { + "$ref": "#/components/schemas/balance_amount_by_source_type" + } + }, + "required": [ + "amount", + "destination" + ], + "title": "BalanceNetAvailable", + "type": "object", + "x-expandableFields": [ + "source_types" + ] + }, "balance_transaction": { "description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)", "properties": { @@ -3030,9 +3377,6 @@ { "$ref": "#/components/schemas/payout" }, - { - "$ref": "#/components/schemas/platform_tax_fee" - }, { "$ref": "#/components/schemas/refund" }, @@ -3059,7 +3403,7 @@ } }, "bank_account": { - "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)", + "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected accounts.\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](/payments/bank-debits-transfers)", "properties": { "account": { "anyOf": [ @@ -3214,7 +3558,7 @@ "type": "string" }, "status": { - "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.", + "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.", "maxLength": 5000, "type": "string" } @@ -3244,11 +3588,11 @@ "x-resourceId": "bank_account", "x-stripeOperations": [ { - "method_name": "update", + "method_name": "delete", "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/customers/{customer}/sources/{id}" + "method_type": "delete", + "operation": "delete", + "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "delete", @@ -3258,25 +3602,25 @@ "path": "/v1/customers/{customer}/sources/{id}" }, { - "method_name": "verify", + "method_name": "update", "method_on": "service", - "method_type": "custom", + "method_type": "update", "operation": "post", - "path": "/v1/customers/{customer}/sources/{id}/verify" + "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "update", "method_on": "service", "method_type": "update", "operation": "post", - "path": "/v1/accounts/{account}/external_accounts/{id}" + "path": "/v1/customers/{customer}/sources/{id}" }, { - "method_name": "delete", + "method_name": "verify", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/accounts/{account}/external_accounts/{id}" + "method_type": "custom", + "operation": "post", + "path": "/v1/customers/{customer}/sources/{id}/verify" } ], "x-stripeResource": { @@ -3368,7 +3712,7 @@ "additionalProperties": { "type": "integer" }, - "description": "The balances owed to (or by) the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", + "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "type": "object" }, "type": { @@ -3399,7 +3743,7 @@ "additionalProperties": { "type": "integer" }, - "description": "The funds available to the account holder. Typically this is the current balance less any holds.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", + "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.", "nullable": true, "type": "object" } @@ -3466,6 +3810,21 @@ "bank_connections_resource_link_account_session_filters": { "description": "", "properties": { + "account_subcategories": { + "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", + "items": { + "enum": [ + "checking", + "credit_card", + "line_of_credit", + "mortgage", + "savings" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, "countries": { "description": "List of countries from which to filter accounts.", "items": { @@ -3477,6 +3836,7 @@ } }, "required": [ + "account_subcategories", "countries" ], "title": "BankConnectionsResourceLinkAccountSessionFilters", @@ -3491,6 +3851,12 @@ "format": "unix-time", "type": "integer" }, + "next_refresh_available_at": { + "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, "status": { "description": "The status of the last refresh attempt.", "enum": [ @@ -3503,6 +3869,7 @@ }, "required": [ "last_attempted_at", + "next_refresh_available_at", "status" ], "title": "BankConnectionsResourceOwnershipRefresh", @@ -3572,6 +3939,551 @@ "type": "object", "x-expandableFields": [] }, + "billing.alert": { + "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.", + "properties": { + "alert_type": { + "description": "Defines the type of the alert.", + "enum": [ + "usage_threshold" + ], + "type": "string" + }, + "filter": { + "anyOf": [ + { + "$ref": "#/components/schemas/thresholds_resource_alert_filter" + } + ], + "description": "Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers).", + "nullable": true + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.alert" + ], + "type": "string" + }, + "status": { + "description": "Status of the alert. This can be active, inactive or archived.", + "enum": [ + "active", + "archived", + "inactive" + ], + "nullable": true, + "type": "string" + }, + "title": { + "description": "Title of the alert.", + "maxLength": 5000, + "type": "string" + }, + "usage_threshold_config": { + "anyOf": [ + { + "$ref": "#/components/schemas/thresholds_resource_usage_threshold_config" + } + ], + "description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).", + "nullable": true + } + }, + "required": [ + "alert_type", + "filter", + "id", + "livemode", + "object", + "status", + "title", + "usage_threshold_config" + ], + "title": "ThresholdsResourceAlert", + "type": "object", + "x-expandableFields": [ + "filter", + "usage_threshold_config" + ], + "x-resourceId": "billing.alert", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/billing/alerts" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/billing/alerts/{id}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/billing/alerts" + }, + { + "method_name": "activate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/billing/alerts/{id}/activate" + }, + { + "method_name": "archive", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/billing/alerts/{id}/archive" + }, + { + "method_name": "deactivate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/billing/alerts/{id}/deactivate" + } + ], + "x-stripeResource": { + "class_name": "Alert", + "has_collection_class": true, + "in_package": "Billing" + } + }, + "billing.alert.triggered": { + "description": "Occurs whenever your custom alert threshold is met.", + "properties": { + "object": { + "$ref": "#/components/schemas/billing.alert_triggered" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "billing.alert.triggered" + } + }, + "billing.alert_triggered": { + "description": "", + "properties": { + "alert": { + "$ref": "#/components/schemas/billing.alert" + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "customer": { + "description": "ID of customer for which the alert triggered", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.alert_triggered" + ], + "type": "string" + }, + "value": { + "description": "The value triggering the alert", + "type": "integer" + } + }, + "required": [ + "alert", + "created", + "customer", + "livemode", + "object", + "value" + ], + "title": "ThresholdsResourceAlert", + "type": "object", + "x-expandableFields": [ + "alert" + ], + "x-stripeResource": { + "class_name": "AlertTriggered", + "in_package": "Billing" + } + }, + "billing.meter": { + "description": "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "customer_mapping": { + "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings" + }, + "default_aggregation": { + "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings" + }, + "display_name": { + "description": "The meter's name.", + "maxLength": 5000, + "type": "string" + }, + "event_name": { + "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.", + "maxLength": 5000, + "type": "string" + }, + "event_time_window": { + "description": "The time window to pre-aggregate meter events for, if any.", + "enum": [ + "day", + "hour" + ], + "nullable": true, + "type": "string" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter" + ], + "type": "string" + }, + "status": { + "description": "The meter's status.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "status_transitions": { + "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions" + }, + "updated": { + "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "value_settings": { + "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value" + } + }, + "required": [ + "created", + "customer_mapping", + "default_aggregation", + "display_name", + "event_name", + "event_time_window", + "id", + "livemode", + "object", + "status", + "status_transitions", + "updated", + "value_settings" + ], + "title": "BillingMeter", + "type": "object", + "x-expandableFields": [ + "customer_mapping", + "default_aggregation", + "status_transitions", + "value_settings" + ], + "x-resourceId": "billing.meter", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/billing/meters" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/billing/meters/{id}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/billing/meters" + }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/billing/meters/{id}" + }, + { + "method_name": "deactivate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/billing/meters/{id}/deactivate" + }, + { + "method_name": "reactivate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/billing/meters/{id}/reactivate" + } + ], + "x-stripeResource": { + "class_name": "Meter", + "has_collection_class": true, + "in_package": "Billing" + } + }, + "billing.meter_event": { + "description": "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, + "identifier": { + "description": "A unique identifier for the event.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter_event" + ], + "type": "string" + }, + "payload": { + "additionalProperties": { + "maxLength": 100, + "type": "string" + }, + "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).", + "type": "object" + }, + "timestamp": { + "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "created", + "event_name", + "identifier", + "livemode", + "object", + "payload", + "timestamp" + ], + "title": "BillingMeterEvent", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "billing.meter_event", + "x-stripeOperations": [ + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/billing/meter_events" + } + ], + "x-stripeResource": { + "class_name": "MeterEvent", + "in_package": "Billing" + } + }, + "billing.meter_event_adjustment": { + "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.", + "properties": { + "cancel": { + "anyOf": [ + { + "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel" + } + ], + "description": "Specifies which event to cancel.", + "nullable": true + }, + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter_event_adjustment" + ], + "type": "string" + }, + "status": { + "description": "The meter event adjustment's status.", + "enum": [ + "complete", + "pending" + ], + "type": "string" + }, + "type": { + "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.", + "enum": [ + "cancel" + ], + "type": "string" + } + }, + "required": [ + "cancel", + "event_name", + "livemode", + "object", + "status", + "type" + ], + "title": "BillingMeterEventAdjustment", + "type": "object", + "x-expandableFields": [ + "cancel" + ], + "x-resourceId": "billing.meter_event_adjustment", + "x-stripeOperations": [ + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/billing/meter_event_adjustments" + } + ], + "x-stripeResource": { + "class_name": "MeterEventAdjustment", + "in_package": "Billing" + } + }, + "billing.meter_event_summary": { + "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.", + "properties": { + "aggregated_value": { + "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.", + "type": "number" + }, + "end_time": { + "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.", + "format": "unix-time", + "type": "integer" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "meter": { + "description": "The meter associated with this event summary.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter_event_summary" + ], + "type": "string" + }, + "start_time": { + "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "aggregated_value", + "end_time", + "id", + "livemode", + "meter", + "object", + "start_time" + ], + "title": "BillingMeterEventSummary", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "billing.meter_event_summary", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/billing/meters/{id}/event_summaries" + } + ], + "x-stripeResource": { + "class_name": "MeterEventSummary", + "has_collection_class": true, + "in_package": "Billing" + } + }, "billing_details": { "description": "", "properties": { @@ -3615,6 +4527,99 @@ "address" ] }, + "billing_meter_resource_aggregation_settings": { + "description": "", + "properties": { + "formula": { + "description": "Specifies how events are aggregated.", + "enum": [ + "count", + "sum" + ], + "type": "string" + } + }, + "required": [ + "formula" + ], + "title": "BillingMeterResourceAggregationSettings", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_billing_meter_event_adjustment_cancel": { + "description": "", + "properties": { + "identifier": { + "description": "Unique identifier for the event.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "required": [ + "identifier" + ], + "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_billing_meter_status_transitions": { + "description": "", + "properties": { + "deactivated_at": { + "description": "The time the meter was deactivated, if any. Measured in seconds since Unix epoch.", + "format": "unix-time", + "nullable": true, + "type": "integer" + } + }, + "required": [ + "deactivated_at" + ], + "title": "BillingMeterResourceBillingMeterStatusTransitions", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_billing_meter_value": { + "description": "", + "properties": { + "event_payload_key": { + "description": "The key in the meter event payload to use as the value for this meter.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "event_payload_key" + ], + "title": "BillingMeterResourceBillingMeterValue", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_customer_mapping_settings": { + "description": "", + "properties": { + "event_payload_key": { + "description": "The key in the meter event payload to use for mapping the event to a customer.", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "The method for mapping a meter event to a customer.", + "enum": [ + "by_id" + ], + "type": "string" + } + }, + "required": [ + "event_payload_key", + "type" + ], + "title": "BillingMeterResourceCustomerMappingSettings", + "type": "object", + "x-expandableFields": [] + }, "billing_portal.configuration": { "description": "A portal configuration describes the functionality and behavior of a portal session.", "properties": { @@ -3735,6 +4740,13 @@ "operation": "get", "path": "/v1/billing_portal/configurations" }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/billing_portal/configurations/{configuration}" + }, { "method_name": "create", "method_on": "service", @@ -3748,13 +4760,6 @@ "method_type": "update", "operation": "post", "path": "/v1/billing_portal/configurations/{configuration}" - }, - { - "method_name": "retrieve", - "method_on": "service", - "method_type": "retrieve", - "operation": "get", - "path": "/v1/billing_portal/configurations/{configuration}" } ], "x-stripeResource": { @@ -3796,7 +4801,7 @@ } }, "billing_portal.session": { - "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nLearn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).", + "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)", "properties": { "configuration": { "anyOf": [ @@ -3907,7 +4912,7 @@ "type": "string" }, "on_behalf_of": { - "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", + "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "maxLength": 5000, "nullable": true, "type": "string" @@ -4168,7 +5173,7 @@ "$ref": "#/components/schemas/account" } ], - "description": "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.", + "description": "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -4239,7 +5244,7 @@ "type": "array" }, "brand": { - "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.", + "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.", "maxLength": 5000, "type": "string" }, @@ -4250,7 +5255,7 @@ "type": "string" }, "currency": { - "description": "Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.", + "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). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "nullable": true, "type": "string" }, @@ -4287,7 +5292,7 @@ "type": "string" }, "default_for_currency": { - "description": "Whether this card is the default external account for its currency.", + "description": "Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", "nullable": true, "type": "boolean" }, @@ -4356,6 +5361,9 @@ "nullable": true, "type": "string" }, + "networks": { + "$ref": "#/components/schemas/token_card_networks" + }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ @@ -4403,16 +5411,17 @@ "type": "object", "x-expandableFields": [ "account", - "customer" + "customer", + "networks" ], "x-resourceId": "card", "x-stripeOperations": [ { - "method_name": "update", + "method_name": "delete", "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/customers/{customer}/sources/{id}" + "method_type": "delete", + "operation": "delete", + "path": "/v1/accounts/{account}/external_accounts/{id}" }, { "method_name": "delete", @@ -4429,11 +5438,11 @@ "path": "/v1/accounts/{account}/external_accounts/{id}" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/accounts/{account}/external_accounts/{id}" + "method_type": "update", + "operation": "post", + "path": "/v1/customers/{customer}/sources/{id}" } ], "x-stripeResource": { @@ -4447,6 +5456,27 @@ ] } }, + "card_generated_from_payment_method_details": { + "description": "", + "properties": { + "card_present": { + "$ref": "#/components/schemas/payment_method_details_card_present" + }, + "type": { + "description": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "card_generated_from_payment_method_details", + "type": "object", + "x-expandableFields": [ + "card_present" + ] + }, "card_issuing_account_terms_of_service": { "description": "", "properties": { @@ -4608,7 +5638,7 @@ "$ref": "#/components/schemas/application_fee" } ], - "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.", + "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -4619,7 +5649,7 @@ } }, "application_fee_amount": { - "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.", + "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.", "nullable": true, "type": "integer" }, @@ -4652,7 +5682,7 @@ "$ref": "#/components/schemas/billing_details" }, "calculated_statement_descriptor": { - "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.", + "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.", "maxLength": 5000, "nullable": true, "type": "string" @@ -4975,7 +6005,7 @@ "$ref": "#/components/schemas/transfer" } ], - "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.", + "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -4986,13 +6016,13 @@ } }, "statement_descriptor": { - "description": "For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.", + "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.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 5000, "nullable": true, "type": "string" @@ -5076,7 +6106,6 @@ "receipt_number", "receipt_url", "refunded", - "refunds", "review", "shipping", "source", @@ -5115,18 +6144,25 @@ "x-resourceId": "charge", "x-stripeOperations": [ { - "method_name": "search", + "method_name": "list", "method_on": "service", - "method_type": "custom", + "method_type": "list", "operation": "get", - "path": "/v1/charges/search" + "path": "/v1/charges" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/charges" + "path": "/v1/charges/{charge}" + }, + { + "method_name": "search", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/charges/search" }, { "method_name": "create", @@ -5135,13 +6171,6 @@ "operation": "post", "path": "/v1/charges" }, - { - "method_name": "retrieve", - "method_on": "service", - "method_type": "retrieve", - "operation": "get", - "path": "/v1/charges/{charge}" - }, { "method_name": "update", "method_on": "service", @@ -5216,7 +6245,7 @@ } }, "charge.dispute.funds_reinstated": { - "description": "Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](/docs/disputes#disputes-on-partially-refunded-payments).", + "description": "Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](https://docs.stripe.com/disputes#disputes-on-partially-refunded-payments).", "properties": { "object": { "$ref": "#/components/schemas/dispute" @@ -5529,7 +6558,7 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax" }, "billing_address_collection": { - "description": "Describes whether Checkout should collect the customer's billing address.", + "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -5589,11 +6618,11 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_currency_conversion" } ], - "description": "Currency conversion details for automatic currency conversion sessions", + "description": "Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions", "nullable": true }, "custom_fields": { - "description": "Collect additional information from your customer using custom fields. Up to 2 fields are supported.", + "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields" }, @@ -5643,7 +6672,7 @@ "$ref": "#/components/schemas/payment_pages_checkout_session_customer_details" } ], - "description": "The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in `setup` mode.", + "description": "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.", "nullable": true }, "customer_email": { @@ -5818,7 +6847,7 @@ "$ref": "#/components/schemas/payment_intent" } ], - "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode.", + "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -5849,7 +6878,7 @@ } }, "payment_method_collection": { - "description": "Configure whether a Checkout Session should collect a payment method.", + "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`.", "enum": [ "always", "if_required" @@ -5902,7 +6931,7 @@ "type": "string" }, "redirect_on_completion": { - "description": "Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -5915,6 +6944,15 @@ "maxLength": 5000, "type": "string" }, + "saved_payment_method_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options" + } + ], + "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", + "nullable": true + }, "setup_intent": { "anyOf": [ { @@ -5925,7 +6963,7 @@ "$ref": "#/components/schemas/setup_intent" } ], - "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode.", + "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -5980,7 +7018,7 @@ "type": "string" }, "submit_type": { - "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode, but not Checkout Sessions\nin `subscription` or `setup` mode. Possible values are `auto`, `pay`, `book`, `donate`. If blank or `auto`, `pay` is used.", + "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.", "enum": [ "auto", "book", @@ -6029,7 +7067,7 @@ "nullable": true }, "ui_mode": { - "description": "The UI mode of the Session. Can be `hosted` (default) or `embedded`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -6083,6 +7121,7 @@ "payment_method_types", "payment_status", "recovered_from", + "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", @@ -6116,6 +7155,7 @@ "payment_method_configuration_details", "payment_method_options", "phone_number_collection", + "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", @@ -6141,6 +7181,13 @@ "operation": "get", "path": "/v1/checkout/sessions/{session}" }, + { + "method_name": "list_line_items", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/checkout/sessions/{session}/line_items" + }, { "method_name": "create", "method_on": "service", @@ -6149,11 +7196,11 @@ "path": "/v1/checkout/sessions" }, { - "method_name": "list_line_items", + "method_name": "update", "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/checkout/sessions/{session}/line_items" + "method_type": "update", + "operation": "post", + "path": "/v1/checkout/sessions/{session}" }, { "method_name": "expire", @@ -6302,7 +7349,7 @@ "$ref": "#/components/schemas/checkout_acss_debit_mandate_options" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -6331,7 +7378,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6346,7 +7393,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6365,7 +7412,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6376,11 +7423,27 @@ "type": "object", "x-expandableFields": [] }, + "checkout_amazon_pay_payment_method_options": { + "description": "", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "CheckoutAmazonPayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "checkout_au_becs_debit_payment_method_options": { "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6395,7 +7458,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -6412,7 +7475,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6431,7 +7494,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -6465,8 +7528,18 @@ "installments": { "$ref": "#/components/schemas/checkout_card_installments_options" }, + "request_three_d_secure": { + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "enum": [ + "any", + "automatic", + "challenge" + ], + "type": "string", + "x-stripeBypassValidation": true + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -6485,6 +7558,9 @@ "type": "string" } }, + "required": [ + "request_three_d_secure" + ], "title": "CheckoutCardPaymentMethodOptions", "type": "object", "x-expandableFields": [ @@ -6495,7 +7571,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6567,7 +7643,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6587,7 +7663,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6602,7 +7678,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6617,7 +7693,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6632,7 +7708,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6647,7 +7723,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6662,7 +7738,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -6684,7 +7760,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6702,7 +7778,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -6714,6 +7790,36 @@ "type": "object", "x-expandableFields": [] }, + "checkout_mobilepay_payment_method_options": { + "description": "", + "properties": { + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\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" + ], + "type": "string" + } + }, + "title": "CheckoutMobilepayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, + "checkout_multibanco_payment_method_options": { + "description": "", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "CheckoutMultibancoPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "checkout_oxxo_payment_method_options": { "description": "", "properties": { @@ -6722,7 +7828,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6740,7 +7846,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6755,7 +7861,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6789,7 +7895,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -6823,7 +7929,16 @@ }, "checkout_revolut_pay_payment_method_options": { "description": "", - "properties": {}, + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, "title": "CheckoutRevolutPayPaymentMethodOptions", "type": "object", "x-expandableFields": [] @@ -6832,7 +7947,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -6860,6 +7975,9 @@ "alipay": { "$ref": "#/components/schemas/checkout_alipay_payment_method_options" }, + "amazon_pay": { + "$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options" + }, "au_becs_debit": { "$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options" }, @@ -6905,6 +8023,12 @@ "link": { "$ref": "#/components/schemas/checkout_link_payment_method_options" }, + "mobilepay": { + "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options" + }, + "multibanco": { + "$ref": "#/components/schemas/checkout_multibanco_payment_method_options" + }, "oxxo": { "$ref": "#/components/schemas/checkout_oxxo_payment_method_options" }, @@ -6929,6 +8053,9 @@ "sofort": { "$ref": "#/components/schemas/checkout_sofort_payment_method_options" }, + "swish": { + "$ref": "#/components/schemas/checkout_swish_payment_method_options" + }, "us_bank_account": { "$ref": "#/components/schemas/checkout_us_bank_account_payment_method_options" } @@ -6940,6 +8067,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -6955,6 +8083,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -6963,6 +8093,7 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", "us_bank_account" ] }, @@ -6970,7 +8101,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -6981,6 +8112,23 @@ "type": "object", "x-expandableFields": [] }, + "checkout_swish_payment_method_options": { + "description": "", + "properties": { + "reference": { + "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference" + ], + "title": "CheckoutSwishPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "checkout_us_bank_account_payment_method_options": { "description": "", "properties": { @@ -6988,7 +8136,7 @@ "$ref": "#/components/schemas/linked_account_options_us_bank_account" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -7191,18 +8339,18 @@ "x-resourceId": "climate.order", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/climate/orders/{order}" + "path": "/v1/climate/orders" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/climate/orders" + "path": "/v1/climate/orders/{order}" }, { "method_name": "create", @@ -7386,18 +8534,18 @@ "x-resourceId": "climate.product", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/climate/products/{product}" + "path": "/v1/climate/products" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/climate/products" + "path": "/v1/climate/products/{product}" } ], "x-stripeResource": { @@ -7501,18 +8649,18 @@ "x-resourceId": "climate.supplier", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/climate/suppliers/{supplier}" + "path": "/v1/climate/suppliers" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/climate/suppliers" + "path": "/v1/climate/suppliers/{supplier}" } ], "x-stripeResource": { @@ -7650,6 +8798,575 @@ "type": "object", "x-expandableFields": [] }, + "confirmation_token": { + "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "expires_at": { + "description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "mandate_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data" + } + ], + "description": "Data used for generating a Mandate.", + "nullable": true + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "confirmation_token" + ], + "type": "string" + }, + "payment_intent": { + "description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "payment_method_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options" + } + ], + "description": "Payment-method-specific configuration for this ConfirmationToken.", + "nullable": true + }, + "payment_method_preview": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview" + } + ], + "description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.", + "nullable": true + }, + "return_url": { + "description": "Return URL used to confirm the Intent.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.", + "enum": [ + "off_session", + "on_session" + ], + "nullable": true, + "type": "string" + }, + "setup_intent": { + "description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "shipping": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_shipping" + } + ], + "description": "Shipping information collected on this ConfirmationToken.", + "nullable": true + }, + "use_stripe_sdk": { + "description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.", + "type": "boolean" + } + }, + "required": [ + "created", + "expires_at", + "id", + "livemode", + "object", + "payment_intent", + "payment_method_options", + "payment_method_preview", + "return_url", + "setup_future_usage", + "setup_intent", + "shipping", + "use_stripe_sdk" + ], + "title": "ConfirmationTokensResourceConfirmationToken", + "type": "object", + "x-expandableFields": [ + "mandate_data", + "payment_method_options", + "payment_method_preview", + "shipping" + ], + "x-resourceId": "confirmation_token", + "x-stripeOperations": [ + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/confirmation_tokens/{confirmation_token}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/test_helpers/confirmation_tokens" + } + ], + "x-stripeResource": { + "class_name": "ConfirmationToken", + "in_package": "" + } + }, + "confirmation_tokens_resource_mandate_data": { + "description": "Data used for generating a Mandate.", + "properties": { + "customer_acceptance": { + "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance" + } + }, + "required": [ + "customer_acceptance" + ], + "title": "ConfirmationTokensResourceMandateData", + "type": "object", + "x-expandableFields": [ + "customer_acceptance" + ] + }, + "confirmation_tokens_resource_mandate_data_resource_customer_acceptance": { + "description": "This hash contains details about the customer acceptance of the Mandate.", + "properties": { + "online": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online" + } + ], + "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.", + "nullable": true + }, + "type": { + "description": "The type of customer acceptance information included with the Mandate.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "online", + "type" + ], + "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance", + "type": "object", + "x-expandableFields": [ + "online" + ] + }, + "confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online": { + "description": "This hash contains details about the online acceptance.", + "properties": { + "ip_address": { + "description": "The IP address from which the Mandate was accepted by the customer.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_agent": { + "description": "The user agent of the browser from which the Mandate was accepted by the customer.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "ip_address", + "user_agent" + ], + "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline", + "type": "object", + "x-expandableFields": [] + }, + "confirmation_tokens_resource_payment_method_options": { + "description": "Payment-method-specific configuration", + "properties": { + "card": { + "anyOf": [ + { + "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card" + } + ], + "description": "This hash contains the card payment method options.", + "nullable": true + } + }, + "required": [ + "card" + ], + "title": "ConfirmationTokensResourcePaymentMethodOptions", + "type": "object", + "x-expandableFields": [ + "card" + ] + }, + "confirmation_tokens_resource_payment_method_options_resource_card": { + "description": "This hash contains the card payment method options.", + "properties": { + "cvc_token": { + "description": "The `cvc_update` Token collected from the Payment Element.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "cvc_token" + ], + "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard", + "type": "object", + "x-expandableFields": [] + }, + "confirmation_tokens_resource_payment_method_preview": { + "description": "Details of the PaymentMethod collected by Payment Element", + "properties": { + "acss_debit": { + "$ref": "#/components/schemas/payment_method_acss_debit" + }, + "affirm": { + "$ref": "#/components/schemas/payment_method_affirm" + }, + "afterpay_clearpay": { + "$ref": "#/components/schemas/payment_method_afterpay_clearpay" + }, + "alipay": { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" + }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_amazon_pay" + }, + "au_becs_debit": { + "$ref": "#/components/schemas/payment_method_au_becs_debit" + }, + "bacs_debit": { + "$ref": "#/components/schemas/payment_method_bacs_debit" + }, + "bancontact": { + "$ref": "#/components/schemas/payment_method_bancontact" + }, + "billing_details": { + "$ref": "#/components/schemas/billing_details" + }, + "blik": { + "$ref": "#/components/schemas/payment_method_blik" + }, + "boleto": { + "$ref": "#/components/schemas/payment_method_boleto" + }, + "card": { + "$ref": "#/components/schemas/payment_method_card" + }, + "card_present": { + "$ref": "#/components/schemas/payment_method_card_present" + }, + "cashapp": { + "$ref": "#/components/schemas/payment_method_cashapp" + }, + "customer": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/customer" + } + ], + "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/customer" + } + ] + } + }, + "customer_balance": { + "$ref": "#/components/schemas/payment_method_customer_balance" + }, + "eps": { + "$ref": "#/components/schemas/payment_method_eps" + }, + "fpx": { + "$ref": "#/components/schemas/payment_method_fpx" + }, + "giropay": { + "$ref": "#/components/schemas/payment_method_giropay" + }, + "grabpay": { + "$ref": "#/components/schemas/payment_method_grabpay" + }, + "ideal": { + "$ref": "#/components/schemas/payment_method_ideal" + }, + "interac_present": { + "$ref": "#/components/schemas/payment_method_interac_present" + }, + "klarna": { + "$ref": "#/components/schemas/payment_method_klarna" + }, + "konbini": { + "$ref": "#/components/schemas/payment_method_konbini" + }, + "link": { + "$ref": "#/components/schemas/payment_method_link" + }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_mobilepay" + }, + "multibanco": { + "$ref": "#/components/schemas/payment_method_multibanco" + }, + "oxxo": { + "$ref": "#/components/schemas/payment_method_oxxo" + }, + "p24": { + "$ref": "#/components/schemas/payment_method_p24" + }, + "paynow": { + "$ref": "#/components/schemas/payment_method_paynow" + }, + "paypal": { + "$ref": "#/components/schemas/payment_method_paypal" + }, + "pix": { + "$ref": "#/components/schemas/payment_method_pix" + }, + "promptpay": { + "$ref": "#/components/schemas/payment_method_promptpay" + }, + "revolut_pay": { + "$ref": "#/components/schemas/payment_method_revolut_pay" + }, + "sepa_debit": { + "$ref": "#/components/schemas/payment_method_sepa_debit" + }, + "sofort": { + "$ref": "#/components/schemas/payment_method_sofort" + }, + "swish": { + "$ref": "#/components/schemas/payment_method_swish" + }, + "twint": { + "$ref": "#/components/schemas/payment_method_twint" + }, + "type": { + "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", + "enum": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "card", + "card_present", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "interac_present", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "us_bank_account": { + "$ref": "#/components/schemas/payment_method_us_bank_account" + }, + "wechat_pay": { + "$ref": "#/components/schemas/payment_method_wechat_pay" + }, + "zip": { + "$ref": "#/components/schemas/payment_method_zip" + } + }, + "required": [ + "billing_details", + "customer", + "type" + ], + "title": "ConfirmationTokensResourcePaymentMethodPreview", + "type": "object", + "x-expandableFields": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "billing_details", + "blik", + "boleto", + "card", + "card_present", + "cashapp", + "customer", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "interac_present", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip" + ] + }, + "confirmation_tokens_resource_shipping": { + "description": "", + "properties": { + "address": { + "$ref": "#/components/schemas/address" + }, + "name": { + "description": "Recipient name.", + "maxLength": 5000, + "type": "string" + }, + "phone": { + "description": "Recipient phone (including extension).", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "address", + "name", + "phone" + ], + "title": "ConfirmationTokensResourceShipping", + "type": "object", + "x-expandableFields": [ + "address" + ] + }, + "connect_account_reference": { + "description": "", + "properties": { + "account": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/account" + } + ], + "description": "The connected account being referenced when `type` is `account`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/account" + } + ] + } + }, + "type": { + "description": "Type of the account referenced.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "ConnectAccountReference", + "type": "object", + "x-expandableFields": [ + "account" + ] + }, "connect_collection_transfer": { "description": "", "properties": { @@ -7718,35 +9435,114 @@ ] } }, + "connect_embedded_account_config_claim": { + "description": "", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "$ref": "#/components/schemas/connect_embedded_account_features_claim" + } + }, + "required": [ + "enabled", + "features" + ], + "title": "ConnectEmbeddedAccountConfigClaim", + "type": "object", + "x-expandableFields": [ + "features" + ], + "x-stripeResource": { + "class_name": "AccountConfig", + "in_package": "" + } + }, + "connect_embedded_account_features_claim": { + "description": "", + "properties": { + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + } + }, + "required": [ + "external_account_collection" + ], + "title": "ConnectEmbeddedAccountFeaturesClaim", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "AccountFeatures", + "in_package": "" + } + }, "connect_embedded_account_session_create_components": { "description": "", "properties": { + "account_management": { + "$ref": "#/components/schemas/connect_embedded_account_config_claim" + }, "account_onboarding": { + "$ref": "#/components/schemas/connect_embedded_account_config_claim" + }, + "balances": { + "$ref": "#/components/schemas/connect_embedded_payouts_config_claim" + }, + "documents": { "$ref": "#/components/schemas/connect_embedded_base_config_claim" }, + "notification_banner": { + "$ref": "#/components/schemas/connect_embedded_account_config_claim" + }, "payment_details": { - "$ref": "#/components/schemas/connect_embedded_payments_config" + "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payments": { - "$ref": "#/components/schemas/connect_embedded_payments_config" + "$ref": "#/components/schemas/connect_embedded_payments_config_claim" }, "payouts": { - "$ref": "#/components/schemas/connect_embedded_payouts_config" + "$ref": "#/components/schemas/connect_embedded_payouts_config_claim" + }, + "payouts_list": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" + }, + "tax_registrations": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" + }, + "tax_settings": { + "$ref": "#/components/schemas/connect_embedded_base_config_claim" } }, "required": [ + "account_management", "account_onboarding", + "balances", + "documents", + "notification_banner", "payment_details", "payments", - "payouts" + "payouts", + "payouts_list", + "tax_registrations", + "tax_settings" ], "title": "ConnectEmbeddedAccountSessionCreateComponents", "type": "object", "x-expandableFields": [ + "account_management", "account_onboarding", + "balances", + "documents", + "notification_banner", "payment_details", "payments", - "payouts" + "payouts", + "payouts_list", + "tax_registrations", + "tax_settings" ], "x-stripeResource": { "class_name": "Components", @@ -7789,7 +9585,7 @@ "in_package": "" } }, - "connect_embedded_payments_config": { + "connect_embedded_payments_config_claim": { "description": "", "properties": { "enabled": { @@ -7804,7 +9600,7 @@ "enabled", "features" ], - "title": "ConnectEmbeddedPaymentsConfig", + "title": "ConnectEmbeddedPaymentsConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -7821,6 +9617,10 @@ "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, + "destination_on_behalf_of_charge_management": { + "description": "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.", + "type": "boolean" + }, "dispute_management": { "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" @@ -7832,6 +9632,7 @@ }, "required": [ "capture_payments", + "destination_on_behalf_of_charge_management", "dispute_management", "refund_management" ], @@ -7843,7 +9644,7 @@ "in_package": "" } }, - "connect_embedded_payouts_config": { + "connect_embedded_payouts_config_claim": { "description": "", "properties": { "enabled": { @@ -7858,7 +9659,7 @@ "enabled", "features" ], - "title": "ConnectEmbeddedPayoutsConfig", + "title": "ConnectEmbeddedPayoutsConfigClaim", "type": "object", "x-expandableFields": [ "features" @@ -7875,6 +9676,10 @@ "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", "type": "boolean" }, + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", "type": "boolean" @@ -7886,6 +9691,7 @@ }, "required": [ "edit_payout_schedule", + "external_account_collection", "instant_payouts", "standard_payouts" ], @@ -8168,17 +9974,17 @@ "x-resourceId": "coupon", "x-stripeOperations": [ { - "method_name": "list", + "method_name": "delete", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/coupons" + "method_type": "delete", + "operation": "delete", + "path": "/v1/coupons/{coupon}" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/coupons" }, { @@ -8189,17 +9995,17 @@ "path": "/v1/coupons/{coupon}" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/coupons/{coupon}" + "path": "/v1/coupons" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", + "method_type": "update", + "operation": "post", "path": "/v1/coupons/{coupon}" } ], @@ -8511,7 +10317,7 @@ "shipping_cost": { "anyOf": [ { - "$ref": "#/components/schemas/invoices_shipping_cost" + "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied to the invoice.", @@ -8523,7 +10329,8 @@ "issued", "void" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "subtotal": { "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.", @@ -8612,12 +10419,19 @@ "x-resourceId": "credit_note", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/credit_notes" }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/credit_notes/{id}" + }, { "method_name": "preview", "method_on": "service", @@ -8626,17 +10440,17 @@ "path": "/v1/credit_notes/preview" }, { - "method_name": "retrieve", + "method_name": "preview_lines", "method_on": "service", - "method_type": "retrieve", + "method_type": "custom", "operation": "get", - "path": "/v1/credit_notes/{id}" + "path": "/v1/credit_notes/preview/lines" }, { - "method_name": "list", + "method_name": "create", "method_on": "service", - "method_type": "list", - "operation": "get", + "method_type": "create", + "operation": "post", "path": "/v1/credit_notes" }, { @@ -8652,13 +10466,6 @@ "method_type": "custom", "operation": "post", "path": "/v1/credit_notes/{id}/void" - }, - { - "method_name": "preview_lines", - "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/credit_notes/preview/lines" } ], "x-stripeResource": { @@ -9133,7 +10940,7 @@ "type": "string" }, "next_invoice_sequence": { - "description": "The suffix of the customer's next invoice number (for example, 0001).", + "description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.", "type": "integer" }, "object": { @@ -9346,11 +11153,18 @@ "x-resourceId": "customer", "x-stripeOperations": [ { - "method_name": "search", + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/customers/{customer}" + }, + { + "method_name": "delete_discount", "method_on": "service", "method_type": "custom", - "operation": "get", - "path": "/v1/customers/search" + "operation": "delete", + "path": "/v1/customers/{customer}/discount" }, { "method_name": "list", @@ -9359,13 +11173,6 @@ "operation": "get", "path": "/v1/customers" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/customers" - }, { "method_name": "retrieve", "method_on": "service", @@ -9374,18 +11181,11 @@ "path": "/v1/customers/{customer}" }, { - "method_name": "update", - "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/customers/{customer}" - }, - { - "method_name": "delete", + "method_name": "balance_transactions", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/customers/{customer}" + "method_type": "custom", + "operation": "get", + "path": "/v1/customers/{customer}/balance_transactions" }, { "method_name": "list_payment_methods", @@ -9402,18 +11202,25 @@ "path": "/v1/customers/{customer}/payment_methods/{payment_method}" }, { - "method_name": "balance_transactions", + "method_name": "search", "method_on": "service", "method_type": "custom", "operation": "get", - "path": "/v1/customers/{customer}/balance_transactions" + "path": "/v1/customers/search" }, { - "method_name": "fund_cash_balance", + "method_name": "create", "method_on": "service", - "method_type": "custom", + "method_type": "create", "operation": "post", - "path": "/v1/test_helpers/customers/{customer}/fund_cash_balance" + "path": "/v1/customers" + }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/customers/{customer}" }, { "method_name": "create_funding_instructions", @@ -9423,11 +11230,11 @@ "path": "/v1/customers/{customer}/funding_instructions" }, { - "method_name": "delete_discount", + "method_name": "fund_cash_balance", "method_on": "service", "method_type": "custom", - "operation": "delete", - "path": "/v1/customers/{customer}/discount" + "operation": "post", + "path": "/v1/test_helpers/customers/{customer}/fund_cash_balance" } ], "x-stripeResource": { @@ -9570,7 +11377,7 @@ } }, "customer.source.expiring": { - "description": "Occurs whenever a card or source will expire at the end of the month.", + "description": "Occurs whenever a card or source will expire at the end of the month. This event only works with legacy integrations using Card or Source objects. If you use the PaymentMethod API, this event won't occur.", "properties": { "object": { "anyOf": [ @@ -9651,7 +11458,7 @@ } }, "customer.subscription.paused": { - "description": "Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](/docs/billing/subscriptions/pause) is paused.", + "description": "Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused.", "properties": { "object": { "$ref": "#/components/schemas/subscription" @@ -9699,7 +11506,7 @@ } }, "customer.subscription.resumed": { - "description": "Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](/docs/api/subscriptions/resume), not when [payment collection](/docs/billing/subscriptions/pause) is resumed.", + "description": "Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](https://docs.stripe.com/api/subscriptions/resume), not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed.", "properties": { "object": { "$ref": "#/components/schemas/subscription" @@ -10372,7 +12179,8 @@ "unapplied_from_invoice", "unspent_receiver_credit" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -10400,32 +12208,32 @@ "x-resourceId": "customer_balance_transaction", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "collection", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/customers/{customer}/balance_transactions/{transaction}" + "path": "/v1/customers/{customer}/balance_transactions" }, { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/customers/{customer}/balance_transactions/{transaction}" + "path": "/v1/customers/{customer}/balance_transactions" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "collection", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/customers/{customer}/balance_transactions" + "path": "/v1/customers/{customer}/balance_transactions/{transaction}" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/customers/{customer}/balance_transactions" + "path": "/v1/customers/{customer}/balance_transactions/{transaction}" }, { "method_name": "create", @@ -10570,38 +12378,39 @@ "x-resourceId": "customer_cash_balance_transaction", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "collection", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}" + "path": "/v1/customers/{customer}/cash_balance_transactions" }, { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}" + "path": "/v1/customers/{customer}/cash_balance_transactions" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "collection", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/customers/{customer}/cash_balance_transactions" + "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/customers/{customer}/cash_balance_transactions" + "path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}" } ], "x-stripeResource": { "class_name": "CustomerCashBalanceTransaction", "has_collection_class": true, "in_package": "", + "parent": "customer", "polymorphic_groups": [ "balance_transaction_source" ] @@ -10624,10 +12433,10 @@ } }, "customer_session": { - "description": "A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)\ncontrol over a customer.", + "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).", "properties": { "client_secret": { - "description": "The client secret of this customer session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.", + "description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.", "maxLength": 5000, "type": "string" }, @@ -10649,7 +12458,7 @@ "$ref": "#/components/schemas/customer" } ], - "description": "The customer the customer session was created for.", + "description": "The Customer the Customer Session was created for.", "x-expansionResources": { "oneOf": [ { @@ -10659,7 +12468,7 @@ } }, "expires_at": { - "description": "The timestamp at which this customer session will expire.", + "description": "The timestamp at which this Customer Session will expire.", "format": "unix-time", "type": "integer" }, @@ -10705,19 +12514,28 @@ } }, "customer_session_resource_components": { - "description": "Configuration for the components supported by this customer session.", + "description": "Configuration for the components supported by this Customer Session.", "properties": { "buy_button": { "$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button" }, + "payment_element": { + "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element" + }, "pricing_table": { "$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table" } }, + "required": [ + "buy_button", + "payment_element", + "pricing_table" + ], "title": "CustomerSessionResourceComponents", "type": "object", "x-expandableFields": [ "buy_button", + "payment_element", "pricing_table" ] }, @@ -10736,6 +12554,102 @@ "type": "object", "x-expandableFields": [] }, + "customer_session_resource_components_resource_payment_element": { + "description": "This hash contains whether the Payment Element is enabled and the features it supports.", + "properties": { + "enabled": { + "description": "Whether the Payment Element is enabled.", + "type": "boolean" + }, + "features": { + "anyOf": [ + { + "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features" + } + ], + "description": "This hash defines whether the Payment Element supports certain features.", + "nullable": true + } + }, + "required": [ + "enabled", + "features" + ], + "title": "CustomerSessionResourceComponentsResourcePaymentElement", + "type": "object", + "x-expandableFields": [ + "features" + ] + }, + "customer_session_resource_components_resource_payment_element_resource_features": { + "description": "This hash contains the features the Payment Element supports.", + "properties": { + "payment_method_allow_redisplay_filters": { + "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": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_redisplay": { + "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_redisplay_limit": { + "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.", + "nullable": true, + "type": "integer" + }, + "payment_method_remove": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save_usage": { + "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" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "payment_method_allow_redisplay_filters", + "payment_method_redisplay", + "payment_method_redisplay_limit", + "payment_method_remove", + "payment_method_save", + "payment_method_save_usage" + ], + "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures", + "type": "object", + "x-expandableFields": [] + }, "customer_session_resource_components_resource_pricing_table": { "description": "This hash contains whether the pricing table is enabled.", "properties": { @@ -11199,6 +13113,12 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "subscription_item": { + "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ @@ -11212,7 +13132,8 @@ "object", "promotion_code", "start", - "subscription" + "subscription", + "subscription_item" ], "title": "DeletedDiscount", "type": "object", @@ -11480,6 +13401,43 @@ "in_package": "" } }, + "deleted_product_feature": { + "description": "", + "properties": { + "deleted": { + "description": "Always true for a deleted object", + "enum": [ + true + ], + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "product_feature" + ], + "type": "string" + } + }, + "required": [ + "deleted", + "id", + "object" + ], + "title": "DeletedProductFeature", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "deleted_product_feature", + "x-stripeResource": { + "class_name": "DeletedProductFeature", + "in_package": "" + } + }, "deleted_radar.value_list": { "description": "", "properties": { @@ -11918,6 +13876,12 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "subscription_item": { + "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ @@ -11931,7 +13895,8 @@ "object", "promotion_code", "start", - "subscription" + "subscription", + "subscription_item" ], "title": "Discount", "type": "object", @@ -11988,6 +13953,83 @@ "discount" ] }, + "discounts_resource_stackable_discount": { + "description": "", + "properties": { + "coupon": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/coupon" + } + ], + "description": "ID of the coupon to create a new discount for.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/coupon" + } + ] + } + }, + "discount": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/discount" + } + ], + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/discount" + } + ] + } + }, + "promotion_code": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/promotion_code" + } + ], + "description": "ID of the promotion code to create a new discount for.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/promotion_code" + } + ] + } + } + }, + "required": [ + "coupon", + "discount", + "promotion_code" + ], + "title": "DiscountsResourceStackableDiscount", + "type": "object", + "x-expandableFields": [ + "coupon", + "discount", + "promotion_code" + ] + }, "dispute": { "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)", "properties": { @@ -12550,30 +14592,33 @@ "description": "", "properties": { "card": { - "anyOf": [ - { - "$ref": "#/components/schemas/dispute_payment_method_details_card" - } - ], - "description": "Card specific dispute details.", - "nullable": true + "$ref": "#/components/schemas/dispute_payment_method_details_card" + }, + "klarna": { + "$ref": "#/components/schemas/dispute_payment_method_details_klarna" + }, + "paypal": { + "$ref": "#/components/schemas/dispute_payment_method_details_paypal" }, "type": { "description": "Payment method type.", "enum": [ - "card" + "card", + "klarna", + "paypal" ], "type": "string" } }, "required": [ - "card", "type" ], "title": "DisputePaymentMethodDetails", "type": "object", "x-expandableFields": [ - "card" + "card", + "klarna", + "paypal" ] }, "dispute_payment_method_details_card": { @@ -12584,6 +14629,15 @@ "maxLength": 5000, "type": "string" }, + "case_type": { + "description": "The type of dispute opened. Different case types may have varying fees and financial impact.", + "enum": [ + "chargeback", + "inquiry" + ], + "type": "string", + "x-stripeBypassValidation": true + }, "network_reason_code": { "description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.", "maxLength": 5000, @@ -12593,12 +14647,54 @@ }, "required": [ "brand", + "case_type", "network_reason_code" ], "title": "DisputePaymentMethodDetailsCard", "type": "object", "x-expandableFields": [] }, + "dispute_payment_method_details_klarna": { + "description": "", + "properties": { + "reason_code": { + "description": "The reason for the dispute as defined by Klarna", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "reason_code" + ], + "title": "DisputePaymentMethodDetailsKlarna", + "type": "object", + "x-expandableFields": [] + }, + "dispute_payment_method_details_paypal": { + "description": "", + "properties": { + "case_id": { + "description": "The ID of the dispute in PayPal.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "reason_code": { + "description": "The reason for the dispute as defined by PayPal", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "case_id", + "reason_code" + ], + "title": "DisputePaymentMethodDetailsPaypal", + "type": "object", + "x-expandableFields": [] + }, "email_sent": { "description": "", "properties": { @@ -12621,6 +14717,266 @@ "type": "object", "x-expandableFields": [] }, + "entitlements.active_entitlement": { + "description": "An active entitlement describes access to a feature for a customer.", + "properties": { + "feature": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/entitlements.feature" + } + ], + "description": "The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/entitlements.feature" + } + ] + } + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "lookup_key": { + "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "entitlements.active_entitlement" + ], + "type": "string" + } + }, + "required": [ + "feature", + "id", + "livemode", + "lookup_key", + "object" + ], + "title": "ActiveEntitlement", + "type": "object", + "x-expandableFields": [ + "feature" + ], + "x-resourceId": "entitlements.active_entitlement", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/entitlements/active_entitlements" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/entitlements/active_entitlements/{id}" + } + ], + "x-stripeResource": { + "class_name": "ActiveEntitlement", + "has_collection_class": true, + "in_package": "Entitlements" + } + }, + "entitlements.active_entitlement_summary": { + "description": "A summary of a customer's active entitlements.", + "properties": { + "customer": { + "description": "The customer that is entitled to this feature.", + "maxLength": 5000, + "type": "string" + }, + "entitlements": { + "description": "The list of entitlements this customer has.", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/entitlements.active_entitlement" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "EntitlementsResourceCustomerEntitlementList", + "type": "object", + "x-expandableFields": [ + "data" + ] + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "entitlements.active_entitlement_summary" + ], + "type": "string" + } + }, + "required": [ + "customer", + "entitlements", + "livemode", + "object" + ], + "title": "ActiveEntitlementSummary", + "type": "object", + "x-expandableFields": [ + "entitlements" + ], + "x-stripeResource": { + "class_name": "ActiveEntitlementSummary", + "in_package": "Entitlements" + } + }, + "entitlements.active_entitlement_summary.updated": { + "description": "Occurs whenever a customer's entitlements change.", + "properties": { + "object": { + "$ref": "#/components/schemas/entitlements.active_entitlement_summary" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "entitlements.active_entitlement_summary.updated" + } + }, + "entitlements.feature": { + "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.", + "properties": { + "active": { + "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "lookup_key": { + "description": "A unique key you provide as your own system identifier. This may be up to 80 characters.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, + "name": { + "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", + "maxLength": 80, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "entitlements.feature" + ], + "type": "string" + } + }, + "required": [ + "active", + "id", + "livemode", + "lookup_key", + "metadata", + "name", + "object" + ], + "title": "Feature", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "entitlements.feature", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/entitlements/features" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/entitlements/features/{id}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/entitlements/features" + }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/entitlements/features/{id}" + } + ], + "x-stripeResource": { + "class_name": "Feature", + "has_collection_class": true, + "in_package": "Entitlements" + } + }, "ephemeral_key": { "description": "", "properties": { @@ -12668,19 +15024,19 @@ "x-expandableFields": [], "x-resourceId": "ephemeral_key", "x-stripeOperations": [ - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/ephemeral_keys" - }, { "method_name": "delete", "method_on": "service", "method_type": "delete", "operation": "delete", "path": "/v1/ephemeral_keys/{key}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/ephemeral_keys" } ], "x-stripeResource": { @@ -12705,7 +15061,7 @@ } }, "event": { - "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.", + "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://docs.stripe.com/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://docs.stripe.com/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.", "properties": { "account": { "description": "The connected account that originates the event.", @@ -12768,6 +15124,7 @@ "application_fee.refund.updated", "application_fee.refunded", "balance.available", + "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", @@ -12825,12 +15182,14 @@ "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", + "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "identity.verification_session.canceled", "identity.verification_session.created", @@ -12843,6 +15202,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -12851,6 +15211,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -12863,8 +15224,13 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", + "issuing_personalization_design.activated", + "issuing_personalization_design.deactivated", + "issuing_personalization_design.rejected", + "issuing_personalization_design.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", @@ -12973,12 +15339,14 @@ "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", + "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", + "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", @@ -13095,6 +15463,13 @@ "x-resourceId": "external_account", "x-stripeBypassValidation": true, "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/accounts/{account}/external_accounts/{id}" + }, { "method_name": "list", "method_on": "collection", @@ -13143,13 +15518,6 @@ "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/external_accounts/{id}" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/accounts/{account}/external_accounts/{id}" } ], "x-stripeResource": { @@ -13187,7 +15555,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -13232,7 +15600,7 @@ "type": "string" }, "type": { - "description": "Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`.", + "description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.", "maxLength": 5000, "type": "string" } @@ -13344,18 +15712,18 @@ "x-resourceId": "fee_refund", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "retrieve", "method_on": "collection", - "method_type": "create", - "operation": "post", - "path": "/v1/application_fees/{id}/refunds" + "method_type": "retrieve", + "operation": "get", + "path": "/v1/application_fees/{fee}/refunds/{id}" }, { - "method_name": "create", + "method_name": "retrieve", "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/application_fees/{id}/refunds" + "method_type": "retrieve", + "operation": "get", + "path": "/v1/application_fees/{fee}/refunds/{id}" }, { "method_name": "list", @@ -13372,25 +15740,25 @@ "path": "/v1/application_fees/{id}/refunds" }, { - "method_name": "retrieve", - "method_on": "collection", - "method_type": "retrieve", - "operation": "get", + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", "path": "/v1/application_fees/{fee}/refunds/{id}" }, { - "method_name": "retrieve", - "method_on": "service", - "method_type": "retrieve", - "operation": "get", - "path": "/v1/application_fees/{fee}/refunds/{id}" + "method_name": "create", + "method_on": "collection", + "method_type": "create", + "operation": "post", + "path": "/v1/application_fees/{id}/refunds" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/application_fees/{fee}/refunds/{id}" + "path": "/v1/application_fees/{id}/refunds" } ], "x-stripeResource": { @@ -13669,6 +16037,13 @@ ], "x-resourceId": "file_link", "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/file_links" + }, { "method_name": "retrieve", "method_on": "service", @@ -13689,13 +16064,6 @@ "method_type": "update", "operation": "post", "path": "/v1/file_links/{link}" - }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/file_links" } ], "x-stripeResource": { @@ -13934,18 +16302,18 @@ "path": "/v1/financial_connections/accounts/{account}/owners" }, { - "method_name": "refresh", + "method_name": "disconnect", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/financial_connections/accounts/{account}/refresh" + "path": "/v1/financial_connections/accounts/{account}/disconnect" }, { - "method_name": "disconnect", + "method_name": "refresh", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/financial_connections/accounts/{account}/disconnect" + "path": "/v1/financial_connections/accounts/{account}/refresh" }, { "method_name": "subscribe", @@ -14048,6 +16416,22 @@ "type": "financial_connections.account.refreshed_balance" } }, + "financial_connections.account.refreshed_ownership": { + "description": "Occurs when an Account’s `ownership_refresh` status transitions from `pending` to either `succeeded` or `failed`.", + "properties": { + "object": { + "$ref": "#/components/schemas/financial_connections.account" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "financial_connections.account.refreshed_ownership" + } + }, "financial_connections.account.refreshed_transactions": { "description": "Occurs when an Account’s `transaction_refresh` status transitions from `pending` to either `succeeded` or `failed`.", "properties": { @@ -14339,19 +16723,19 @@ ], "x-resourceId": "financial_connections.session", "x-stripeOperations": [ - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/financial_connections/sessions" - }, { "method_name": "retrieve", "method_on": "service", "method_type": "retrieve", "operation": "get", "path": "/v1/financial_connections/sessions/{session}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/financial_connections/sessions" } ], "x-stripeResource": { @@ -14447,18 +16831,18 @@ "x-resourceId": "financial_connections.transaction", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/financial_connections/transactions/{transaction}" + "path": "/v1/financial_connections/transactions" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/financial_connections/transactions" + "path": "/v1/financial_connections/transactions/{transaction}" } ], "x-stripeResource": { @@ -14517,6 +16901,239 @@ "type": "object", "x-expandableFields": [] }, + "forwarded_request_context": { + "description": "Metadata about the forwarded request.", + "properties": { + "destination_duration": { + "description": "The time it took in milliseconds for the destination endpoint to respond.", + "type": "integer" + }, + "destination_ip_address": { + "description": "The IP address of the destination.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "destination_duration", + "destination_ip_address" + ], + "title": "ForwardedRequestContext", + "type": "object", + "x-expandableFields": [] + }, + "forwarded_request_details": { + "description": "Details about the request forwarded to the destination endpoint.", + "properties": { + "body": { + "description": "The body payload to send to the destination endpoint.", + "maxLength": 5000, + "type": "string" + }, + "headers": { + "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", + "items": { + "$ref": "#/components/schemas/forwarded_request_header" + }, + "type": "array" + }, + "http_method": { + "description": "The HTTP method used to call the destination endpoint.", + "enum": [ + "POST" + ], + "type": "string" + } + }, + "required": [ + "body", + "headers", + "http_method" + ], + "title": "ForwardedRequestDetails", + "type": "object", + "x-expandableFields": [ + "headers" + ] + }, + "forwarded_request_header": { + "description": "Header data.", + "properties": { + "name": { + "description": "The header name.", + "maxLength": 5000, + "type": "string" + }, + "value": { + "description": "The header value.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "title": "ForwardedRequestHeader", + "type": "object", + "x-expandableFields": [] + }, + "forwarded_response_details": { + "description": "Details about the response from the destination endpoint.", + "properties": { + "body": { + "description": "The response body from the destination endpoint to Stripe.", + "maxLength": 5000, + "type": "string" + }, + "headers": { + "description": "HTTP headers that the destination endpoint returned.", + "items": { + "$ref": "#/components/schemas/forwarded_request_header" + }, + "type": "array" + }, + "status": { + "description": "The HTTP status code that the destination endpoint returned.", + "type": "integer" + } + }, + "required": [ + "body", + "headers", + "status" + ], + "title": "ForwardedResponseDetails", + "type": "object", + "x-expandableFields": [ + "headers" + ] + }, + "forwarding.request": { + "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "forwarding.request" + ], + "type": "string" + }, + "payment_method": { + "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", + "maxLength": 5000, + "type": "string" + }, + "replacements": { + "description": "The field kinds to be replaced in the forwarded request.", + "items": { + "enum": [ + "card_cvc", + "card_expiry", + "card_number", + "cardholder_name" + ], + "type": "string" + }, + "type": "array" + }, + "request_context": { + "anyOf": [ + { + "$ref": "#/components/schemas/forwarded_request_context" + } + ], + "description": "Context about the request from Stripe's servers to the destination endpoint.", + "nullable": true + }, + "request_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/forwarded_request_details" + } + ], + "description": "The request that was sent to the destination endpoint. We redact any sensitive fields.", + "nullable": true + }, + "response_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/forwarded_response_details" + } + ], + "description": "The response that the destination endpoint returned to us. We redact any sensitive fields.", + "nullable": true + }, + "url": { + "description": "The destination URL for the forwarded request. Must be supported by the config.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "created", + "id", + "livemode", + "object", + "payment_method", + "replacements", + "request_context", + "request_details", + "response_details", + "url" + ], + "title": "ForwardingRequest", + "type": "object", + "x-expandableFields": [ + "request_context", + "request_details", + "response_details" + ], + "x-resourceId": "forwarding.request", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/forwarding/requests" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/forwarding/requests/{id}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/forwarding/requests" + } + ], + "x-stripeResource": { + "class_name": "Request", + "has_collection_class": true, + "in_package": "Forwarding" + } + }, "funding_instructions": { "description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)", "properties": { @@ -15128,15 +17745,12 @@ }, "required": [ "address", - "dob", "error", - "expiration_date", "files", "first_name", "issued_date", "issuing_country", "last_name", - "number", "status", "type" ], @@ -15179,6 +17793,72 @@ "type": "object", "x-expandableFields": [] }, + "gelato_email_report": { + "description": "Result from a email check", + "properties": { + "email": { + "description": "Email to be verified.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "error": { + "anyOf": [ + { + "$ref": "#/components/schemas/gelato_email_report_error" + } + ], + "description": "Details on the verification error. Present when status is `unverified`.", + "nullable": true + }, + "status": { + "description": "Status of this `email` check.", + "enum": [ + "unverified", + "verified" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "email", + "error", + "status" + ], + "title": "GelatoEmailReport", + "type": "object", + "x-expandableFields": [ + "error" + ] + }, + "gelato_email_report_error": { + "description": "", + "properties": { + "code": { + "description": "A short machine-readable string giving the reason for the verification failure.", + "enum": [ + "email_unverified_other", + "email_verification_declined" + ], + "nullable": true, + "type": "string" + }, + "reason": { + "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "code", + "reason" + ], + "title": "GelatoEmailReportError", + "type": "object", + "x-expandableFields": [] + }, "gelato_id_number_report": { "description": "Result from an id_number check", "properties": { @@ -15207,7 +17887,7 @@ "type": "string" }, "id_number": { - "description": "ID number.", + "description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.", "maxLength": 5000, "nullable": true, "type": "string" @@ -15239,10 +17919,8 @@ } }, "required": [ - "dob", "error", "first_name", - "id_number", "id_number_type", "last_name", "status" @@ -15282,6 +17960,90 @@ "type": "object", "x-expandableFields": [] }, + "gelato_phone_report": { + "description": "Result from a phone check", + "properties": { + "error": { + "anyOf": [ + { + "$ref": "#/components/schemas/gelato_phone_report_error" + } + ], + "description": "Details on the verification error. Present when status is `unverified`.", + "nullable": true + }, + "phone": { + "description": "Phone to be verified.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "status": { + "description": "Status of this `phone` check.", + "enum": [ + "unverified", + "verified" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "error", + "phone", + "status" + ], + "title": "GelatoPhoneReport", + "type": "object", + "x-expandableFields": [ + "error" + ] + }, + "gelato_phone_report_error": { + "description": "", + "properties": { + "code": { + "description": "A short machine-readable string giving the reason for the verification failure.", + "enum": [ + "phone_unverified_other", + "phone_verification_declined" + ], + "nullable": true, + "type": "string" + }, + "reason": { + "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "code", + "reason" + ], + "title": "GelatoPhoneReportError", + "type": "object", + "x-expandableFields": [] + }, + "gelato_provided_details": { + "description": "", + "properties": { + "email": { + "description": "Email of user being verified", + "maxLength": 5000, + "type": "string" + }, + "phone": { + "description": "Phone number of user being verified", + "maxLength": 5000, + "type": "string" + } + }, + "title": "GelatoProvidedDetails", + "type": "object", + "x-expandableFields": [] + }, "gelato_report_document_options": { "description": "", "properties": { @@ -15428,6 +18190,18 @@ "type": "object", "x-expandableFields": [] }, + "gelato_session_email_options": { + "description": "", + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.email`.", + "type": "boolean" + } + }, + "title": "GelatoSessionEmailOptions", + "type": "object", + "x-expandableFields": [] + }, "gelato_session_id_number_options": { "description": "", "properties": {}, @@ -15448,9 +18222,13 @@ "document_expired", "document_type_not_supported", "document_unverified_other", + "email_unverified_other", + "email_verification_declined", "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other", + "phone_unverified_other", + "phone_verification_declined", "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", @@ -15476,6 +18254,18 @@ "type": "object", "x-expandableFields": [] }, + "gelato_session_phone_options": { + "description": "", + "properties": { + "require_verification": { + "description": "Request one time password verification of `provided_details.phone`.", + "type": "boolean" + } + }, + "title": "GelatoSessionPhoneOptions", + "type": "object", + "x-expandableFields": [] + }, "gelato_verification_report_options": { "description": "", "properties": { @@ -15499,15 +18289,23 @@ "document": { "$ref": "#/components/schemas/gelato_session_document_options" }, + "email": { + "$ref": "#/components/schemas/gelato_session_email_options" + }, "id_number": { "$ref": "#/components/schemas/gelato_session_id_number_options" + }, + "phone": { + "$ref": "#/components/schemas/gelato_session_phone_options" } }, "title": "GelatoVerificationSessionOptions", "type": "object", "x-expandableFields": [ "document", - "id_number" + "email", + "id_number", + "phone" ] }, "gelato_verified_outputs": { @@ -15531,6 +18329,12 @@ "description": "The user’s verified date of birth.", "nullable": true }, + "email": { + "description": "The user's verified email address", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "first_name": { "description": "The user's verified first name.", "maxLength": 5000, @@ -15558,15 +18362,21 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "phone": { + "description": "The user's verified phone number", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ "address", - "dob", + "email", "first_name", - "id_number", "id_number_type", - "last_name" + "last_name", + "phone" ], "title": "GelatoVerifiedOutputs", "type": "object", @@ -15576,8 +18386,14 @@ ] }, "identity.verification_report": { - "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", + "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).", "properties": { + "client_reference_id": { + "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", @@ -15586,6 +18402,9 @@ "document": { "$ref": "#/components/schemas/gelato_document_report" }, + "email": { + "$ref": "#/components/schemas/gelato_email_report" + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -15608,6 +18427,9 @@ "options": { "$ref": "#/components/schemas/gelato_verification_report_options" }, + "phone": { + "$ref": "#/components/schemas/gelato_phone_report" + }, "selfie": { "$ref": "#/components/schemas/gelato_selfie_report" }, @@ -15615,11 +18437,17 @@ "description": "Type of report.", "enum": [ "document", - "id_number" + "id_number", + "verification_flow" ], "type": "string", "x-stripeBypassValidation": true }, + "verification_flow": { + "description": "The configuration token of a Verification Flow from the dashboard.", + "maxLength": 5000, + "type": "string" + }, "verification_session": { "description": "ID of the VerificationSession that created this report.", "maxLength": 5000, @@ -15628,35 +18456,39 @@ } }, "required": [ + "client_reference_id", "created", "id", "livemode", "object", + "type", "verification_session" ], "title": "GelatoVerificationReport", "type": "object", "x-expandableFields": [ "document", + "email", "id_number", "options", + "phone", "selfie" ], "x-resourceId": "identity.verification_report", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/identity/verification_reports/{report}" + "path": "/v1/identity/verification_reports" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/identity/verification_reports" + "path": "/v1/identity/verification_reports/{report}" } ], "x-stripeResource": { @@ -15668,6 +18500,12 @@ "identity.verification_session": { "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)", "properties": { + "client_reference_id": { + "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "client_secret": { "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.", "maxLength": 5000, @@ -15741,6 +18579,15 @@ "description": "A set of options for the session’s verification checks.", "nullable": true }, + "provided_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/gelato_provided_details" + } + ], + "description": "Details provided about the user being verified. These details may be shown to the user.", + "nullable": true + }, "redaction": { "anyOf": [ { @@ -15750,6 +18597,12 @@ "description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.", "nullable": true }, + "related_customer": { + "description": "Token referencing a Customer resource.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "status": { "description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).", "enum": [ @@ -15764,9 +18617,9 @@ "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ "document", - "id_number" + "id_number", + "verification_flow" ], - "nullable": true, "type": "string", "x-stripeBypassValidation": true }, @@ -15776,6 +18629,11 @@ "nullable": true, "type": "string" }, + "verification_flow": { + "description": "The configuration token of a Verification Flow from the dashboard.", + "maxLength": 5000, + "type": "string" + }, "verified_outputs": { "anyOf": [ { @@ -15787,6 +18645,7 @@ } }, "required": [ + "client_reference_id", "client_secret", "created", "id", @@ -15797,10 +18656,10 @@ "object", "options", "redaction", + "related_customer", "status", "type", - "url", - "verified_outputs" + "url" ], "title": "GelatoVerificationSession", "type": "object", @@ -15808,16 +18667,17 @@ "last_error", "last_verification_report", "options", + "provided_details", "redaction", "verified_outputs" ], "x-resourceId": "identity.verification_session", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/identity/verification_sessions" }, { @@ -15828,12 +18688,19 @@ "path": "/v1/identity/verification_sessions/{session}" }, { - "method_name": "list", + "method_name": "create", "method_on": "service", - "method_type": "list", - "operation": "get", + "method_type": "create", + "operation": "post", "path": "/v1/identity/verification_sessions" }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/identity/verification_sessions/{session}" + }, { "method_name": "cancel", "method_on": "service", @@ -15847,13 +18714,6 @@ "method_type": "custom", "operation": "post", "path": "/v1/identity/verification_sessions/{session}/redact" - }, - { - "method_name": "update", - "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/identity/verification_sessions/{session}" } ], "x-stripeResource": { @@ -16026,8 +18886,27 @@ "nullable": true, "type": "string" }, + "mandate": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/mandate" + } + ], + "description": "ID of the mandate used to make this payment.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/mandate" + } + ] + } + }, "network": { - "description": "The US bank account network used to debit funds.", + "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach" ], @@ -16051,12 +18930,57 @@ ], "title": "inbound_transfers_payment_method_details_us_bank_account", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "mandate" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" } }, + "internal_card": { + "description": "", + "properties": { + "brand": { + "description": "Brand of the card used in the transaction", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "country": { + "description": "Two-letter ISO code representing the country of the card", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "exp_month": { + "description": "Two digit number representing the card's expiration month", + "nullable": true, + "type": "integer" + }, + "exp_year": { + "description": "Two digit number representing the card's expiration year", + "nullable": true, + "type": "integer" + }, + "last4": { + "description": "The last 4 digits of the card", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "brand", + "country", + "exp_month", + "exp_year", + "last4" + ], + "title": "internal_card", + "type": "object", + "x-expandableFields": [] + }, "invoice": { "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)", "properties": { @@ -16149,7 +19073,7 @@ "type": "integer" }, "attempt_count": { - "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.", + "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.", "type": "integer" }, "attempted": { @@ -16392,7 +19316,6 @@ ] } }, - "nullable": true, "type": "array" }, "due_date": { @@ -16421,7 +19344,7 @@ "from_invoice": { "anyOf": [ { - "$ref": "#/components/schemas/invoices_from_invoice" + "$ref": "#/components/schemas/invoices_resource_from_invoice" } ], "description": "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.", @@ -16444,6 +19367,9 @@ "nullable": true, "type": "string" }, + "issuer": { + "$ref": "#/components/schemas/connect_account_reference" + }, "last_finalization_error": { "anyOf": [ { @@ -16596,12 +19522,12 @@ "$ref": "#/components/schemas/invoices_payment_settings" }, "period_end": { - "description": "End of the usage period during which invoice items were added to this invoice.", + "description": "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, "period_start": { - "description": "Start of the usage period during which invoice items were added to this invoice.", + "description": "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.", "format": "unix-time", "type": "integer" }, @@ -16642,25 +19568,16 @@ "rendering": { "anyOf": [ { - "$ref": "#/components/schemas/invoices_invoice_rendering" + "$ref": "#/components/schemas/invoices_resource_invoice_rendering" } ], "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", "nullable": true }, - "rendering_options": { - "anyOf": [ - { - "$ref": "#/components/schemas/invoice_setting_rendering_options" - } - ], - "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering.", - "nullable": true - }, "shipping_cost": { "anyOf": [ { - "$ref": "#/components/schemas/invoices_shipping_cost" + "$ref": "#/components/schemas/invoices_resource_shipping_cost" } ], "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice.", @@ -16699,7 +19616,7 @@ "x-stripeBypassValidation": true }, "status_transitions": { - "$ref": "#/components/schemas/invoices_status_transitions" + "$ref": "#/components/schemas/invoices_resource_status_transitions" }, "subscription": { "anyOf": [ @@ -16848,6 +19765,7 @@ "ending_balance", "footer", "from_invoice", + "issuer", "last_finalization_error", "latest_revision", "lines", @@ -16868,7 +19786,6 @@ "quote", "receipt_number", "rendering", - "rendering_options", "shipping_cost", "shipping_details", "starting_balance", @@ -16906,6 +19823,7 @@ "discount", "discounts", "from_invoice", + "issuer", "last_finalization_error", "latest_revision", "lines", @@ -16914,7 +19832,6 @@ "payment_settings", "quote", "rendering", - "rendering_options", "shipping_cost", "shipping_details", "status_transitions", @@ -16929,32 +19846,39 @@ "x-resourceId": "invoice", "x-stripeOperations": [ { - "method_name": "search", + "method_name": "delete", "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/invoices/search" + "method_type": "delete", + "operation": "delete", + "path": "/v1/invoices/{invoice}" }, { - "method_name": "upcoming", + "method_name": "list", "method_on": "service", - "method_type": "custom", + "method_type": "list", "operation": "get", - "path": "/v1/invoices/upcoming" + "path": "/v1/invoices" }, { - "method_name": "update", + "method_name": "retrieve", "method_on": "service", - "method_type": "update", - "operation": "post", + "method_type": "retrieve", + "operation": "get", "path": "/v1/invoices/{invoice}" }, { - "method_name": "pay", + "method_name": "search", "method_on": "service", "method_type": "custom", - "operation": "post", - "path": "/v1/invoices/{invoice}/pay" + "operation": "get", + "path": "/v1/invoices/search" + }, + { + "method_name": "upcoming", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/invoices/upcoming" }, { "method_name": "upcomingLines", @@ -16971,25 +19895,18 @@ "path": "/v1/invoices" }, { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/invoices" - }, - { - "method_name": "retrieve", + "method_name": "update", "method_on": "service", - "method_type": "retrieve", - "operation": "get", + "method_type": "update", + "operation": "post", "path": "/v1/invoices/{invoice}" }, { - "method_name": "delete", + "method_name": "add_lines", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/invoices/{invoice}" + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/add_lines" }, { "method_name": "finalize_invoice", @@ -16998,6 +19915,27 @@ "operation": "post", "path": "/v1/invoices/{invoice}/finalize" }, + { + "method_name": "mark_uncollectible", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/mark_uncollectible" + }, + { + "method_name": "pay", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/pay" + }, + { + "method_name": "remove_lines", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/{invoice}/remove_lines" + }, { "method_name": "send_invoice", "method_on": "service", @@ -17006,11 +19944,11 @@ "path": "/v1/invoices/{invoice}/send" }, { - "method_name": "mark_uncollectible", + "method_name": "update_lines", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/invoices/{invoice}/mark_uncollectible" + "path": "/v1/invoices/{invoice}/update_lines" }, { "method_name": "void_invoice", @@ -17018,6 +19956,13 @@ "method_type": "custom", "operation": "post", "path": "/v1/invoices/{invoice}/void" + }, + { + "method_name": "create_preview", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/invoices/create_preview" } ], "x-stripeResource": { @@ -17028,7 +19973,7 @@ } }, "invoice.created": { - "description": "Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](/docs/subscriptions/webhooks).", + "description": "Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](https://docs.stripe.com/subscriptions/webhooks).", "properties": { "object": { "$ref": "#/components/schemas/invoice" @@ -17044,7 +19989,7 @@ } }, "invoice.deleted": { - "description": "Occurs whenever a draft invoice is deleted.", + "description": "Occurs whenever a draft invoice is deleted. Note: This event is not sent for [invoice previews](https://docs.stripe.com/api/invoices/create_preview).", "properties": { "object": { "$ref": "#/components/schemas/invoice" @@ -17060,7 +20005,7 @@ } }, "invoice.finalization_failed": { - "description": "Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](/docs/api/invoices/object#invoice_object-last_finalization_error) for details.", + "description": "Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](https://docs.stripe.com/api/invoices/object#invoice_object-last_finalization_error) for details.", "properties": { "object": { "$ref": "#/components/schemas/invoice" @@ -17107,6 +20052,22 @@ "type": "invoice.marked_uncollectible" } }, + "invoice.overdue": { + "description": "Occurs X number of days after an invoice becomes due—where X is determined by Automations", + "properties": { + "object": { + "$ref": "#/components/schemas/invoice" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "invoice.overdue" + } + }, "invoice.paid": { "description": "Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.", "properties": { @@ -17235,6 +20196,22 @@ "type": "invoice.voided" } }, + "invoice.will_be_due": { + "description": "Occurs X number of days before an invoice becomes due—where X is determined by Automations", + "properties": { + "object": { + "$ref": "#/components/schemas/invoice" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "invoice.will_be_due" + } + }, "invoice_installments_card": { "description": "", "properties": { @@ -17401,10 +20378,11 @@ "$ref": "#/components/schemas/invoice_installments_card" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", - "automatic" + "automatic", + "challenge" ], "nullable": true, "type": "string" @@ -17494,6 +20472,13 @@ "type": "object", "x-expandableFields": [] }, + "invoice_payment_method_options_sepa_debit": { + "description": "", + "properties": {}, + "title": "invoice_payment_method_options_sepa_debit", + "type": "object", + "x-expandableFields": [] + }, "invoice_payment_method_options_us_bank_account": { "description": "", "properties": { @@ -17520,16 +20505,19 @@ "invoice_payment_method_options_us_bank_account_linked_account_options": { "description": "", "properties": { + "filters": { + "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters" + }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { "enum": [ "balances", + "ownership", "payment_method", "transactions" ], - "type": "string", - "x-stripeBypassValidation": true + "type": "string" }, "type": "array" }, @@ -17538,6 +20526,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -17552,6 +20541,27 @@ ], "title": "invoice_payment_method_options_us_bank_account_linked_account_options", "type": "object", + "x-expandableFields": [ + "filters" + ] + }, + "invoice_payment_method_options_us_bank_account_linked_account_options_filters": { + "description": "", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters", + "type": "object", "x-expandableFields": [] }, "invoice_rendering_pdf": { @@ -17597,6 +20607,23 @@ "type": "object", "x-expandableFields": [] }, + "invoice_setting_customer_rendering_options": { + "description": "", + "properties": { + "amount_tax_display": { + "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "amount_tax_display" + ], + "title": "InvoiceSettingCustomerRenderingOptions", + "type": "object", + "x-expandableFields": [] + }, "invoice_setting_customer_setting": { "description": "", "properties": { @@ -17637,7 +20664,7 @@ "rendering_options": { "anyOf": [ { - "$ref": "#/components/schemas/invoice_setting_rendering_options" + "$ref": "#/components/schemas/invoice_setting_customer_rendering_options" } ], "description": "Default options for invoice PDF rendering for this customer.", @@ -17665,14 +20692,20 @@ "description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", "nullable": true, "type": "integer" + }, + "issuer": { + "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ - "days_until_due" + "days_until_due", + "issuer" ], "title": "InvoiceSettingQuoteSetting", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "issuer" + ] }, "invoice_setting_rendering_options": { "description": "", @@ -17694,34 +20727,114 @@ "invoice_setting_subscription_schedule_phase_setting": { "description": "", "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/tax_id" + }, + { + "$ref": "#/components/schemas/deleted_tax_id" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/tax_id" + }, + { + "$ref": "#/components/schemas/deleted_tax_id" + } + ] + } + }, + "nullable": true, + "type": "array" + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, "type": "integer" + }, + "issuer": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "nullable": true } }, "required": [ - "days_until_due" + "account_tax_ids", + "days_until_due", + "issuer" ], "title": "InvoiceSettingSubscriptionSchedulePhaseSetting", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "account_tax_ids", + "issuer" + ] }, "invoice_setting_subscription_schedule_setting": { "description": "", "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/tax_id" + }, + { + "$ref": "#/components/schemas/deleted_tax_id" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/tax_id" + }, + { + "$ref": "#/components/schemas/deleted_tax_id" + } + ] + } + }, + "nullable": true, + "type": "array" + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "nullable": true, "type": "integer" + }, + "issuer": { + "$ref": "#/components/schemas/connect_account_reference" } }, "required": [ - "days_until_due" + "account_tax_ids", + "days_until_due", + "issuer" ], "title": "InvoiceSettingSubscriptionScheduleSetting", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "account_tax_ids", + "issuer" + ] }, "invoice_tax_amount": { "description": "", @@ -18112,17 +21225,17 @@ "x-resourceId": "invoiceitem", "x-stripeOperations": [ { - "method_name": "list", + "method_name": "delete", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/invoiceitems" + "method_type": "delete", + "operation": "delete", + "path": "/v1/invoiceitems/{invoiceitem}" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/invoiceitems" }, { @@ -18133,17 +21246,17 @@ "path": "/v1/invoiceitems/{invoiceitem}" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/invoiceitems/{invoiceitem}" + "path": "/v1/invoiceitems" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", + "method_type": "update", + "operation": "post", "path": "/v1/invoiceitems/{invoiceitem}" } ], @@ -18185,73 +21298,6 @@ "type": "invoiceitem.deleted" } }, - "invoices_from_invoice": { - "description": "", - "properties": { - "action": { - "description": "The relation between this invoice and the cloned invoice", - "maxLength": 5000, - "type": "string" - }, - "invoice": { - "anyOf": [ - { - "maxLength": 5000, - "type": "string" - }, - { - "$ref": "#/components/schemas/invoice" - } - ], - "description": "The invoice that was cloned.", - "x-expansionResources": { - "oneOf": [ - { - "$ref": "#/components/schemas/invoice" - } - ] - } - } - }, - "required": [ - "action", - "invoice" - ], - "title": "InvoicesFromInvoice", - "type": "object", - "x-expandableFields": [ - "invoice" - ] - }, - "invoices_invoice_rendering": { - "description": "", - "properties": { - "amount_tax_display": { - "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "pdf": { - "anyOf": [ - { - "$ref": "#/components/schemas/invoice_rendering_pdf" - } - ], - "description": "Invoice pdf rendering options", - "nullable": true - } - }, - "required": [ - "amount_tax_display", - "pdf" - ], - "title": "InvoicesInvoiceRendering", - "type": "object", - "x-expandableFields": [ - "pdf" - ] - }, "invoices_payment_method_options": { "description": "", "properties": { @@ -18300,6 +21346,15 @@ "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.", "nullable": true }, + "sepa_debit": { + "anyOf": [ + { + "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" + } + ], + "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.", + "nullable": true + }, "us_bank_account": { "anyOf": [ { @@ -18316,6 +21371,7 @@ "card", "customer_balance", "konbini", + "sepa_debit", "us_bank_account" ], "title": "InvoicesPaymentMethodOptions", @@ -18326,6 +21382,7 @@ "card", "customer_balance", "konbini", + "sepa_debit", "us_bank_account" ] }, @@ -18354,6 +21411,7 @@ "ach_credit_transfer", "ach_debit", "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -18368,13 +21426,16 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", "promptpay", + "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", + "swish", "us_bank_account", "wechat_pay" ], @@ -18396,11 +21457,78 @@ "payment_method_options" ] }, + "invoices_resource_from_invoice": { + "description": "", + "properties": { + "action": { + "description": "The relation between this invoice and the cloned invoice", + "maxLength": 5000, + "type": "string" + }, + "invoice": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/invoice" + } + ], + "description": "The invoice that was cloned.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/invoice" + } + ] + } + } + }, + "required": [ + "action", + "invoice" + ], + "title": "InvoicesResourceFromInvoice", + "type": "object", + "x-expandableFields": [ + "invoice" + ] + }, + "invoices_resource_invoice_rendering": { + "description": "", + "properties": { + "amount_tax_display": { + "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "pdf": { + "anyOf": [ + { + "$ref": "#/components/schemas/invoice_rendering_pdf" + } + ], + "description": "Invoice pdf rendering options", + "nullable": true + } + }, + "required": [ + "amount_tax_display", + "pdf" + ], + "title": "InvoicesResourceInvoiceRendering", + "type": "object", + "x-expandableFields": [ + "pdf" + ] + }, "invoices_resource_invoice_tax_id": { "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -18408,6 +21536,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -18417,11 +21546,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -18431,6 +21562,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -18441,13 +21573,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -18534,7 +21670,7 @@ "credited_items" ] }, - "invoices_shipping_cost": { + "invoices_resource_shipping_cost": { "description": "", "properties": { "amount_subtotal": { @@ -18583,14 +21719,14 @@ "amount_total", "shipping_rate" ], - "title": "InvoicesShippingCost", + "title": "InvoicesResourceShippingCost", "type": "object", "x-expandableFields": [ "shipping_rate", "taxes" ] }, - "invoices_status_transitions": { + "invoices_resource_status_transitions": { "description": "", "properties": { "finalized_at": { @@ -18624,7 +21760,7 @@ "paid_at", "voided_at" ], - "title": "InvoicesStatusTransitions", + "title": "InvoicesResourceStatusTransitions", "type": "object", "x-expandableFields": [] }, @@ -18698,6 +21834,24 @@ "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_data" + } + ], + "description": "Fleet-specific information for authorizations using Fleet cards.", + "nullable": true + }, + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fuel_data" + } + ], + "description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -18823,6 +21977,8 @@ "cardholder", "created", "currency", + "fleet", + "fuel", "id", "livemode", "merchant_amount", @@ -18845,6 +22001,8 @@ "balance_transactions", "card", "cardholder", + "fleet", + "fuel", "merchant_data", "network_data", "pending_request", @@ -18899,32 +22057,39 @@ "path": "/v1/test_helpers/issuing/authorizations" }, { - "method_name": "increment", + "method_name": "capture", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/authorizations/{authorization}/increment" + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/capture" }, { - "method_name": "reverse", + "method_name": "expire", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/authorizations/{authorization}/reverse" + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/expire" }, { - "method_name": "expire", + "method_name": "finalize_amount", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/authorizations/{authorization}/expire" + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount" }, { - "method_name": "capture", + "method_name": "increment", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/authorizations/{authorization}/capture" + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/increment" + }, + { + "method_name": "reverse", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/reverse" } ], "x-stripeResource": { @@ -19020,6 +22185,26 @@ ], "type": "string" }, + "personalization_design": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/issuing.personalization_design" + } + ], + "description": "The personalization design object belonging to this card.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/issuing.personalization_design" + } + ] + } + }, "replaced_by": { "anyOf": [ { @@ -19125,6 +22310,7 @@ "livemode", "metadata", "object", + "personalization_design", "replaced_by", "replacement_for", "replacement_reason", @@ -19138,6 +22324,7 @@ "type": "object", "x-expandableFields": [ "cardholder", + "personalization_design", "replaced_by", "replacement_for", "shipping", @@ -19153,13 +22340,6 @@ "operation": "get", "path": "/v1/issuing/cards" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/issuing/cards" - }, { "method_name": "retrieve", "method_on": "service", @@ -19167,6 +22347,13 @@ "operation": "get", "path": "/v1/issuing/cards/{card}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/issuing/cards" + }, { "method_name": "update", "method_on": "service", @@ -19182,11 +22369,11 @@ "path": "/v1/test_helpers/issuing/cards/{card}/shipping/deliver" }, { - "method_name": "ship_card", + "method_name": "fail_card", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/cards/{card}/shipping/ship" + "path": "/v1/test_helpers/issuing/cards/{card}/shipping/fail" }, { "method_name": "return_card", @@ -19196,11 +22383,11 @@ "path": "/v1/test_helpers/issuing/cards/{card}/shipping/return" }, { - "method_name": "fail_card", + "method_name": "ship_card", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/cards/{card}/shipping/fail" + "path": "/v1/test_helpers/issuing/cards/{card}/shipping/ship" } ], "x-stripeResource": { @@ -19361,13 +22548,6 @@ "operation": "get", "path": "/v1/issuing/cardholders" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/issuing/cardholders" - }, { "method_name": "retrieve", "method_on": "service", @@ -19375,6 +22555,13 @@ "operation": "get", "path": "/v1/issuing/cardholders/{cardholder}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/issuing/cardholders" + }, { "method_name": "update", "method_on": "service", @@ -19425,6 +22612,32 @@ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, + "loss_reason": { + "description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.", + "enum": [ + "cardholder_authentication_issuer_liability", + "eci5_token_transaction_with_tavv", + "excess_disputes_in_timeframe", + "has_not_met_the_minimum_dispute_amount_requirements", + "invalid_duplicate_dispute", + "invalid_incorrect_amount_dispute", + "invalid_no_authorization", + "invalid_use_of_disputes", + "merchandise_delivered_or_shipped", + "merchandise_or_service_as_described", + "not_cancelled", + "other", + "refund_issued", + "submitted_beyond_allowable_time_limit", + "transaction_3ds_required", + "transaction_approved_after_prior_fraud_dispute", + "transaction_authorized", + "transaction_electronically_read", + "transaction_qualifies_for_visa_easy_payment_service", + "transaction_unattended" + ], + "type": "string" + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -19482,7 +22695,6 @@ }, "required": [ "amount", - "balance_transactions", "created", "currency", "evidence", @@ -19510,6 +22722,13 @@ "operation": "get", "path": "/v1/issuing/disputes" }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/issuing/disputes/{dispute}" + }, { "method_name": "create", "method_on": "service", @@ -19524,13 +22743,6 @@ "operation": "post", "path": "/v1/issuing/disputes/{dispute}" }, - { - "method_name": "retrieve", - "method_on": "service", - "method_type": "retrieve", - "operation": "get", - "path": "/v1/issuing/disputes/{dispute}" - }, { "method_name": "submit", "method_on": "service", @@ -19548,6 +22760,279 @@ ] } }, + "issuing.personalization_design": { + "description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.", + "properties": { + "card_logo": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/file" + } + ], + "description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/file" + } + ] + } + }, + "carrier_text": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_personalization_design_carrier_text" + } + ], + "description": "Hash containing carrier text, for use with physical bundles that support carrier text.", + "nullable": true + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "lookup_key": { + "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "type": "object" + }, + "name": { + "description": "Friendly display name.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "issuing.personalization_design" + ], + "type": "string" + }, + "physical_bundle": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/issuing.physical_bundle" + } + ], + "description": "The physical bundle object belonging to this personalization design.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/issuing.physical_bundle" + } + ] + } + }, + "preferences": { + "$ref": "#/components/schemas/issuing_personalization_design_preferences" + }, + "rejection_reasons": { + "$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons" + }, + "status": { + "description": "Whether this personalization design can be used to create cards.", + "enum": [ + "active", + "inactive", + "rejected", + "review" + ], + "type": "string" + } + }, + "required": [ + "card_logo", + "carrier_text", + "created", + "id", + "livemode", + "lookup_key", + "metadata", + "name", + "object", + "physical_bundle", + "preferences", + "rejection_reasons", + "status" + ], + "title": "IssuingPersonalizationDesign", + "type": "object", + "x-expandableFields": [ + "card_logo", + "carrier_text", + "physical_bundle", + "preferences", + "rejection_reasons" + ], + "x-resourceId": "issuing.personalization_design", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/issuing/personalization_designs" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/issuing/personalization_designs/{personalization_design}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/issuing/personalization_designs" + }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/issuing/personalization_designs/{personalization_design}" + }, + { + "method_name": "activate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate" + }, + { + "method_name": "deactivate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate" + }, + { + "method_name": "reject", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject" + } + ], + "x-stripeResource": { + "class_name": "PersonalizationDesign", + "has_collection_class": true, + "in_package": "Issuing" + } + }, + "issuing.physical_bundle": { + "description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.", + "properties": { + "features": { + "$ref": "#/components/schemas/issuing_physical_bundle_features" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "name": { + "description": "Friendly display name.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "issuing.physical_bundle" + ], + "type": "string" + }, + "status": { + "description": "Whether this physical bundle can be used to create cards.", + "enum": [ + "active", + "inactive", + "review" + ], + "type": "string" + }, + "type": { + "description": "Whether this physical bundle is a standard Stripe offering or custom-made for you.", + "enum": [ + "custom", + "standard" + ], + "type": "string" + } + }, + "required": [ + "features", + "id", + "livemode", + "name", + "object", + "status", + "type" + ], + "title": "IssuingPhysicalBundle", + "type": "object", + "x-expandableFields": [ + "features" + ], + "x-resourceId": "issuing.physical_bundle", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/issuing/physical_bundles" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/issuing/physical_bundles/{physical_bundle}" + } + ], + "x-stripeResource": { + "class_name": "PhysicalBundle", + "has_collection_class": true, + "in_package": "Issuing" + } + }, "issuing.token": { "description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.", "properties": { @@ -19576,7 +23061,7 @@ "type": "integer" }, "device_fingerprint": { - "description": "The hashed ID derived from the device ID from the card network associated with the token", + "description": "The hashed ID derived from the device ID from the card network associated with the token.", "maxLength": 5000, "nullable": true, "type": "string" @@ -19929,7 +23414,6 @@ "metadata", "network_data", "object", - "purchase_details", "type", "wallet" ], @@ -19972,25 +23456,25 @@ "path": "/v1/issuing/transactions/{transaction}" }, { - "method_name": "create_force_capture", + "method_name": "refund", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/transactions/create_force_capture" + "path": "/v1/test_helpers/issuing/transactions/{transaction}/refund" }, { - "method_name": "create_unlinked_refund", + "method_name": "create_force_capture", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/transactions/create_unlinked_refund" + "path": "/v1/test_helpers/issuing/transactions/create_force_capture" }, { - "method_name": "refund", + "method_name": "create_unlinked_refund", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/issuing/transactions/{transaction}/refund" + "path": "/v1/test_helpers/issuing/transactions/create_unlinked_refund" } ], "x-stripeResource": { @@ -20019,7 +23503,7 @@ } }, "issuing_authorization.request": { - "description": "Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](/docs/issuing/purchases/authorizations#authorization-handling).", + "description": "Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](https://docs.stripe.com/issuing/purchases/authorizations#authorization-handling).", "properties": { "object": { "$ref": "#/components/schemas/issuing.authorization" @@ -20102,6 +23586,274 @@ "type": "object", "x-expandableFields": [] }, + "issuing_authorization_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "alphanumeric_id": { + "description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "alphanumeric_id", + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ], + "title": "IssuingAuthorizationFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data" + } + ], + "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.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown" + } + ], + "description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ], + "title": "IssuingAuthorizationFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_authorization_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingAuthorizationFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingAuthorizationFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "required": [ + "fuel", + "non_fuel", + "tax" + ], + "title": "IssuingAuthorizationFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_authorization_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "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", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "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", + "nullable": true, + "type": "string" + } + }, + "required": [ + "local_amount_decimal", + "national_amount_decimal" + ], + "title": "IssuingAuthorizationFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fuel_data": { + "description": "", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "nullable": true, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "nullable": true, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ], + "title": "IssuingAuthorizationFuelData", + "type": "object", + "x-expandableFields": [] + }, "issuing_authorization_merchant_data": { "description": "", "properties": { @@ -20318,11 +24070,16 @@ "enum": [ "account_disabled", "card_active", + "card_canceled", + "card_expired", "card_inactive", + "cardholder_blocked", "cardholder_inactive", "cardholder_verification_required", + "insecure_authorization_method", "insufficient_funds", "not_allowed", + "pin_blocked", "spending_controls", "suspected_fraud", "verification_failed", @@ -20870,6 +24627,15 @@ "nullable": true, "type": "array" }, + "allowed_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { @@ -21175,6 +24941,15 @@ "nullable": true, "type": "array" }, + "blocked_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", "items": { @@ -21191,7 +24966,9 @@ }, "required": [ "allowed_categories", + "allowed_merchant_countries", "blocked_categories", + "blocked_merchant_countries", "spending_limits", "spending_limits_currency" ], @@ -21233,6 +25010,15 @@ "address": { "$ref": "#/components/schemas/address" }, + "address_validation": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_card_shipping_address_validation" + } + ], + "description": "Address validation details for the shipment.", + "nullable": true + }, "carrier": { "description": "The delivery company that shipped a card.", "enum": [ @@ -21337,9 +25123,53 @@ "type": "object", "x-expandableFields": [ "address", + "address_validation", "customs" ] }, + "issuing_card_shipping_address_validation": { + "description": "", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + }, + "normalized_address": { + "anyOf": [ + { + "$ref": "#/components/schemas/address" + } + ], + "description": "The normalized shipping address.", + "nullable": true + }, + "result": { + "description": "The validation result for the shipping address.", + "enum": [ + "indeterminate", + "likely_deliverable", + "likely_undeliverable" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "mode", + "normalized_address", + "result" + ], + "title": "IssuingCardShippingAddressValidation", + "type": "object", + "x-expandableFields": [ + "normalized_address" + ] + }, "issuing_card_shipping_customs": { "description": "", "properties": { @@ -22075,6 +25905,15 @@ "nullable": true, "type": "array" }, + "allowed_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { @@ -22380,6 +26219,15 @@ "nullable": true, "type": "array" }, + "blocked_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { @@ -22396,7 +26244,9 @@ }, "required": [ "allowed_categories", + "allowed_merchant_countries", "blocked_categories", + "blocked_merchant_countries", "spending_limits", "spending_limits_currency" ], @@ -23061,6 +26911,22 @@ "type": "issuing_dispute.funds_reinstated" } }, + "issuing_dispute.funds_rescinded": { + "description": "Occurs whenever funds are deducted from your account for an Issuing dispute.", + "properties": { + "object": { + "$ref": "#/components/schemas/issuing.dispute" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "issuing_dispute.funds_rescinded" + } + }, "issuing_dispute.submitted": { "description": "Occurs whenever a dispute is submitted.", "properties": { @@ -23322,6 +27188,9 @@ "merchandise_not_as_described": { "$ref": "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence" }, + "no_valid_authorization": { + "$ref": "#/components/schemas/issuing_dispute_no_valid_authorization_evidence" + }, "not_received": { "$ref": "#/components/schemas/issuing_dispute_not_received_evidence" }, @@ -23335,6 +27204,7 @@ "duplicate", "fraudulent", "merchandise_not_as_described", + "no_valid_authorization", "not_received", "other", "service_not_as_described" @@ -23356,6 +27226,7 @@ "duplicate", "fraudulent", "merchandise_not_as_described", + "no_valid_authorization", "not_received", "other", "service_not_as_described" @@ -23472,6 +27343,46 @@ "additional_documentation" ] }, + "issuing_dispute_no_valid_authorization_evidence": { + "description": "", + "properties": { + "additional_documentation": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/file" + } + ], + "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/file" + } + ] + } + }, + "explanation": { + "description": "Explanation of why the cardholder is disputing this transaction.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "additional_documentation", + "explanation" + ], + "title": "IssuingDisputeNoValidAuthorizationEvidence", + "type": "object", + "x-expandableFields": [ + "additional_documentation" + ] + }, "issuing_dispute_not_received_evidence": { "description": "", "properties": { @@ -23939,6 +27850,216 @@ "cardholder_address" ] }, + "issuing_personalization_design.activated": { + "description": "Occurs whenever a personalization design is activated following the activation of the physical bundle that belongs to it.", + "properties": { + "object": { + "$ref": "#/components/schemas/issuing.personalization_design" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "issuing_personalization_design.activated" + } + }, + "issuing_personalization_design.deactivated": { + "description": "Occurs whenever a personalization design is deactivated following the deactivation of the physical bundle that belongs to it.", + "properties": { + "object": { + "$ref": "#/components/schemas/issuing.personalization_design" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "issuing_personalization_design.deactivated" + } + }, + "issuing_personalization_design.rejected": { + "description": "Occurs whenever a personalization design is rejected by design review.", + "properties": { + "object": { + "$ref": "#/components/schemas/issuing.personalization_design" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "issuing_personalization_design.rejected" + } + }, + "issuing_personalization_design.updated": { + "description": "Occurs whenever a personalization design is updated.", + "properties": { + "object": { + "$ref": "#/components/schemas/issuing.personalization_design" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "issuing_personalization_design.updated" + } + }, + "issuing_personalization_design_carrier_text": { + "description": "", + "properties": { + "footer_body": { + "description": "The footer body text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "footer_title": { + "description": "The footer title text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "header_body": { + "description": "The header body text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "header_title": { + "description": "The header title text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ], + "title": "IssuingPersonalizationDesignCarrierText", + "type": "object", + "x-expandableFields": [] + }, + "issuing_personalization_design_preferences": { + "description": "", + "properties": { + "is_default": { + "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.", + "type": "boolean" + }, + "is_platform_default": { + "description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.", + "nullable": true, + "type": "boolean" + } + }, + "required": [ + "is_default", + "is_platform_default" + ], + "title": "IssuingPersonalizationDesignPreferences", + "type": "object", + "x-expandableFields": [] + }, + "issuing_personalization_design_rejection_reasons": { + "description": "", + "properties": { + "card_logo": { + "description": "The reason(s) the card logo was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_binary_image", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "carrier_text": { + "description": "The reason(s) the carrier text was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "card_logo", + "carrier_text" + ], + "title": "IssuingPersonalizationDesignRejectionReasons", + "type": "object", + "x-expandableFields": [] + }, + "issuing_physical_bundle_features": { + "description": "", + "properties": { + "card_logo": { + "description": "The policy for how to use card logo images in a card design with this physical bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + }, + "carrier_text": { + "description": "The policy for how to use carrier letter text in a card design with this physical bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + }, + "second_line": { + "description": "The policy for how to use a second line on a card with this physical bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + } + }, + "required": [ + "card_logo", + "carrier_text", + "second_line" + ], + "title": "IssuingPhysicalBundleFeatures", + "type": "object", + "x-expandableFields": [] + }, "issuing_token.created": { "description": "Occurs whenever an issuing digital wallet token is created.", "properties": { @@ -24025,6 +28146,199 @@ "type": "object", "x-expandableFields": [] }, + "issuing_transaction_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ], + "title": "IssuingTransactionFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data" + } + ], + "description": "Answers to prompts presented to cardholder at point of sale.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown" + } + ], + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ], + "title": "IssuingTransactionFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_transaction_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingTransactionFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingTransactionFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "required": [ + "fuel", + "non_fuel", + "tax" + ], + "title": "IssuingTransactionFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_transaction_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "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", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "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", + "nullable": true, + "type": "string" + } + }, + "required": [ + "local_amount_decimal", + "national_amount_decimal" + ], + "title": "IssuingTransactionFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, "issuing_transaction_flight_data": { "description": "", "properties": { @@ -24126,13 +28440,25 @@ "issuing_transaction_fuel_data": { "description": "", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "maxLength": 5000, "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", "maxLength": 5000, "type": "string" }, @@ -24140,19 +28466,14 @@ "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" - }, - "volume_decimal": { - "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.", - "format": "decimal", - "nullable": true, - "type": "string" } }, "required": [ + "industry_product_code", + "quantity_decimal", "type", "unit", - "unit_cost_decimal", - "volume_decimal" + "unit_cost_decimal" ], "title": "IssuingTransactionFuelData", "type": "object", @@ -24214,6 +28535,15 @@ "issuing_transaction_purchase_details": { "description": "", "properties": { + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_data" + } + ], + "description": "Fleet-specific information for transactions using Fleet cards.", + "nullable": true + }, "flight": { "anyOf": [ { @@ -24257,6 +28587,7 @@ } }, "required": [ + "fleet", "flight", "fuel", "lodging", @@ -24266,6 +28597,7 @@ "title": "IssuingTransactionPurchaseDetails", "type": "object", "x-expandableFields": [ + "fleet", "flight", "fuel", "lodging", @@ -24523,6 +28855,7 @@ "public_company", "public_corporation", "public_partnership", + "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", @@ -25015,7 +29348,6 @@ ] } }, - "nullable": true, "type": "array" }, "id": { @@ -25023,6 +29355,12 @@ "maxLength": 5000, "type": "string" }, + "invoice": { + "description": "The ID of the invoice that contains this line item.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "invoice_item": { "anyOf": [ { @@ -25051,7 +29389,7 @@ "maxLength": 500, "type": "string" }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created.", + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.", "type": "object" }, "object": { @@ -25177,6 +29515,7 @@ "discountable", "discounts", "id", + "invoice", "livemode", "metadata", "object", @@ -25310,6 +29649,9 @@ "linked_account_options_us_bank_account": { "description": "", "properties": { + "filters": { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters" + }, "permissions": { "description": "The list of permissions to request. The `payment_method` permission must be included.", "items": { @@ -25328,6 +29670,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -25347,10 +29690,12 @@ ], "title": "linked_account_options_us_bank_account", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "filters" + ] }, "login_link": { - "description": "Login Links are single-use login link for an Express account to access their Stripe dashboard.", + "description": "Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard.", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -25567,6 +29912,17 @@ "in_package": "" } }, + "mandate_amazon_pay": { + "description": "", + "properties": {}, + "title": "mandate_amazon_pay", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "AmazonPay", + "in_package": "" + } + }, "mandate_au_becs_debit": { "description": "", "properties": { @@ -25601,6 +29957,18 @@ "maxLength": 5000, "type": "string" }, + "revocation_reason": { + "description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation.", + "enum": [ + "account_closed", + "bank_account_restricted", + "bank_ownership_changed", + "could_not_process", + "debit_not_authorized" + ], + "nullable": true, + "type": "string" + }, "url": { "description": "The URL that will contain the mandate that the customer has signed.", "maxLength": 5000, @@ -25610,6 +29978,7 @@ "required": [ "network_status", "reference", + "revocation_reason", "url" ], "title": "mandate_bacs_debit", @@ -25647,6 +30016,9 @@ "acss_debit": { "$ref": "#/components/schemas/mandate_acss_debit" }, + "amazon_pay": { + "$ref": "#/components/schemas/mandate_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/mandate_au_becs_debit" }, @@ -25665,6 +30037,9 @@ "paypal": { "$ref": "#/components/schemas/mandate_paypal" }, + "revolut_pay": { + "$ref": "#/components/schemas/mandate_revolut_pay" + }, "sepa_debit": { "$ref": "#/components/schemas/mandate_sepa_debit" }, @@ -25684,12 +30059,14 @@ "type": "object", "x-expandableFields": [ "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "card", "cashapp", "link", "paypal", + "revolut_pay", "sepa_debit", "us_bank_account" ] @@ -25718,6 +30095,17 @@ "type": "object", "x-expandableFields": [] }, + "mandate_revolut_pay": { + "description": "", + "properties": {}, + "title": "mandate_revolut_pay", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "RevolutPay", + "in_package": "" + } + }, "mandate_sepa_debit": { "description": "", "properties": { @@ -25796,7 +30184,7 @@ "type": "array" }, "preferred": { - "description": "The preferred network for the card.", + "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.", "maxLength": 5000, "nullable": true, "type": "string" @@ -25988,8 +30376,27 @@ "nullable": true, "type": "string" }, + "mandate": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/mandate" + } + ], + "description": "ID of the mandate used to make this payment.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/mandate" + } + ] + } + }, "network": { - "description": "The US bank account network used to send funds.", + "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" @@ -26014,7 +30421,9 @@ ], "title": "outbound_payments_payment_method_details_us_bank_account", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "mandate" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -26092,8 +30501,27 @@ "nullable": true, "type": "string" }, + "mandate": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/mandate" + } + ], + "description": "ID of the mandate used to make this payment.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/mandate" + } + ] + } + }, "network": { - "description": "The US bank account network used to send funds.", + "description": "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" @@ -26118,7 +30546,9 @@ ], "title": "outbound_transfers_payment_method_details_us_bank_account", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "mandate" + ], "x-stripeResource": { "class_name": "UsBankAccount", "in_package": "" @@ -26366,6 +30796,27 @@ "type": "object", "x-expandableFields": [] }, + "payment_flows_private_payment_methods_card_present_common_wallet": { + "description": "", + "properties": { + "type": { + "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.", + "enum": [ + "apple_pay", + "google_pay", + "samsung_pay", + "unknown" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet", + "type": "object", + "x-expandableFields": [] + }, "payment_flows_private_payment_methods_klarna_dob": { "description": "", "properties": { @@ -26394,6 +30845,25 @@ "type": "object", "x-expandableFields": [] }, + "payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters": { + "description": "", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters", + "type": "object", + "x-expandableFields": [] + }, "payment_intent": { "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)", "properties": { @@ -26511,7 +30981,7 @@ "$ref": "#/components/schemas/deleted_customer" } ], - "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.", + "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -26574,7 +31044,7 @@ "$ref": "#/components/schemas/charge" } ], - "description": "The latest charge created by this PaymentIntent.", + "description": "ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -26714,7 +31184,7 @@ } }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -26758,13 +31228,13 @@ } }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 5000, "nullable": true, "type": "string" @@ -26862,20 +31332,6 @@ ], "x-resourceId": "payment_intent", "x-stripeOperations": [ - { - "method_name": "search", - "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/payment_intents/search" - }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/payment_intents" - }, { "method_name": "list", "method_on": "service", @@ -26890,6 +31346,20 @@ "operation": "get", "path": "/v1/payment_intents/{intent}" }, + { + "method_name": "search", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/payment_intents/search" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/payment_intents" + }, { "method_name": "update", "method_on": "service", @@ -26898,11 +31368,11 @@ "path": "/v1/payment_intents/{intent}" }, { - "method_name": "confirm", + "method_name": "apply_customer_balance", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/payment_intents/{intent}/confirm" + "path": "/v1/payment_intents/{intent}/apply_customer_balance" }, { "method_name": "cancel", @@ -26919,25 +31389,25 @@ "path": "/v1/payment_intents/{intent}/capture" }, { - "method_name": "increment_authorization", + "method_name": "confirm", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/payment_intents/{intent}/increment_authorization" + "path": "/v1/payment_intents/{intent}/confirm" }, { - "method_name": "verify_microdeposits", + "method_name": "increment_authorization", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/payment_intents/{intent}/verify_microdeposits" + "path": "/v1/payment_intents/{intent}/increment_authorization" }, { - "method_name": "apply_customer_balance", + "method_name": "verify_microdeposits", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/payment_intents/{intent}/apply_customer_balance" + "path": "/v1/payment_intents/{intent}/verify_microdeposits" } ], "x-stripeResource": { @@ -26948,7 +31418,7 @@ } }, "payment_intent.amount_capturable_updated": { - "description": "Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://stripe.com/docs/api/payment_intents/capture)", + "description": "Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://docs.stripe.com/api/payment_intents/capture)", "properties": { "object": { "$ref": "#/components/schemas/payment_intent" @@ -27113,6 +31583,9 @@ "konbini_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_konbini" }, + "multibanco_display_details": { + "$ref": "#/components/schemas/payment_intent_next_action_display_multibanco_details" + }, "oxxo_display_details": { "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details" }, @@ -27128,6 +31601,9 @@ "redirect_to_url": { "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url" }, + "swish_handle_redirect_or_display_qr_code": { + "$ref": "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code" + }, "type": { "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.", "maxLength": 5000, @@ -27162,11 +31638,13 @@ "cashapp_handle_redirect_or_display_qr_code", "display_bank_transfer_instructions", "konbini_display_details", + "multibanco_display_details", "oxxo_display_details", "paynow_display_qr_code", "pix_display_qr_code", "promptpay_display_qr_code", "redirect_to_url", + "swish_handle_redirect_or_display_qr_code", "verify_with_microdeposits", "wechat_pay_display_qr_code", "wechat_pay_redirect_to_android_app", @@ -27410,6 +31888,48 @@ "in_package": "" } }, + "payment_intent_next_action_display_multibanco_details": { + "description": "", + "properties": { + "entity": { + "description": "Entity number associated with this Multibanco payment.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "expires_at": { + "description": "The timestamp at which the Multibanco voucher expires.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, + "hosted_voucher_url": { + "description": "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "reference": { + "description": "Reference number associated with this Multibanco payment.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "entity", + "expires_at", + "hosted_voucher_url", + "reference" + ], + "title": "PaymentIntentNextActionDisplayMultibancoDetails", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "NextActionMultibancoDisplayDetails", + "in_package": "" + } + }, "payment_intent_next_action_display_oxxo_details": { "description": "", "properties": { @@ -27778,6 +32298,70 @@ "in_package": "" } }, + "payment_intent_next_action_swish_handle_redirect_or_display_qr_code": { + "description": "", + "properties": { + "hosted_instructions_url": { + "description": "The URL to the hosted Swish instructions page, which allows customers to view the QR code.", + "maxLength": 5000, + "type": "string" + }, + "mobile_auth_url": { + "description": "The url for mobile redirect based auth (for internal use only and not typically available in standard API requests).", + "maxLength": 5000, + "type": "string" + }, + "qr_code": { + "$ref": "#/components/schemas/payment_intent_next_action_swish_qr_code" + } + }, + "required": [ + "hosted_instructions_url", + "mobile_auth_url", + "qr_code" + ], + "title": "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode", + "type": "object", + "x-expandableFields": [ + "qr_code" + ], + "x-stripeResource": { + "class_name": "SwishHandleRedirectOrDisplayQrCode", + "in_package": "" + } + }, + "payment_intent_next_action_swish_qr_code": { + "description": "", + "properties": { + "data": { + "description": "The raw data string used to generate QR code, it should be used together with QR code library.", + "maxLength": 5000, + "type": "string" + }, + "image_url_png": { + "description": "The image_url_png string used to render QR code", + "maxLength": 5000, + "type": "string" + }, + "image_url_svg": { + "description": "The image_url_svg string used to render QR code", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "image_url_png", + "image_url_svg" + ], + "title": "PaymentIntentNextActionSwishQRCode", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "SwishQrCode", + "in_package": "" + } + }, "payment_intent_next_action_verify_with_microdeposits": { "description": "", "properties": { @@ -27945,11 +32529,14 @@ "alipay": { "$ref": "#/components/schemas/payment_method_options_alipay" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_options_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit" }, "bacs_debit": { - "$ref": "#/components/schemas/payment_method_options_bacs_debit" + "$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit" }, "bancontact": { "$ref": "#/components/schemas/payment_method_options_bancontact" @@ -27999,6 +32586,12 @@ "link": { "$ref": "#/components/schemas/payment_intent_payment_method_options_link" }, + "mobilepay": { + "$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay" + }, + "multibanco": { + "$ref": "#/components/schemas/payment_method_options_multibanco" + }, "oxxo": { "$ref": "#/components/schemas/payment_method_options_oxxo" }, @@ -28026,6 +32619,12 @@ "sofort": { "$ref": "#/components/schemas/payment_method_options_sofort" }, + "swish": { + "$ref": "#/components/schemas/payment_intent_payment_method_options_swish" + }, + "twint": { + "$ref": "#/components/schemas/payment_method_options_twint" + }, "us_bank_account": { "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account" }, @@ -28043,6 +32642,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -28061,6 +32661,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -28070,6 +32672,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -28082,7 +32686,7 @@ "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -28111,7 +32715,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -28124,9 +32728,40 @@ "type": "object", "x-expandableFields": [] }, + "payment_intent_payment_method_options_bacs_debit": { + "description": "", + "properties": { + "mandate_options": { + "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_intent_payment_method_options_bacs_debit", + "type": "object", + "x-expandableFields": [ + "mandate_options" + ] + }, "payment_intent_payment_method_options_blik": { "description": "", - "properties": {}, + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, "title": "payment_intent_payment_method_options_blik", "type": "object", "x-expandableFields": [] @@ -28167,6 +32802,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -28186,7 +32822,7 @@ "type": "string" }, "request_incremental_authorization": { - "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", + "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" @@ -28210,7 +32846,7 @@ "type": "string" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -28220,8 +32856,12 @@ "type": "string", "x-stripeBypassValidation": true }, + "require_cvc_recollection": { + "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", + "type": "boolean" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -28257,7 +32897,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -28285,7 +32925,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -28343,6 +32983,17 @@ "type": "object", "x-expandableFields": [] }, + "payment_intent_payment_method_options_mandate_options_bacs_debit": { + "description": "", + "properties": {}, + "title": "payment_intent_payment_method_options_mandate_options_bacs_debit", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "BacsDebitMandateOptions", + "in_package": "" + } + }, "payment_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": {}, @@ -28354,6 +33005,28 @@ "in_package": "" } }, + "payment_intent_payment_method_options_mobilepay": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\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" + ], + "type": "string" + } + }, + "title": "payment_intent_payment_method_options_mobilepay", + "type": "object", + "x-expandableFields": [] + }, "payment_intent_payment_method_options_sepa_debit": { "description": "", "properties": { @@ -28361,7 +33034,7 @@ "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -28376,6 +33049,30 @@ "mandate_options" ] }, + "payment_intent_payment_method_options_swish": { + "description": "", + "properties": { + "reference": { + "description": "The order ID displayed in the Swish app after the payment is authorized.", + "maxLength": 35, + "nullable": true, + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\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" + ], + "type": "string" + } + }, + "required": [ + "reference" + ], + "title": "payment_intent_payment_method_options_swish", + "type": "object", + "x-expandableFields": [] + }, "payment_intent_payment_method_options_us_bank_account": { "description": "", "properties": { @@ -28394,7 +33091,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -28484,8 +33181,19 @@ "installments": { "$ref": "#/components/schemas/payment_flows_installment_options" }, + "request_incremental_authorization_support": { + "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", + "type": "boolean" + }, + "require_cvc_recollection": { + "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", + "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/payment_method_options_card_present_routing" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -28507,7 +33215,8 @@ "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient", "type": "object", "x-expandableFields": [ - "installments" + "installments", + "routing" ] }, "payment_link": { @@ -28564,7 +33273,7 @@ "$ref": "#/components/schemas/payment_links_resource_automatic_tax" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -28585,7 +33294,7 @@ "type": "string" }, "custom_fields": { - "description": "Collect additional information from your customer using custom fields. Up to 2 fields are supported.", + "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "$ref": "#/components/schemas/payment_links_resource_custom_fields" }, @@ -28710,7 +33419,7 @@ "nullable": true }, "payment_method_collection": { - "description": "Configuration for collecting a payment method during checkout.", + "description": "Configuration for collecting a payment method during checkout. Defaults to `always`.", "enum": [ "always", "if_required" @@ -28739,6 +33448,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -28747,8 +33458,11 @@ "promptpay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -28986,14 +33700,26 @@ "enabled": { "description": "If `true`, tax will be calculated automatically using the customer's location.", "type": "boolean" + }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true } }, "required": [ - "enabled" + "enabled", + "liability" ], "title": "PaymentLinksResourceAutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "payment_links_resource_completed_sessions": { "description": "", @@ -29404,6 +34130,15 @@ "nullable": true, "type": "string" }, + "issuer": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "nullable": true + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -29428,6 +34163,7 @@ "custom_fields", "description", "footer", + "issuer", "metadata", "rendering_options" ], @@ -29436,6 +34172,7 @@ "x-expandableFields": [ "account_tax_ids", "custom_fields", + "issuer", "rendering_options" ] }, @@ -29476,13 +34213,13 @@ "type": "string" }, "statement_descriptor": { - "description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.", + "description": "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "description": "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.", "maxLength": 5000, "nullable": true, "type": "string" @@ -29860,6 +34597,9 @@ "nullable": true, "type": "string" }, + "invoice_settings": { + "$ref": "#/components/schemas/payment_links_resource_subscription_data_invoice_settings" + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -29885,6 +34625,7 @@ }, "required": [ "description", + "invoice_settings", "metadata", "trial_period_days", "trial_settings" @@ -29892,9 +34633,26 @@ "title": "PaymentLinksResourceSubscriptionData", "type": "object", "x-expandableFields": [ + "invoice_settings", "trial_settings" ] }, + "payment_links_resource_subscription_data_invoice_settings": { + "description": "", + "properties": { + "issuer": { + "$ref": "#/components/schemas/connect_account_reference" + } + }, + "required": [ + "issuer" + ], + "title": "PaymentLinksResourceSubscriptionDataInvoiceSettings", + "type": "object", + "x-expandableFields": [ + "issuer" + ] + }, "payment_links_resource_tax_id_collection": { "description": "", "properties": { @@ -29963,6 +34721,18 @@ "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_au_becs_debit" }, @@ -30063,6 +34833,12 @@ "nullable": true, "type": "object" }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_mobilepay" + }, + "multibanco": { + "$ref": "#/components/schemas/payment_method_multibanco" + }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ @@ -30100,6 +34876,12 @@ "sofort": { "$ref": "#/components/schemas/payment_method_sofort" }, + "swish": { + "$ref": "#/components/schemas/payment_method_swish" + }, + "twint": { + "$ref": "#/components/schemas/payment_method_twint" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -30107,6 +34889,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -30125,6 +34908,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -30134,6 +34919,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -30168,6 +34955,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -30188,6 +34976,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -30198,6 +34988,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -30205,10 +34997,10 @@ "x-resourceId": "payment_method", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/payment_methods" }, { @@ -30219,18 +35011,18 @@ "path": "/v1/payment_methods/{payment_method}" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/payment_methods/{payment_method}" + "path": "/v1/payment_methods" }, { - "method_name": "list", + "method_name": "update", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/payment_methods" + "method_type": "update", + "operation": "post", + "path": "/v1/payment_methods/{payment_method}" }, { "method_name": "attach", @@ -30302,7 +35094,7 @@ } }, "payment_method.updated": { - "description": "Occurs whenever a payment method is updated via the [PaymentMethod update API](https://stripe.com/docs/api/payment_methods/update).", + "description": "Occurs whenever a payment method is updated via the [PaymentMethod update API](https://docs.stripe.com/api/payment_methods/update).", "properties": { "object": { "$ref": "#/components/schemas/payment_method" @@ -30376,6 +35168,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_amazon_pay": { + "description": "", + "properties": {}, + "title": "payment_method_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_au_becs_debit": { "description": "", "properties": { @@ -30497,6 +35296,12 @@ "nullable": true, "type": "string" }, + "display_brand": { + "description": "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "exp_month": { "description": "Two-digit number representing the card's expiration month.", "type": "integer" @@ -30516,6 +35321,15 @@ "maxLength": 5000, "type": "string" }, + "generated_from": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_card_generated_card" + } + ], + "description": "Details of the original PaymentMethod that created this object.", + "nullable": true + }, "iin": { "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", "maxLength": 5000, @@ -30565,9 +35379,11 @@ "brand", "checks", "country", + "display_brand", "exp_month", "exp_year", "funding", + "generated_from", "last4", "networks", "three_d_secure_usage", @@ -30577,6 +35393,7 @@ "type": "object", "x-expandableFields": [ "checks", + "generated_from", "networks", "three_d_secure_usage", "wallet" @@ -30613,6 +35430,57 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_card_generated_card": { + "description": "", + "properties": { + "charge": { + "description": "The charge that created this object.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "payment_method_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/card_generated_from_payment_method_details" + } + ], + "description": "Transaction-specific details of the payment method used in the payment.", + "nullable": true + }, + "setup_attempt": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/setup_attempt" + } + ], + "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/setup_attempt" + } + ] + } + } + }, + "required": [ + "charge", + "payment_method_details", + "setup_attempt" + ], + "title": "payment_method_card_generated_card", + "type": "object", + "x-expandableFields": [ + "payment_method_details", + "setup_attempt" + ] + }, "payment_method_card_present": { "description": "", "properties": { @@ -30622,6 +35490,12 @@ "nullable": true, "type": "string" }, + "brand_product": { + "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "cardholder_name": { "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.", "maxLength": 5000, @@ -30687,6 +35561,24 @@ "description": "Contains information about card networks that can be used to process the payment.", "nullable": true }, + "offline": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_details_card_present_offline" + } + ], + "description": "Details about payment methods collected offline.", + "nullable": true + }, + "preferred_locales": { + "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ @@ -30698,10 +35590,14 @@ ], "nullable": true, "type": "string" + }, + "wallet": { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet" } }, "required": [ "brand", + "brand_product", "cardholder_name", "country", "exp_month", @@ -30710,12 +35606,16 @@ "funding", "last4", "networks", + "offline", + "preferred_locales", "read_method" ], "title": "payment_method_card_present", "type": "object", "x-expandableFields": [ - "networks" + "networks", + "offline", + "wallet" ] }, "payment_method_card_present_networks": { @@ -31055,6 +35955,9 @@ "alipay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "apple_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, @@ -31088,6 +35991,9 @@ "cashapp": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, + "customer_balance": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "eps": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, @@ -31131,6 +36037,12 @@ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, + "multibanco": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "name": { "description": "The configuration's name.", "maxLength": 5000, @@ -31173,11 +36085,20 @@ "sofort": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, + "swish": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, + "twint": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "us_bank_account": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, "wechat_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, + "zip": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" } }, "required": [ @@ -31197,6 +36118,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "apple_pay", "au_becs_debit", "bacs_debit", @@ -31206,6 +36128,7 @@ "card", "cartes_bancaires", "cashapp", + "customer_balance", "eps", "fpx", "giropay", @@ -31216,6 +36139,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -31224,8 +36149,11 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "x-resourceId": "payment_method_configuration", "x-stripeOperations": [ @@ -31244,18 +36172,18 @@ "path": "/v1/payment_method_configurations/{configuration}" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/payment_method_configurations/{configuration}" + "path": "/v1/payment_method_configurations" }, { - "method_name": "create", + "method_name": "update", "method_on": "service", - "method_type": "create", + "method_type": "update", "operation": "post", - "path": "/v1/payment_method_configurations" + "path": "/v1/payment_method_configurations/{configuration}" } ], "x-stripeResource": { @@ -31292,6 +36220,9 @@ "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details" }, + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_details_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/payment_method_details_au_becs_debit" }, @@ -31346,6 +36277,9 @@ "link": { "$ref": "#/components/schemas/payment_method_details_link" }, + "mobilepay": { + "$ref": "#/components/schemas/payment_method_details_mobilepay" + }, "multibanco": { "$ref": "#/components/schemas/payment_method_details_multibanco" }, @@ -31382,6 +36316,12 @@ "stripe_account": { "$ref": "#/components/schemas/payment_method_details_stripe_account" }, + "swish": { + "$ref": "#/components/schemas/payment_method_details_swish" + }, + "twint": { + "$ref": "#/components/schemas/payment_method_details_twint" + }, "type": { "description": "The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.", "maxLength": 5000, @@ -31412,6 +36352,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -31430,6 +36371,7 @@ "klarna", "konbini", "link", + "mobilepay", "multibanco", "oxxo", "p24", @@ -31442,6 +36384,8 @@ "sepa_debit", "sofort", "stripe_account", + "swish", + "twint", "us_bank_account", "wechat", "wechat_pay", @@ -31593,7 +36537,17 @@ }, "payment_method_details_affirm": { "description": "", - "properties": {}, + "properties": { + "transaction_id": { + "description": "The Affirm transaction ID associated with this payment.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "transaction_id" + ], "title": "payment_method_details_affirm", "type": "object", "x-expandableFields": [] @@ -31622,6 +36576,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_amazon_pay": { + "description": "", + "properties": {}, + "title": "payment_method_details_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_au_becs_debit": { "description": "", "properties": { @@ -31800,7 +36761,17 @@ }, "payment_method_details_blik": { "description": "", - "properties": {}, + "properties": { + "buyer_id": { + "description": "A unique and immutable identifier assigned by BLIK to every buyer.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "buyer_id" + ], "title": "payment_method_details_blik", "type": "object", "x-expandableFields": [] @@ -31829,6 +36800,12 @@ "nullable": true, "type": "integer" }, + "authorization_code": { + "description": "Authorization code on the charge.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "brand": { "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "maxLength": 5000, @@ -31967,6 +36944,7 @@ }, "required": [ "amount_authorized", + "authorization_code", "brand", "checks", "country", @@ -32068,7 +37046,8 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -32109,6 +37088,12 @@ "nullable": true, "type": "string" }, + "brand_product": { + "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "capture_before": { "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.", "format": "unix-time", @@ -32192,6 +37177,12 @@ "nullable": true, "type": "string" }, + "network_transaction_id": { + "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "offline": { "anyOf": [ { @@ -32205,6 +37196,15 @@ "description": "Defines whether the authorized amount can be over-captured or not", "type": "boolean" }, + "preferred_locales": { + "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "nullable": true, + "type": "array" + }, "read_method": { "description": "How card details were read in this transaction.", "enum": [ @@ -32225,11 +37225,15 @@ ], "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.", "nullable": true + }, + "wallet": { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet" } }, "required": [ "amount_authorized", "brand", + "brand_product", "cardholder_name", "country", "emv_auth_data", @@ -32241,8 +37245,10 @@ "incremental_authorization_supported", "last4", "network", + "network_transaction_id", "offline", "overcapture_supported", + "preferred_locales", "read_method", "receipt" ], @@ -32250,7 +37256,8 @@ "type": "object", "x-expandableFields": [ "offline", - "receipt" + "receipt", + "wallet" ] }, "payment_method_details_card_present_offline": { @@ -32261,10 +37268,19 @@ "format": "unix-time", "nullable": true, "type": "integer" + }, + "type": { + "description": "The method used to process this payment method offline. Only deferred is allowed.", + "enum": [ + "deferred" + ], + "nullable": true, + "type": "string" } }, "required": [ - "stored_at" + "stored_at", + "type" ], "title": "payment_method_details_card_present_offline", "type": "object", @@ -32313,7 +37329,7 @@ "type": "string" }, "cardholder_verification_method": { - "description": "How the cardholder verified ownership of the card.", + "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" @@ -32739,7 +37755,7 @@ "description": "", "properties": { "bank": { - "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", + "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", @@ -32749,6 +37765,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -32772,6 +37789,7 @@ "INGBNL2A", "KNABNL2H", "MOYONL21", + "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", @@ -32934,6 +37952,12 @@ "nullable": true, "type": "string" }, + "network_transaction_id": { + "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "preferred_locales": { "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", "items": { @@ -32977,6 +38001,7 @@ "generated_card", "last4", "network", + "network_transaction_id", "preferred_locales", "read_method", "receipt" @@ -33025,7 +38050,7 @@ "type": "string" }, "cardholder_verification_method": { - "description": "How the cardholder verified ownership of the card.", + "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" @@ -33077,7 +38102,7 @@ "type": "string" }, "preferred_locale": { - "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`", + "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`", "maxLength": 5000, "nullable": true, "type": "string" @@ -33152,6 +38177,28 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_mobilepay": { + "description": "", + "properties": { + "card": { + "anyOf": [ + { + "$ref": "#/components/schemas/internal_card" + } + ], + "description": "Internal card details", + "nullable": true + } + }, + "required": [ + "card" + ], + "title": "payment_method_details_mobilepay", + "type": "object", + "x-expandableFields": [ + "card" + ] + }, "payment_method_details_multibanco": { "description": "", "properties": { @@ -33197,7 +38244,7 @@ "description": "", "properties": { "bank": { - "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.", + "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.", "enum": [ "alior_bank", "bank_millennium", @@ -33223,6 +38270,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "nullable": true, @@ -33557,6 +38605,44 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_swish": { + "description": "", + "properties": { + "fingerprint": { + "description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "payment_reference": { + "description": "Payer bank reference number for the payment", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "verified_phone_last4": { + "description": "The last four digits of the Swish account phone number", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "fingerprint", + "payment_reference", + "verified_phone_last4" + ], + "title": "payment_method_details_swish", + "type": "object", + "x-expandableFields": [] + }, + "payment_method_details_twint": { + "description": "", + "properties": {}, + "title": "payment_method_details_twint", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_us_bank_account": { "description": "", "properties": { @@ -33596,6 +38682,31 @@ "nullable": true, "type": "string" }, + "mandate": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/mandate" + } + ], + "description": "ID of the mandate used to make this payment.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/mandate" + } + ] + } + }, + "payment_reference": { + "description": "Reference number to locate ACH payments with customer's bank.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "routing_number": { "description": "Routing number of the bank account.", "maxLength": 5000, @@ -33609,11 +38720,14 @@ "bank_name", "fingerprint", "last4", + "payment_reference", "routing_number" ], "title": "payment_method_details_us_bank_account", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "mandate" + ] }, "payment_method_details_wechat": { "description": "", @@ -33654,7 +38768,7 @@ "x-expandableFields": [] }, "payment_method_domain": { - "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", + "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", "properties": { "apple_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" @@ -33722,18 +38836,18 @@ "x-resourceId": "payment_method_domain", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/payment_method_domains/{payment_method_domain}" + "path": "/v1/payment_method_domains" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/payment_method_domains" + "path": "/v1/payment_method_domains/{payment_method_domain}" }, { "method_name": "create", @@ -33916,7 +39030,7 @@ "description": "", "properties": { "bank": { - "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", + "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", @@ -33926,6 +39040,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -33949,6 +39064,7 @@ "INGBNL2A", "KNABNL2H", "MOYONL21", + "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", @@ -34097,9 +39213,6 @@ "nullable": true } }, - "required": [ - "dob" - ], "title": "payment_method_klarna", "type": "object", "x-expandableFields": [ @@ -34135,6 +39248,20 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_mobilepay": { + "description": "", + "properties": {}, + "title": "payment_method_mobilepay", + "type": "object", + "x-expandableFields": [] + }, + "payment_method_multibanco": { + "description": "", + "properties": {}, + "title": "payment_method_multibanco", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_affirm": { "description": "", "properties": { @@ -34151,7 +39278,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34179,7 +39306,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34198,7 +39325,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -34210,20 +39337,26 @@ "type": "object", "x-expandableFields": [] }, - "payment_method_options_bacs_debit": { + "payment_method_options_amazon_pay": { "description": "", "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" + "off_session" ], "type": "string" } }, - "title": "payment_method_options_bacs_debit", + "title": "payment_method_options_amazon_pay", "type": "object", "x-expandableFields": [] }, @@ -34241,7 +39374,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -34264,7 +39397,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -34413,6 +39546,9 @@ "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "nullable": true, "type": "boolean" + }, + "routing": { + "$ref": "#/components/schemas/payment_method_options_card_present_routing" } }, "required": [ @@ -34421,7 +39557,33 @@ ], "title": "payment_method_options_card_present", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "routing" + ] + }, + "payment_method_options_card_present_routing": { + "description": "", + "properties": { + "requested_priority": { + "description": "Requested routing priority", + "enum": [ + "domestic", + "international" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "requested_priority" + ], + "title": "payment_method_options_card_present_routing", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Routing", + "in_package": "" + } }, "payment_method_options_cashapp": { "description": "", @@ -34434,7 +39596,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -34462,7 +39624,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34551,7 +39713,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34566,7 +39728,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34581,7 +39743,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34596,7 +39758,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -34632,7 +39794,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34674,7 +39836,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34691,6 +39853,21 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_options_multibanco": { + "description": "", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_multibanco", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_oxxo": { "description": "", "properties": { @@ -34699,7 +39876,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34717,7 +39894,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34732,7 +39909,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34766,7 +39943,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -34796,7 +39973,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34815,7 +39992,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34828,7 +40005,23 @@ }, "payment_method_options_revolut_pay": { "description": "", - "properties": {}, + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\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" + ], + "type": "string" + } + }, "title": "payment_method_options_revolut_pay", "type": "object", "x-expandableFields": [] @@ -34851,7 +40044,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -34866,6 +40059,21 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_options_twint": { + "description": "", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_twint", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_us_bank_account_mandate_options": { "description": "", "properties": { @@ -34903,7 +40111,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34922,7 +40130,7 @@ "description": "", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -34970,6 +40178,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "nullable": true, @@ -35110,6 +40319,20 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_swish": { + "description": "", + "properties": {}, + "title": "payment_method_swish", + "type": "object", + "x-expandableFields": [] + }, + "payment_method_twint": { + "description": "", + "properties": {}, + "title": "payment_method_twint", + "type": "object", + "x-expandableFields": [] + }, "payment_method_us_bank_account": { "description": "", "properties": { @@ -35332,6 +40555,15 @@ "description": "Indicates whether automatic tax is enabled for the session", "type": "boolean" }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true + }, "status": { "description": "The status of the most recent automated tax calculation for this session.", "enum": [ @@ -35345,11 +40577,14 @@ }, "required": [ "enabled", + "liability", "status" ], "title": "PaymentPagesCheckoutSessionAutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "payment_pages_checkout_session_consent": { "description": "", @@ -35507,6 +40742,12 @@ "payment_pages_checkout_session_custom_fields_dropdown": { "description": "", "properties": { + "default_value": { + "description": "The value that will pre-fill on the payment page.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { @@ -35522,6 +40763,7 @@ } }, "required": [ + "default_value", "options", "value" ], @@ -35563,6 +40805,12 @@ "payment_pages_checkout_session_custom_fields_numeric": { "description": "", "properties": { + "default_value": { + "description": "The value that will pre-fill the field on the payment page.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, @@ -35581,6 +40829,7 @@ } }, "required": [ + "default_value", "maximum_length", "minimum_length", "value" @@ -35622,6 +40871,12 @@ "payment_pages_checkout_session_custom_fields_text": { "description": "", "properties": { + "default_value": { + "description": "The value that will pre-fill the field on the payment page.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "nullable": true, @@ -35640,6 +40895,7 @@ } }, "required": [ + "default_value", "maximum_length", "minimum_length", "value" @@ -35856,6 +41112,15 @@ "nullable": true, "type": "string" }, + "issuer": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "nullable": true + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -35880,6 +41145,7 @@ "custom_fields", "description", "footer", + "issuer", "metadata", "rendering_options" ], @@ -35888,6 +41154,7 @@ "x-expandableFields": [ "account_tax_ids", "custom_fields", + "issuer", "rendering_options" ] }, @@ -35925,6 +41192,50 @@ "type": "object", "x-expandableFields": [] }, + "payment_pages_checkout_session_saved_payment_method_options": { + "description": "", + "properties": { + "allow_redisplay_filters": { + "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": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "payment_method_remove": { + "description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.", + "enum": [ + "disabled", + "enabled" + ], + "nullable": true, + "type": "string" + }, + "payment_method_save": { + "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.", + "enum": [ + "disabled", + "enabled" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "allow_redisplay_filters", + "payment_method_remove", + "payment_method_save" + ], + "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "payment_pages_checkout_session_shipping_address_collection": { "description": "", "properties": { @@ -36283,7 +41594,7 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -36291,6 +41602,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -36300,11 +41612,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -36314,6 +41628,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -36324,13 +41639,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -36519,6 +41838,31 @@ "description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.", "type": "integer" }, + "application_fee": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/application_fee" + } + ], + "description": "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/application_fee" + } + ] + } + }, + "application_fee_amount": { + "description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.", + "nullable": true, + "type": "integer" + }, "arrival_date": { "description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.", "format": "unix-time", @@ -36728,6 +42072,8 @@ }, "required": [ "amount", + "application_fee", + "application_fee_amount", "arrival_date", "automatic", "balance_transaction", @@ -36754,6 +42100,7 @@ "title": "Payout", "type": "object", "x-expandableFields": [ + "application_fee", "balance_transaction", "destination", "failure_balance_transaction", @@ -36763,18 +42110,18 @@ "x-resourceId": "payout", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/payouts/{payout}" + "path": "/v1/payouts" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/payouts" + "path": "/v1/payouts/{payout}" }, { "method_name": "create", @@ -36969,7 +42316,7 @@ "x-expandableFields": [] }, "person": { - "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps.\n\nRelated guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information)", + "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).", "properties": { "account": { "description": "The account the person is associated with.", @@ -37170,6 +42517,13 @@ ], "x-resourceId": "person", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/accounts/{account}/persons/{person}" + }, { "method_name": "list", "method_on": "collection", @@ -37218,13 +42572,6 @@ "method_type": "update", "operation": "post", "path": "/v1/accounts/{account}/persons/{person}" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/accounts/{account}/persons/{person}" } ], "x-stripeResource": { @@ -37316,7 +42663,13 @@ "description": "", "properties": { "account": { - "$ref": "#/components/schemas/person_additional_tos_acceptance" + "anyOf": [ + { + "$ref": "#/components/schemas/person_additional_tos_acceptance" + } + ], + "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", + "nullable": true } }, "required": [ @@ -37371,7 +42724,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -37490,7 +42843,7 @@ "type": "array" }, "pending_verification": { - "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", + "description": "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.", "items": { "maxLength": 5000, "type": "string" @@ -37591,6 +42944,12 @@ "nullable": true, "type": "object" }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, @@ -37682,6 +43041,7 @@ "interval_count", "livemode", "metadata", + "meter", "nickname", "object", "product", @@ -37700,17 +43060,17 @@ "x-resourceId": "plan", "x-stripeOperations": [ { - "method_name": "list", + "method_name": "delete", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/plans" + "method_type": "delete", + "operation": "delete", + "path": "/v1/plans/{plan}" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/plans" }, { @@ -37721,17 +43081,17 @@ "path": "/v1/plans/{plan}" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/plans/{plan}" + "path": "/v1/plans" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", + "method_type": "update", + "operation": "post", "path": "/v1/plans/{plan}" } ], @@ -37831,54 +43191,34 @@ "type": "object", "x-expandableFields": [] }, - "platform_tax_fee": { + "platform_earning_fee_source": { "description": "", "properties": { - "account": { - "description": "The Connected account that incurred this charge.", + "charge": { + "description": "Charge ID that created this application fee.", "maxLength": 5000, "type": "string" }, - "id": { - "description": "Unique identifier for the object.", + "payout": { + "description": "Payout ID that created this application fee.", "maxLength": 5000, "type": "string" }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value.", + "type": { + "description": "Type of object that created the application fee, either `charge` or `payout`.", "enum": [ - "platform_tax_fee" + "charge", + "payout" ], "type": "string" - }, - "source_transaction": { - "description": "The payment object that caused this tax to be inflicted.", - "maxLength": 5000, - "type": "string" - }, - "type": { - "description": "The type of tax (VAT).", - "maxLength": 5000, - "type": "string" } }, "required": [ - "account", - "id", - "object", - "source_transaction", "type" ], - "title": "PlatformTax", + "title": "PlatformEarningFeeSource", "type": "object", - "x-expandableFields": [], - "x-stripeResource": { - "class_name": "PlatformTaxFee", - "in_package": "", - "polymorphic_groups": [ - "balance_transaction_source" - ] - } + "x-expandableFields": [] }, "portal_business_profile": { "description": "", @@ -37957,9 +43297,6 @@ "subscription_cancel": { "$ref": "#/components/schemas/portal_subscription_cancel" }, - "subscription_pause": { - "$ref": "#/components/schemas/portal_subscription_pause" - }, "subscription_update": { "$ref": "#/components/schemas/portal_subscription_update" } @@ -37969,7 +43306,6 @@ "invoice_history", "payment_method_update", "subscription_cancel", - "subscription_pause", "subscription_update" ], "title": "PortalFeatures", @@ -37979,7 +43315,6 @@ "invoice_history", "payment_method_update", "subscription_cancel", - "subscription_pause", "subscription_update" ] }, @@ -38422,21 +43757,6 @@ "type": "object", "x-expandableFields": [] }, - "portal_subscription_pause": { - "description": "", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "required": [ - "enabled" - ], - "title": "PortalSubscriptionPause", - "type": "object", - "x-expandableFields": [] - }, "portal_subscription_update": { "description": "", "properties": { @@ -38465,7 +43785,7 @@ "type": "array" }, "proration_behavior": { - "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.", + "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.", "enum": [ "always_invoice", "create_prorations", @@ -38477,7 +43797,6 @@ "required": [ "default_allowed_updates", "enabled", - "products", "proration_behavior" ], "title": "PortalSubscriptionUpdate", @@ -38710,18 +44029,25 @@ "x-resourceId": "price", "x-stripeOperations": [ { - "method_name": "search", + "method_name": "list", "method_on": "service", - "method_type": "custom", + "method_type": "list", "operation": "get", - "path": "/v1/prices/search" + "path": "/v1/prices" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/prices" + "path": "/v1/prices/{price}" + }, + { + "method_name": "search", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/prices/search" }, { "method_name": "create", @@ -38730,13 +44056,6 @@ "operation": "post", "path": "/v1/prices" }, - { - "method_name": "retrieve", - "method_on": "service", - "method_type": "retrieve", - "operation": "get", - "path": "/v1/prices/{price}" - }, { "method_name": "update", "method_on": "service", @@ -38880,13 +44199,6 @@ "nullable": true, "type": "string" }, - "features": { - "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", - "items": { - "$ref": "#/components/schemas/product_feature" - }, - "type": "array" - }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -38904,6 +44216,13 @@ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, + "marketing_features": { + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "items": { + "$ref": "#/components/schemas/product_marketing_feature" + }, + "type": "array" + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -38939,7 +44258,7 @@ "type": "boolean" }, "statement_descriptor": { - "description": "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.", + "description": "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.", "maxLength": 5000, "nullable": true, "type": "string" @@ -38994,10 +44313,10 @@ "active", "created", "description", - "features", "id", "images", "livemode", + "marketing_features", "metadata", "name", "object", @@ -39012,24 +44331,24 @@ "type": "object", "x-expandableFields": [ "default_price", - "features", + "marketing_features", "package_dimensions", "tax_code" ], "x-resourceId": "product", "x-stripeOperations": [ { - "method_name": "search", + "method_name": "delete", "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/products/search" + "method_type": "delete", + "operation": "delete", + "path": "/v1/products/{id}" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/products" }, { @@ -39040,24 +44359,24 @@ "path": "/v1/products/{id}" }, { - "method_name": "update", + "method_name": "search", "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/products/{id}" + "method_type": "custom", + "operation": "get", + "path": "/v1/products/search" }, { - "method_name": "list", + "method_name": "create", "method_on": "service", - "method_type": "list", - "operation": "get", + "method_type": "create", + "operation": "post", "path": "/v1/products" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", + "method_type": "update", + "operation": "post", "path": "/v1/products/{id}" } ], @@ -39117,15 +44436,86 @@ } }, "product_feature": { + "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.", + "properties": { + "entitlement_feature": { + "$ref": "#/components/schemas/entitlements.feature" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "product_feature" + ], + "type": "string" + } + }, + "required": [ + "entitlement_feature", + "id", + "livemode", + "object" + ], + "title": "ProductFeature", + "type": "object", + "x-expandableFields": [ + "entitlement_feature" + ], + "x-resourceId": "product_feature", + "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/products/{product}/features/{id}" + }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/products/{product}/features" + }, + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/products/{product}/features/{id}" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/products/{product}/features" + } + ], + "x-stripeResource": { + "class_name": "ProductFeature", + "has_collection_class": true, + "in_package": "" + } + }, + "product_marketing_feature": { "description": "", "properties": { "name": { - "description": "The feature's name. Up to 80 characters long.", + "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, - "title": "ProductFeature", + "title": "ProductMarketingFeature", "type": "object", "x-expandableFields": [] }, @@ -39243,6 +44633,13 @@ ], "x-resourceId": "promotion_code", "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/promotion_codes" + }, { "method_name": "retrieve", "method_on": "service", @@ -39263,13 +44660,6 @@ "method_type": "update", "operation": "post", "path": "/v1/promotion_codes/{promotion_code}" - }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/promotion_codes" } ], "x-stripeResource": { @@ -39803,6 +45193,13 @@ ], "x-resourceId": "quote", "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/quotes" + }, { "method_name": "retrieve", "method_on": "service", @@ -39811,32 +45208,32 @@ "path": "/v1/quotes/{quote}" }, { - "method_name": "create", + "method_name": "list_computed_upfront_line_items", "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/quotes" + "method_type": "custom", + "operation": "get", + "path": "/v1/quotes/{quote}/computed_upfront_line_items" }, { - "method_name": "update", + "method_name": "list_line_items", "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/quotes/{quote}" + "method_type": "custom", + "operation": "get", + "path": "/v1/quotes/{quote}/line_items" }, { - "method_name": "cancel", + "method_name": "create", "method_on": "service", - "method_type": "custom", + "method_type": "create", "operation": "post", - "path": "/v1/quotes/{quote}/cancel" + "path": "/v1/quotes" }, { - "method_name": "finalize_quote", + "method_name": "update", "method_on": "service", - "method_type": "custom", + "method_type": "update", "operation": "post", - "path": "/v1/quotes/{quote}/finalize" + "path": "/v1/quotes/{quote}" }, { "method_name": "accept", @@ -39846,25 +45243,18 @@ "path": "/v1/quotes/{quote}/accept" }, { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/quotes" - }, - { - "method_name": "list_line_items", + "method_name": "cancel", "method_on": "service", "method_type": "custom", - "operation": "get", - "path": "/v1/quotes/{quote}/line_items" + "operation": "post", + "path": "/v1/quotes/{quote}/cancel" }, { - "method_name": "list_computed_upfront_line_items", + "method_name": "finalize_quote", "method_on": "service", "method_type": "custom", - "operation": "get", - "path": "/v1/quotes/{quote}/computed_upfront_line_items" + "operation": "post", + "path": "/v1/quotes/{quote}/finalize" }, { "method_name": "pdf", @@ -39951,6 +45341,15 @@ "description": "Automatically calculate taxes", "type": "boolean" }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true + }, "status": { "description": "The status of the most recent automated tax calculation for this quote.", "enum": [ @@ -39964,11 +45363,14 @@ }, "required": [ "enabled", + "liability", "status" ], "title": "QuotesResourceAutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "quotes_resource_computed": { "description": "", @@ -40581,6 +45983,13 @@ ], "x-resourceId": "radar.value_list", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/radar/value_lists/{value_list}" + }, { "method_name": "list", "method_on": "service", @@ -40608,13 +46017,6 @@ "method_type": "update", "operation": "post", "path": "/v1/radar/value_lists/{value_list}" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/radar/value_lists/{value_list}" } ], "x-stripeResource": { @@ -40677,6 +46079,13 @@ "x-expandableFields": [], "x-resourceId": "radar.value_list_item", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/radar/value_list_items/{item}" + }, { "method_name": "list", "method_on": "service", @@ -40697,13 +46106,6 @@ "method_type": "create", "operation": "post", "path": "/v1/radar/value_list_items" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/radar/value_list_items/{item}" } ], "x-stripeResource": { @@ -40862,6 +46264,12 @@ "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "nullable": true, @@ -40880,6 +46288,7 @@ "aggregate_usage", "interval", "interval_count", + "meter", "trial_period_days", "usage_type" ], @@ -41140,13 +46549,6 @@ "operation": "get", "path": "/v1/refunds" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/refunds" - }, { "method_name": "retrieve", "method_on": "service", @@ -41154,6 +46556,13 @@ "operation": "get", "path": "/v1/refunds/{refund}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/refunds" + }, { "method_name": "update", "method_on": "service", @@ -41229,6 +46638,9 @@ "alipay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, + "amazon_pay": { + "$ref": "#/components/schemas/destination_details_unimplemented" + }, "au_bank_transfer": { "$ref": "#/components/schemas/destination_details_unimplemented" }, @@ -41268,6 +46680,9 @@ "klarna": { "$ref": "#/components/schemas/destination_details_unimplemented" }, + "multibanco": { + "$ref": "#/components/schemas/refund_destination_details_generic" + }, "mx_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_generic" }, @@ -41289,6 +46704,9 @@ "sofort": { "$ref": "#/components/schemas/destination_details_unimplemented" }, + "swish": { + "$ref": "#/components/schemas/refund_destination_details_generic" + }, "th_bank_transfer": { "$ref": "#/components/schemas/refund_destination_details_generic" }, @@ -41316,6 +46734,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_bank_transfer", "blik", "br_bank_transfer", @@ -41329,6 +46748,7 @@ "grabpay", "jp_bank_transfer", "klarna", + "multibanco", "mx_bank_transfer", "p24", "paynow", @@ -41336,6 +46756,7 @@ "pix", "revolut", "sofort", + "swish", "th_bank_transfer", "us_bank_transfer", "wechat_pay", @@ -41530,6 +46951,13 @@ ], "x-resourceId": "reporting.report_run", "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/reporting/report_runs" + }, { "method_name": "retrieve", "method_on": "service", @@ -41543,13 +46971,6 @@ "method_type": "create", "operation": "post", "path": "/v1/reporting/report_runs" - }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/reporting/report_runs" } ], "x-stripeResource": { @@ -41660,18 +47081,18 @@ "x-resourceId": "reporting.report_type", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/reporting/report_types/{report_type}" + "path": "/v1/reporting/report_types" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/reporting/report_types" + "path": "/v1/reporting/report_types/{report_type}" } ], "x-stripeResource": { @@ -42092,14 +47513,26 @@ "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" + }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true } }, "required": [ - "enabled" + "enabled", + "liability" ], "title": "SchedulesPhaseAutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "secret_service_resource_scope": { "description": "", @@ -42396,6 +47829,9 @@ "acss_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_acss_debit" }, + "amazon_pay": { + "$ref": "#/components/schemas/setup_attempt_payment_method_details_amazon_pay" + }, "au_becs_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit" }, @@ -42429,6 +47865,9 @@ "paypal": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_paypal" }, + "revolut_pay": { + "$ref": "#/components/schemas/setup_attempt_payment_method_details_revolut_pay" + }, "sepa_debit": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_sepa_debit" }, @@ -42451,6 +47890,7 @@ "type": "object", "x-expandableFields": [ "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -42462,6 +47902,7 @@ "klarna", "link", "paypal", + "revolut_pay", "sepa_debit", "sofort", "us_bank_account" @@ -42474,6 +47915,13 @@ "type": "object", "x-expandableFields": [] }, + "setup_attempt_payment_method_details_amazon_pay": { + "description": "", + "properties": {}, + "title": "setup_attempt_payment_method_details_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, "setup_attempt_payment_method_details_au_becs_debit": { "description": "", "properties": {}, @@ -42773,15 +48221,26 @@ } ] } + }, + "offline": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_details_card_present_offline" + } + ], + "description": "Details about payments collected offline.", + "nullable": true } }, "required": [ - "generated_card" + "generated_card", + "offline" ], "title": "setup_attempt_payment_method_details_card_present", "type": "object", "x-expandableFields": [ - "generated_card" + "generated_card", + "offline" ], "x-stripeResource": { "class_name": "CardPresent", @@ -42828,7 +48287,7 @@ "description": "", "properties": { "bank": { - "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", + "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.", "enum": [ "abn_amro", "asn_bank", @@ -42838,6 +48297,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -42861,6 +48321,7 @@ "INGBNL2A", "KNABNL2H", "MOYONL21", + "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", @@ -42961,6 +48422,17 @@ "type": "object", "x-expandableFields": [] }, + "setup_attempt_payment_method_details_revolut_pay": { + "description": "", + "properties": {}, + "title": "setup_attempt_payment_method_details_revolut_pay", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "RevolutPay", + "in_package": "" + } + }, "setup_attempt_payment_method_details_sepa_debit": { "description": "", "properties": {}, @@ -43082,7 +48554,7 @@ } }, "setup_intent": { - "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)", + "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)", "properties": { "application": { "anyOf": [ @@ -43295,7 +48767,7 @@ "$ref": "#/components/schemas/payment_method" } ], - "description": "ID of the payment method used with this SetupIntent.", + "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.", "nullable": true, "x-expansionResources": { "oneOf": [ @@ -43413,13 +48885,6 @@ ], "x-resourceId": "setup_intent", "x-stripeOperations": [ - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/setup_intents" - }, { "method_name": "list", "method_on": "service", @@ -43434,6 +48899,13 @@ "operation": "get", "path": "/v1/setup_intents/{intent}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/setup_intents" + }, { "method_name": "update", "method_on": "service", @@ -43442,18 +48914,18 @@ "path": "/v1/setup_intents/{intent}" }, { - "method_name": "confirm", + "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/setup_intents/{intent}/confirm" + "path": "/v1/setup_intents/{intent}/cancel" }, { - "method_name": "cancel", + "method_name": "confirm", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/setup_intents/{intent}/cancel" + "path": "/v1/setup_intents/{intent}/confirm" }, { "method_name": "verify_microdeposits", @@ -43648,9 +49120,18 @@ "acss_debit": { "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit" }, + "amazon_pay": { + "$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay" + }, + "bacs_debit": { + "$ref": "#/components/schemas/setup_intent_payment_method_options_bacs_debit" + }, "card": { "$ref": "#/components/schemas/setup_intent_payment_method_options_card" }, + "card_present": { + "$ref": "#/components/schemas/setup_intent_payment_method_options_card_present" + }, "link": { "$ref": "#/components/schemas/setup_intent_payment_method_options_link" }, @@ -43668,7 +49149,10 @@ "type": "object", "x-expandableFields": [ "acss_debit", + "amazon_pay", + "bacs_debit", "card", + "card_present", "link", "paypal", "sepa_debit", @@ -43710,6 +49194,26 @@ "mandate_options" ] }, + "setup_intent_payment_method_options_amazon_pay": { + "description": "", + "properties": {}, + "title": "setup_intent_payment_method_options_amazon_pay", + "type": "object", + "x-expandableFields": [] + }, + "setup_intent_payment_method_options_bacs_debit": { + "description": "", + "properties": { + "mandate_options": { + "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit" + } + }, + "title": "setup_intent_payment_method_options_bacs_debit", + "type": "object", + "x-expandableFields": [ + "mandate_options" + ] + }, "setup_intent_payment_method_options_card": { "description": "", "properties": { @@ -43730,6 +49234,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -43741,7 +49246,7 @@ "type": "string" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -43852,6 +49357,13 @@ "in_package": "" } }, + "setup_intent_payment_method_options_card_present": { + "description": "", + "properties": {}, + "title": "setup_intent_payment_method_options_card_present", + "type": "object", + "x-expandableFields": [] + }, "setup_intent_payment_method_options_link": { "description": "", "properties": { @@ -43923,6 +49435,17 @@ "type": "object", "x-expandableFields": [] }, + "setup_intent_payment_method_options_mandate_options_bacs_debit": { + "description": "", + "properties": {}, + "title": "setup_intent_payment_method_options_mandate_options_bacs_debit", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "BacsDebitMandateOptions", + "in_package": "" + } + }, "setup_intent_payment_method_options_mandate_options_sepa_debit": { "description": "", "properties": {}, @@ -44134,7 +49657,7 @@ } }, "type": { - "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.", + "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], @@ -44565,6 +50088,13 @@ "operation": "get", "path": "/v1/sources/{source}" }, + { + "method_name": "source_transactions", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/sources/{source}/source_transactions" + }, { "method_name": "create", "method_on": "service", @@ -44585,13 +50115,6 @@ "method_type": "custom", "operation": "post", "path": "/v1/sources/{source}/verify" - }, - { - "method_name": "source_transactions", - "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/sources/{source}/source_transactions" } ], "x-stripeResource": { @@ -46225,7 +51748,7 @@ "type": "integer" }, "cancel_at_period_end": { - "description": "If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.", + "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.", "type": "boolean" }, "canceled_at": { @@ -46360,9 +51883,31 @@ "$ref": "#/components/schemas/discount" } ], - "description": "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.", + "description": "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "nullable": true }, + "discounts": { + "description": "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/discount" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/discount" + } + ] + } + }, + "type": "array" + }, "ended_at": { "description": "If the subscription has ended, the date the subscription ended.", "format": "unix-time", @@ -46374,6 +51919,9 @@ "maxLength": 5000, "type": "string" }, + "invoice_settings": { + "$ref": "#/components/schemas/subscriptions_resource_subscription_invoice_settings" + }, "items": { "description": "List of subscription items, each with an attached price.", "properties": { @@ -46484,7 +52032,7 @@ "$ref": "#/components/schemas/subscriptions_resource_pause_collection" } ], - "description": "If specified, payment collection for this subscription will be paused.", + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment).", "nullable": true }, "payment_settings": { @@ -46560,7 +52108,7 @@ "type": "integer" }, "status": { - "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.", + "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.", "enum": [ "active", "canceled", @@ -46629,6 +52177,7 @@ "application_fee_percent", "automatic_tax", "billing_cycle_anchor", + "billing_cycle_anchor_config", "billing_thresholds", "cancel_at", "cancel_at_period_end", @@ -46645,8 +52194,10 @@ "default_source", "description", "discount", + "discounts", "ended_at", "id", + "invoice_settings", "items", "latest_invoice", "livemode", @@ -46681,6 +52232,8 @@ "default_source", "default_tax_rates", "discount", + "discounts", + "invoice_settings", "items", "latest_invoice", "on_behalf_of", @@ -46697,33 +52250,26 @@ "x-resourceId": "subscription", "x-stripeOperations": [ { - "method_name": "search", + "method_name": "cancel", "method_on": "service", "method_type": "custom", - "operation": "get", - "path": "/v1/subscriptions/search" + "operation": "delete", + "path": "/v1/subscriptions/{subscription_exposed_id}" }, { - "method_name": "list", + "method_name": "delete_discount", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/subscriptions" + "method_type": "custom", + "operation": "delete", + "path": "/v1/subscriptions/{subscription_exposed_id}/discount" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/subscriptions" }, - { - "method_name": "update", - "method_on": "service", - "method_type": "update", - "operation": "post", - "path": "/v1/subscriptions/{subscription_exposed_id}" - }, { "method_name": "retrieve", "method_on": "service", @@ -46732,11 +52278,18 @@ "path": "/v1/subscriptions/{subscription_exposed_id}" }, { - "method_name": "cancel", + "method_name": "search", "method_on": "service", "method_type": "custom", - "operation": "delete", - "path": "/v1/subscriptions/{subscription_exposed_id}" + "operation": "get", + "path": "/v1/subscriptions/search" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/subscriptions" }, { "method_name": "resume", @@ -46746,11 +52299,11 @@ "path": "/v1/subscriptions/{subscription}/resume" }, { - "method_name": "delete_discount", + "method_name": "update", "method_on": "service", - "method_type": "custom", - "operation": "delete", - "path": "/v1/subscriptions/{subscription_exposed_id}/discount" + "method_type": "update", + "operation": "post", + "path": "/v1/subscriptions/{subscription_exposed_id}" } ], "x-stripeResource": { @@ -46766,14 +52319,26 @@ "enabled": { "description": "Whether Stripe automatically computes tax on this subscription.", "type": "boolean" + }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true } }, "required": [ - "enabled" + "enabled", + "liability" ], "title": "SubscriptionAutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "subscription_billing_thresholds": { "description": "", @@ -46805,7 +52370,7 @@ "maxLength": 500, "type": "string" }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will reflect the metadata of the subscription at the time of invoice creation. *Note: This attribute is populated only for invoices created on or after June 29, 2023.*", + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*", "nullable": true, "type": "object" } @@ -46833,6 +52398,28 @@ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": "integer" }, + "discounts": { + "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/discount" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/discount" + } + ] + } + }, + "type": "array" + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -46880,6 +52467,7 @@ "required": [ "billing_thresholds", "created", + "discounts", "id", "metadata", "object", @@ -46892,12 +52480,20 @@ "type": "object", "x-expandableFields": [ "billing_thresholds", + "discounts", "plan", "price", "tax_rates" ], "x-resourceId": "subscription_item", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/subscription_items/{item}" + }, { "method_name": "list", "method_on": "service", @@ -46912,6 +52508,13 @@ "operation": "get", "path": "/v1/subscription_items/{item}" }, + { + "method_name": "usage_record_summaries", + "method_on": "service", + "method_type": "custom", + "operation": "get", + "path": "/v1/subscription_items/{subscription_item}/usage_record_summaries" + }, { "method_name": "create", "method_on": "service", @@ -46925,20 +52528,6 @@ "method_type": "update", "operation": "post", "path": "/v1/subscription_items/{item}" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/subscription_items/{item}" - }, - { - "method_name": "usage_record_summaries", - "method_on": "service", - "method_type": "custom", - "operation": "get", - "path": "/v1/subscription_items/{subscription_item}/usage_record_summaries" } ], "x-stripeResource": { @@ -46977,6 +52566,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -46988,10 +52578,11 @@ "type": "string" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", - "automatic" + "automatic", + "challenge" ], "nullable": true, "type": "string" @@ -47262,13 +52853,6 @@ "operation": "get", "path": "/v1/subscription_schedules" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/subscription_schedules" - }, { "method_name": "retrieve", "method_on": "service", @@ -47276,6 +52860,13 @@ "operation": "get", "path": "/v1/subscription_schedules/{schedule}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/subscription_schedules" + }, { "method_name": "update", "method_on": "service", @@ -47419,6 +53010,13 @@ "subscription_schedule_add_invoice_item": { "description": "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.", "properties": { + "discounts": { + "description": "The stackable discounts that will be applied to the item.", + "items": { + "$ref": "#/components/schemas/discounts_resource_stackable_discount" + }, + "type": "array" + }, "price": { "anyOf": [ { @@ -47459,12 +53057,14 @@ } }, "required": [ + "discounts", "price", "quantity" ], "title": "SubscriptionScheduleAddInvoiceItem", "type": "object", "x-expandableFields": [ + "discounts", "price", "tax_rates" ] @@ -47481,6 +53081,13 @@ "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period", "nullable": true }, + "discounts": { + "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.", + "items": { + "$ref": "#/components/schemas/discounts_resource_stackable_discount" + }, + "type": "array" + }, "metadata": { "additionalProperties": { "maxLength": 500, @@ -47555,6 +53162,7 @@ }, "required": [ "billing_thresholds", + "discounts", "metadata", "plan", "price" @@ -47563,6 +53171,7 @@ "type": "object", "x-expandableFields": [ "billing_thresholds", + "discounts", "plan", "price", "tax_rates" @@ -47699,6 +53308,13 @@ "nullable": true, "type": "string" }, + "discounts": { + "description": "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.", + "items": { + "$ref": "#/components/schemas/discounts_resource_stackable_discount" + }, + "type": "array" + }, "end_date": { "description": "The end of this phase of the subscription schedule.", "format": "unix-time", @@ -47789,6 +53405,7 @@ "currency", "default_payment_method", "description", + "discounts", "end_date", "invoice_settings", "items", @@ -47808,6 +53425,7 @@ "coupon", "default_payment_method", "default_tax_rates", + "discounts", "invoice_settings", "items", "on_behalf_of", @@ -47938,14 +53556,26 @@ "enabled": { "description": "Whether Stripe automatically computes tax on invoices created during this phase.", "type": "boolean" + }, + "liability": { + "anyOf": [ + { + "$ref": "#/components/schemas/connect_account_reference" + } + ], + "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.", + "nullable": true } }, "required": [ - "enabled" + "enabled", + "liability" ], "title": "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "liability" + ] }, "subscription_transfer_data": { "description": "", @@ -48099,6 +53729,15 @@ "description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.", "nullable": true }, + "sepa_debit": { + "anyOf": [ + { + "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit" + } + ], + "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.", + "nullable": true + }, "us_bank_account": { "anyOf": [ { @@ -48115,6 +53754,7 @@ "card", "customer_balance", "konbini", + "sepa_debit", "us_bank_account" ], "title": "SubscriptionsResourcePaymentMethodOptions", @@ -48125,6 +53765,7 @@ "card", "customer_balance", "konbini", + "sepa_debit", "us_bank_account" ] }, @@ -48147,6 +53788,7 @@ "ach_credit_transfer", "ach_debit", "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -48161,13 +53803,16 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", "promptpay", + "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", + "swish", "us_bank_account", "wechat_pay" ], @@ -48178,7 +53823,7 @@ "type": "array" }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.", "enum": [ "off", "on_subscription" @@ -48245,6 +53890,53 @@ "subscription_items" ] }, + "subscriptions_resource_subscription_invoice_settings": { + "description": "", + "properties": { + "account_tax_ids": { + "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.", + "items": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/tax_id" + }, + { + "$ref": "#/components/schemas/deleted_tax_id" + } + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/tax_id" + }, + { + "$ref": "#/components/schemas/deleted_tax_id" + } + ] + } + }, + "nullable": true, + "type": "array" + }, + "issuer": { + "$ref": "#/components/schemas/connect_account_reference" + } + }, + "required": [ + "account_tax_ids", + "issuer" + ], + "title": "SubscriptionsResourceSubscriptionInvoiceSettings", + "type": "object", + "x-expandableFields": [ + "account_tax_ids", + "issuer" + ] + }, "subscriptions_trials_resource_end_behavior": { "description": "Defines how a subscription behaves when a free trial ends.", "properties": { @@ -48285,7 +53977,7 @@ "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)", "properties": { "amount_total": { - "description": "Total after taxes.", + "description": "Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -48366,6 +54058,15 @@ ], "type": "string" }, + "ship_from_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_product_resource_ship_from_details" + } + ], + "description": "The details of the ship from location, such as the address.", + "nullable": true + }, "shipping_cost": { "anyOf": [ { @@ -48403,9 +54104,9 @@ "customer_details", "expires_at", "id", - "line_items", "livemode", "object", + "ship_from_details", "shipping_cost", "tax_amount_exclusive", "tax_amount_inclusive", @@ -48417,17 +54118,18 @@ "x-expandableFields": [ "customer_details", "line_items", + "ship_from_details", "shipping_cost", "tax_breakdown" ], "x-resourceId": "tax.calculation", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "retrieve", "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/tax/calculations" + "method_type": "retrieve", + "operation": "get", + "path": "/v1/tax/calculations/{calculation}" }, { "method_name": "list_line_items", @@ -48435,6 +54137,13 @@ "method_type": "custom", "operation": "get", "path": "/v1/tax/calculations/{calculation}/line_items" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/tax/calculations" } ], "x-stripeResource": { @@ -48446,11 +54155,11 @@ "description": "", "properties": { "amount": { - "description": "The line item amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", + "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { - "description": "The amount of tax calculated for this line item, in integer cents.", + "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "id": { @@ -48517,7 +54226,6 @@ "quantity", "reference", "tax_behavior", - "tax_breakdown", "tax_code" ], "title": "TaxProductResourceTaxCalculationLineItem", @@ -48610,13 +54318,6 @@ "operation": "get", "path": "/v1/tax/registrations" }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/tax/registrations" - }, { "method_name": "retrieve", "method_on": "service", @@ -48624,6 +54325,13 @@ "operation": "get", "path": "/v1/tax/registrations/{id}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/tax/registrations" + }, { "method_name": "update", "method_on": "service", @@ -48817,6 +54525,11 @@ ], "type": "string" }, + "posted_at": { + "description": "The Unix timestamp representing when the tax liability is assumed or reduced.", + "format": "unix-time", + "type": "integer" + }, "reference": { "description": "A custom unique identifier, such as 'myOrder_123'.", "maxLength": 5000, @@ -48831,6 +54544,15 @@ "description": "If `type=reversal`, contains information about what was reversed.", "nullable": true }, + "ship_from_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_product_resource_ship_from_details" + } + ], + "description": "The details of the ship from location, such as the address.", + "nullable": true + }, "shipping_cost": { "anyOf": [ { @@ -48860,12 +54582,13 @@ "customer", "customer_details", "id", - "line_items", "livemode", "metadata", "object", + "posted_at", "reference", "reversal", + "ship_from_details", "shipping_cost", "tax_date", "type" @@ -48876,6 +54599,7 @@ "customer_details", "line_items", "reversal", + "ship_from_details", "shipping_cost" ], "x-resourceId": "tax.transaction", @@ -48888,11 +54612,11 @@ "path": "/v1/tax/transactions/{transaction}" }, { - "method_name": "create_reversal", + "method_name": "list_line_items", "method_on": "service", "method_type": "custom", - "operation": "post", - "path": "/v1/tax/transactions/create_reversal" + "operation": "get", + "path": "/v1/tax/transactions/{transaction}/line_items" }, { "method_name": "create_from_calculation", @@ -48902,11 +54626,11 @@ "path": "/v1/tax/transactions/create_from_calculation" }, { - "method_name": "list_line_items", + "method_name": "create_reversal", "method_on": "service", "method_type": "custom", - "operation": "get", - "path": "/v1/tax/transactions/{transaction}/line_items" + "operation": "post", + "path": "/v1/tax/transactions/create_reversal" } ], "x-stripeResource": { @@ -48918,11 +54642,11 @@ "description": "", "properties": { "amount": { - "description": "The line item amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", + "description": "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { - "description": "The amount of tax calculated for this line item, in integer cents.", + "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "id": { @@ -49130,6 +54854,88 @@ ] } }, + "tax_i_ds_owner": { + "description": "", + "properties": { + "account": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/account" + } + ], + "description": "The account being referenced when `type` is `account`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/account" + } + ] + } + }, + "application": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/application" + } + ], + "description": "The Connect Application being referenced when `type` is `application`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/application" + } + ] + } + }, + "customer": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/customer" + } + ], + "description": "The customer being referenced when `type` is `customer`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/customer" + } + ] + } + }, + "type": { + "description": "Type of owner referenced.", + "enum": [ + "account", + "application", + "customer", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxIDsOwner", + "type": "object", + "x-expandableFields": [ + "account", + "application", + "customer" + ] + }, "tax_id": { "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)", "properties": { @@ -49180,8 +54986,17 @@ ], "type": "string" }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_i_ds_owner" + } + ], + "description": "The account or customer the tax ID belongs to.", + "nullable": true + }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -49189,6 +55004,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -49198,11 +55014,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -49212,6 +55030,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -49222,13 +55041,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -49275,6 +55098,7 @@ "id", "livemode", "object", + "owner", "type", "value", "verification" @@ -49283,22 +55107,37 @@ "type": "object", "x-expandableFields": [ "customer", + "owner", "verification" ], "x-resourceId": "tax_id", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/customers/{customer}/tax_ids/{id}" + }, + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/tax_ids/{id}" + }, + { + "method_name": "list", "method_on": "collection", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/customers/{customer}/tax_ids" }, { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/customers/{customer}/tax_ids" }, { @@ -49317,24 +55156,40 @@ }, { "method_name": "list", - "method_on": "collection", + "method_on": "service", "method_type": "list", "operation": "get", - "path": "/v1/customers/{customer}/tax_ids" + "path": "/v1/tax_ids" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/customers/{customer}/tax_ids" + "path": "/v1/tax_ids/{id}" }, { - "method_name": "delete", + "method_name": "create", + "method_on": "collection", + "method_type": "create", + "operation": "post", + "path": "/v1/customers/{customer}/tax_ids", + "shared_version_of": "tax_id" + }, + { + "method_name": "create", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/customers/{customer}/tax_ids/{id}" + "method_type": "create", + "operation": "post", + "path": "/v1/customers/{customer}/tax_ids", + "shared_version_of": "tax_id" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/tax_ids" } ], "x-stripeResource": { @@ -49396,6 +55251,9 @@ "bg": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, + "bh": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, "ca": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada" }, @@ -49423,6 +55281,9 @@ "ee": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, + "eg": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "es": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -49435,6 +55296,9 @@ "gb": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, + "ge": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "gr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -49459,9 +55323,15 @@ "jp": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, + "ke": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "kr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, + "kz": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "lt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -49480,6 +55350,9 @@ "my": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, + "ng": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "nl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -49489,6 +55362,9 @@ "nz": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, + "om": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, "pl": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -49537,6 +55413,7 @@ "au", "be", "bg", + "bh", "ca", "ch", "cl", @@ -49546,10 +55423,12 @@ "de", "dk", "ee", + "eg", "es", "fi", "fr", "gb", + "ge", "gr", "hr", "hu", @@ -49558,16 +55437,20 @@ "is", "it", "jp", + "ke", "kr", + "kz", "lt", "lu", "lv", "mt", "mx", "my", + "ng", "nl", "no", "nz", + "om", "pl", "pt", "ro", @@ -49727,7 +55610,8 @@ "state_communications_tax", "state_sales_tax" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -49835,7 +55719,7 @@ "description": "", "properties": { "type": { - "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, or `unknown`", + "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -49843,6 +55727,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -49852,11 +55737,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -49866,6 +55753,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -49876,13 +55764,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -49966,7 +55858,7 @@ "description": "", "properties": { "amount": { - "description": "The amount of tax, in integer cents.", + "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "jurisdiction": { @@ -50011,7 +55903,7 @@ "type": "string" }, "taxable_amount": { - "description": "The amount on which tax is calculated, in integer cents.", + "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, @@ -50059,7 +55951,8 @@ "sales_tax", "vat" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -50122,11 +56015,27 @@ "type": "object", "x-expandableFields": [] }, + "tax_product_resource_ship_from_details": { + "description": "", + "properties": { + "address": { + "$ref": "#/components/schemas/tax_product_resource_postal_address" + } + }, + "required": [ + "address" + ], + "title": "TaxProductResourceShipFromDetails", + "type": "object", + "x-expandableFields": [ + "address" + ] + }, "tax_product_resource_tax_breakdown": { "description": "", "properties": { "amount": { - "description": "The amount of tax, in integer cents.", + "description": "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "inclusive": { @@ -50158,7 +56067,7 @@ "type": "string" }, "taxable_amount": { - "description": "The amount on which tax is calculated, in integer cents.", + "description": "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" } }, @@ -50179,11 +56088,11 @@ "description": "", "properties": { "amount": { - "description": "The shipping amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", + "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { - "description": "The amount of tax calculated for shipping, in integer cents.", + "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "shipping_rate": { @@ -50261,7 +56170,8 @@ "vat" ], "nullable": true, - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -50399,11 +56309,11 @@ "description": "", "properties": { "amount": { - "description": "The shipping amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", + "description": "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.", "type": "integer" }, "amount_tax": { - "description": "The amount of tax calculated for shipping, in integer cents.", + "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", "type": "integer" }, "shipping_rate": { @@ -50493,6 +56403,19 @@ "nullable": true, "type": "string" }, + "jurisdiction_level": { + "description": "The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.", + "enum": [ + "city", + "country", + "county", + "district", + "multiple", + "state" + ], + "nullable": true, + "type": "string" + }, "livemode": { "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" @@ -50537,11 +56460,11 @@ "qst", "rst", "sales_tax", - "service_tax", "vat" ], "nullable": true, - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -50554,6 +56477,7 @@ "id", "inclusive", "jurisdiction", + "jurisdiction_level", "livemode", "metadata", "object", @@ -50653,6 +56577,12 @@ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, + "name": { + "description": "String indicating the name of the Configuration object, set by the user", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ @@ -50663,6 +56593,12 @@ "offline": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config" }, + "reboot_window": { + "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reboot_window" + }, + "stripe_s700": { + "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config" + }, "tipping": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping" }, @@ -50674,6 +56610,7 @@ "id", "is_account_default", "livemode", + "name", "object" ], "title": "TerminalConfigurationConfiguration", @@ -50681,17 +56618,19 @@ "x-expandableFields": [ "bbpos_wisepos_e", "offline", + "reboot_window", + "stripe_s700", "tipping", "verifone_p400" ], "x-resourceId": "terminal.configuration", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "delete", "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/terminal/configurations" + "method_type": "delete", + "operation": "delete", + "path": "/v1/terminal/configurations/{configuration}" }, { "method_name": "list", @@ -50708,17 +56647,17 @@ "path": "/v1/terminal/configurations/{configuration}" }, { - "method_name": "update", + "method_name": "create", "method_on": "service", - "method_type": "update", + "method_type": "create", "operation": "post", - "path": "/v1/terminal/configurations/{configuration}" + "path": "/v1/terminal/configurations" }, { - "method_name": "delete", + "method_name": "update", "method_on": "service", - "method_type": "delete", - "operation": "delete", + "method_type": "update", + "operation": "post", "path": "/v1/terminal/configurations/{configuration}" } ], @@ -50732,7 +56671,7 @@ "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)", "properties": { "location": { - "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens).", + "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).", "maxLength": 5000, "type": "string" }, @@ -50827,6 +56766,20 @@ ], "x-resourceId": "terminal.location", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/terminal/locations/{location}" + }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/terminal/locations" + }, { "method_name": "retrieve", "method_on": "service", @@ -50847,20 +56800,6 @@ "method_type": "update", "operation": "post", "path": "/v1/terminal/locations/{location}" - }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/terminal/locations" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/terminal/locations/{location}" } ], "x-stripeResource": { @@ -50888,13 +56827,15 @@ "type": "string" }, "device_type": { - "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.", + "description": "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.", "enum": [ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", + "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", + "stripe_s700", "verifone_P400" ], "type": "string" @@ -50960,8 +56901,11 @@ "type": "string" }, "status": { - "description": "The networking status of the reader.", - "maxLength": 5000, + "description": "The networking status of the reader. We do not recommend using this field in flows that may block taking payments.", + "enum": [ + "offline", + "online" + ], "nullable": true, "type": "string" } @@ -50989,12 +56933,19 @@ "x-resourceId": "terminal.reader", "x-stripeOperations": [ { - "method_name": "update", + "method_name": "delete", "method_on": "service", - "method_type": "update", - "operation": "post", + "method_type": "delete", + "operation": "delete", "path": "/v1/terminal/readers/{reader}" }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/terminal/readers" + }, { "method_name": "retrieve", "method_on": "service", @@ -51010,18 +56961,18 @@ "path": "/v1/terminal/readers" }, { - "method_name": "list", + "method_name": "update", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/terminal/readers" + "method_type": "update", + "operation": "post", + "path": "/v1/terminal/readers/{reader}" }, { - "method_name": "delete", + "method_name": "cancel_action", "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/terminal/readers/{reader}" + "method_type": "custom", + "operation": "post", + "path": "/v1/terminal/readers/{reader}/cancel_action" }, { "method_name": "process_payment_intent", @@ -51038,11 +56989,11 @@ "path": "/v1/terminal/readers/{reader}/process_setup_intent" }, { - "method_name": "cancel_action", + "method_name": "refund_payment", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/terminal/readers/{reader}/cancel_action" + "path": "/v1/terminal/readers/{reader}/refund_payment" }, { "method_name": "set_reader_display", @@ -51051,13 +57002,6 @@ "operation": "post", "path": "/v1/terminal/readers/{reader}/set_reader_display" }, - { - "method_name": "refund_payment", - "method_on": "service", - "method_type": "custom", - "operation": "post", - "path": "/v1/terminal/readers/{reader}/refund_payment" - }, { "method_name": "present_payment_method", "method_on": "service", @@ -51177,6 +57121,26 @@ "type": "object", "x-expandableFields": [] }, + "terminal_configuration_configuration_resource_reboot_window": { + "description": "", + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "TerminalConfigurationConfigurationResourceRebootWindow", + "type": "object", + "x-expandableFields": [] + }, "terminal_configuration_configuration_resource_tipping": { "description": "", "properties": { @@ -51307,6 +57271,10 @@ "terminal_reader_reader_resource_process_config": { "description": "Represents a per-transaction override of a reader configuration", "properties": { + "enable_customer_cancellation": { + "description": "Enable customer initiated cancellation when processing this payment.", + "type": "boolean" + }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" @@ -51359,7 +57327,12 @@ }, "terminal_reader_reader_resource_process_setup_config": { "description": "Represents a per-setup override of a reader configuration", - "properties": {}, + "properties": { + "enable_customer_cancellation": { + "description": "Enable customer initiated cancellation when processing this SetupIntent.", + "type": "boolean" + } + }, "title": "TerminalReaderReaderResourceProcessSetupConfig", "type": "object", "x-expandableFields": [] @@ -51553,6 +57526,9 @@ "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", "type": "boolean" }, + "refund_payment_config": { + "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_config" + }, "reverse_transfer": { "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", "type": "boolean" @@ -51563,9 +57539,22 @@ "x-expandableFields": [ "charge", "payment_intent", - "refund" + "refund", + "refund_payment_config" ] }, + "terminal_reader_reader_resource_refund_payment_config": { + "description": "Represents a per-transaction override of a reader configuration", + "properties": { + "enable_customer_cancellation": { + "description": "Enable customer initiated cancellation when refunding this payment.", + "type": "boolean" + } + }, + "title": "TerminalReaderReaderResourceRefundPaymentConfig", + "type": "object", + "x-expandableFields": [] + }, "terminal_reader_reader_resource_set_reader_display_action": { "description": "Represents a reader action to set the reader display", "properties": { @@ -51673,6 +57662,20 @@ "x-expandableFields": [], "x-resourceId": "test_helpers.test_clock", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/test_helpers/test_clocks/{test_clock}" + }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/test_helpers/test_clocks" + }, { "method_name": "retrieve", "method_on": "service", @@ -51687,26 +57690,12 @@ "operation": "post", "path": "/v1/test_helpers/test_clocks" }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/test_helpers/test_clocks/{test_clock}" - }, { "method_name": "advance", "method_on": "service", "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/test_clocks/{test_clock}/advance" - }, - { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/test_helpers/test_clocks" } ], "x-stripeResource": { @@ -51988,8 +57977,87 @@ "type": "object", "x-expandableFields": [] }, + "thresholds_resource_alert_filter": { + "description": "", + "properties": { + "customer": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/customer" + } + ], + "description": "Limit the scope of the alert to this customer ID", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/customer" + } + ] + } + } + }, + "required": [ + "customer" + ], + "title": "ThresholdsResourceAlertFilter", + "type": "object", + "x-expandableFields": [ + "customer" + ] + }, + "thresholds_resource_usage_threshold_config": { + "description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.", + "properties": { + "gte": { + "description": "The value at which this alert will trigger.", + "type": "integer" + }, + "meter": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/billing.meter" + } + ], + "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/billing.meter" + } + ] + } + }, + "recurrence": { + "description": "Defines how the alert will behave.", + "enum": [ + "one_time" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "gte", + "meter", + "recurrence" + ], + "title": "ThresholdsResourceUsageThresholdConfig", + "type": "object", + "x-expandableFields": [ + "meter" + ] + }, "token": { - "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [Custom accounts](https://stripe.com/docs/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.", + "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.", "properties": { "bank_account": { "$ref": "#/components/schemas/bank_account" @@ -52071,6 +58139,23 @@ "in_package": "" } }, + "token_card_networks": { + "description": "", + "properties": { + "preferred": { + "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "preferred" + ], + "title": "token_card_networks", + "type": "object", + "x-expandableFields": [] + }, "topup": { "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)", "properties": { @@ -52214,13 +58299,6 @@ ], "x-resourceId": "topup", "x-stripeOperations": [ - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/topups" - }, { "method_name": "list", "method_on": "service", @@ -52235,6 +58313,13 @@ "operation": "get", "path": "/v1/topups/{topup}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/topups" + }, { "method_name": "update", "method_on": "service", @@ -52551,13 +58636,6 @@ ], "x-resourceId": "transfer", "x-stripeOperations": [ - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/transfers" - }, { "method_name": "list", "method_on": "service", @@ -52572,6 +58650,13 @@ "operation": "get", "path": "/v1/transfers/{transfer}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/transfers" + }, { "method_name": "update", "method_on": "service", @@ -52674,7 +58759,7 @@ ] }, "transfer_reversal": { - "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers)", + "description": "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)", "properties": { "amount": { "description": "Amount, in cents (or local equivalent).", @@ -52812,20 +58897,6 @@ ], "x-resourceId": "transfer_reversal", "x-stripeOperations": [ - { - "method_name": "create", - "method_on": "collection", - "method_type": "create", - "operation": "post", - "path": "/v1/transfers/{id}/reversals" - }, - { - "method_name": "create", - "method_on": "service", - "method_type": "create", - "operation": "post", - "path": "/v1/transfers/{id}/reversals" - }, { "method_name": "list", "method_on": "collection", @@ -52854,6 +58925,20 @@ "operation": "get", "path": "/v1/transfers/{transfer}/reversals/{id}" }, + { + "method_name": "create", + "method_on": "collection", + "method_type": "create", + "operation": "post", + "path": "/v1/transfers/{id}/reversals" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/transfers/{id}/reversals" + }, { "method_name": "update", "method_on": "service", @@ -53264,10 +59349,10 @@ "x-resourceId": "treasury.debit_reversal", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/treasury/debit_reversals" }, { @@ -53278,10 +59363,10 @@ "path": "/v1/treasury/debit_reversals/{debit_reversal}" }, { - "method_name": "list", + "method_name": "create", "method_on": "service", - "method_type": "list", - "operation": "get", + "method_type": "create", + "operation": "post", "path": "/v1/treasury/debit_reversals" } ], @@ -53349,6 +59434,7 @@ "card_issuing", "deposit_insurance", "financial_addresses.aba", + "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", @@ -53417,6 +59503,7 @@ "card_issuing", "deposit_insurance", "financial_addresses.aba", + "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", @@ -53446,6 +59533,7 @@ "card_issuing", "deposit_insurance", "financial_addresses.aba", + "financial_addresses.aba.forwarding", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", @@ -53504,45 +59592,45 @@ "x-resourceId": "treasury.financial_account", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/treasury/financial_accounts" }, { - "method_name": "update", + "method_name": "retrieve", "method_on": "service", - "method_type": "update", - "operation": "post", + "method_type": "retrieve", + "operation": "get", "path": "/v1/treasury/financial_accounts/{financial_account}" }, { - "method_name": "update_features", + "method_name": "retrieve_features", "method_on": "service", "method_type": "custom", - "operation": "post", + "operation": "get", "path": "/v1/treasury/financial_accounts/{financial_account}/features" }, { - "method_name": "list", + "method_name": "create", "method_on": "service", - "method_type": "list", - "operation": "get", + "method_type": "create", + "operation": "post", "path": "/v1/treasury/financial_accounts" }, { - "method_name": "retrieve", + "method_name": "update", "method_on": "service", - "method_type": "retrieve", - "operation": "get", + "method_type": "update", + "operation": "post", "path": "/v1/treasury/financial_accounts/{financial_account}" }, { - "method_name": "retrieve_features", + "method_name": "update_features", "method_on": "service", "method_type": "custom", - "operation": "get", + "operation": "post", "path": "/v1/treasury/financial_accounts/{financial_account}/features" } ], @@ -53653,7 +59741,7 @@ } }, "treasury.inbound_transfer": { - "description": "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.", + "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)", "properties": { "amount": { "description": "Amount (in cents) transferred.", @@ -53817,17 +59905,10 @@ "x-resourceId": "treasury.inbound_transfer", "x-stripeOperations": [ { - "method_name": "cancel", - "method_on": "service", - "method_type": "custom", - "operation": "post", - "path": "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel" - }, - { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/treasury/inbound_transfers" }, { @@ -53838,11 +59919,18 @@ "path": "/v1/treasury/inbound_transfers/{id}" }, { - "method_name": "list", + "method_name": "fail", "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/treasury/inbound_transfers" + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/fail" + }, + { + "method_name": "return_inbound_transfer", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/return" }, { "method_name": "succeed", @@ -53852,18 +59940,18 @@ "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed" }, { - "method_name": "fail", + "method_name": "create", "method_on": "service", - "method_type": "custom", + "method_type": "create", "operation": "post", - "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/fail" + "path": "/v1/treasury/inbound_transfers" }, { - "method_name": "return_inbound_transfer", + "method_name": "cancel", "method_on": "service", "method_type": "custom", "operation": "post", - "path": "/v1/test_helpers/treasury/inbound_transfers/{id}/return" + "path": "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel" } ], "x-stripeResource": { @@ -53937,7 +60025,7 @@ } }, "treasury.outbound_payment": { - "description": "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.", + "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)", "properties": { "amount": { "description": "Amount (in cents) transferred.", @@ -54060,6 +60148,15 @@ "status_transitions": { "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions" }, + "tracking_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details" + } + ], + "description": "Details about network-specific tracking information if available.", + "nullable": true + }, "transaction": { "anyOf": [ { @@ -54101,6 +60198,7 @@ "statement_descriptor", "status", "status_transitions", + "tracking_details", "transaction" ], "title": "TreasuryOutboundPaymentsResourceOutboundPayment", @@ -54110,15 +60208,16 @@ "end_user_details", "returned_details", "status_transitions", + "tracking_details", "transaction" ], "x-resourceId": "treasury.outbound_payment", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/treasury/outbound_payments" }, { @@ -54129,18 +60228,11 @@ "path": "/v1/treasury/outbound_payments/{id}" }, { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/treasury/outbound_payments" - }, - { - "method_name": "cancel", + "method_name": "update", "method_on": "service", - "method_type": "custom", + "method_type": "update", "operation": "post", - "path": "/v1/treasury/outbound_payments/{id}/cancel" + "path": "/v1/test_helpers/treasury/outbound_payments/{id}" }, { "method_name": "fail", @@ -54162,6 +60254,20 @@ "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_payments/{id}/return" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/treasury/outbound_payments" + }, + { + "method_name": "cancel", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/treasury/outbound_payments/{id}/cancel" } ], "x-stripeResource": { @@ -54266,8 +60372,24 @@ "type": "treasury.outbound_payment.returned" } }, + "treasury.outbound_payment.tracking_details_updated": { + "description": "Occurs whenever tracking_details on an OutboundPayment is updated.", + "properties": { + "object": { + "$ref": "#/components/schemas/treasury.outbound_payment" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "treasury.outbound_payment.tracking_details_updated" + } + }, "treasury.outbound_transfer": { - "description": "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.", + "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)", "properties": { "amount": { "description": "Amount (in cents) transferred.", @@ -54369,6 +60491,15 @@ "status_transitions": { "$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions" }, + "tracking_details": { + "anyOf": [ + { + "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details" + } + ], + "description": "Details about network-specific tracking information if available.", + "nullable": true + }, "transaction": { "anyOf": [ { @@ -54408,6 +60539,7 @@ "statement_descriptor", "status", "status_transitions", + "tracking_details", "transaction" ], "title": "TreasuryOutboundTransfersResourceOutboundTransfer", @@ -54416,15 +60548,16 @@ "destination_payment_method_details", "returned_details", "status_transitions", + "tracking_details", "transaction" ], "x-resourceId": "treasury.outbound_transfer", "x-stripeOperations": [ { - "method_name": "create", + "method_name": "list", "method_on": "service", - "method_type": "create", - "operation": "post", + "method_type": "list", + "operation": "get", "path": "/v1/treasury/outbound_transfers" }, { @@ -54435,18 +60568,11 @@ "path": "/v1/treasury/outbound_transfers/{outbound_transfer}" }, { - "method_name": "list", - "method_on": "service", - "method_type": "list", - "operation": "get", - "path": "/v1/treasury/outbound_transfers" - }, - { - "method_name": "cancel", + "method_name": "update", "method_on": "service", - "method_type": "custom", + "method_type": "update", "operation": "post", - "path": "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel" + "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}" }, { "method_name": "fail", @@ -54468,6 +60594,20 @@ "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/treasury/outbound_transfers" + }, + { + "method_name": "cancel", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel" } ], "x-stripeResource": { @@ -54572,6 +60712,22 @@ "type": "treasury.outbound_transfer.returned" } }, + "treasury.outbound_transfer.tracking_details_updated": { + "description": "Occurs whenever tracking_details on an OutboundTransfer is updated.", + "properties": { + "object": { + "$ref": "#/components/schemas/treasury.outbound_transfer" + } + }, + "required": [ + "object" + ], + "type": "object", + "x-expandableFields": [], + "x-stripeEvent": { + "type": "treasury.outbound_transfer.tracking_details_updated" + } + }, "treasury.received_credit": { "description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.", "properties": { @@ -55113,10 +61269,8 @@ "created", "currency", "description", - "entries", "financial_account", "flow", - "flow_details", "flow_type", "id", "livemode", @@ -55135,18 +61289,18 @@ "x-resourceId": "treasury.transaction", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/treasury/transactions/{id}" + "path": "/v1/treasury/transactions" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/treasury/transactions" + "path": "/v1/treasury/transactions/{id}" } ], "x-stripeResource": { @@ -55279,7 +61433,6 @@ "effective_at", "financial_account", "flow", - "flow_details", "flow_type", "id", "livemode", @@ -55297,18 +61450,18 @@ "x-resourceId": "treasury.transaction_entry", "x-stripeOperations": [ { - "method_name": "retrieve", + "method_name": "list", "method_on": "service", - "method_type": "retrieve", + "method_type": "list", "operation": "get", - "path": "/v1/treasury/transaction_entries/{id}" + "path": "/v1/treasury/transaction_entries" }, { - "method_name": "list", + "method_name": "retrieve", "method_on": "service", - "method_type": "list", + "method_type": "retrieve", "operation": "get", - "path": "/v1/treasury/transaction_entries" + "path": "/v1/treasury/transaction_entries/{id}" } ], "x-stripeResource": { @@ -55349,7 +61502,6 @@ }, "required": [ "account_holder_name", - "account_number", "account_number_last4", "bank_name", "routing_number" @@ -55752,7 +61904,8 @@ "inbound_flows", "outbound_flows" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -55848,6 +62001,22 @@ "in_package": "" } }, + "treasury_outbound_payments_resource_ach_tracking_details": { + "description": "", + "properties": { + "trace_id": { + "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "trace_id" + ], + "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails", + "type": "object", + "x-expandableFields": [] + }, "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": { "description": "", "properties": { @@ -55912,56 +62081,159 @@ "in_package": "" } }, - "treasury_outbound_payments_resource_returned_status": { + "treasury_outbound_payments_resource_outbound_payment_resource_tracking_details": { "description": "", "properties": { - "code": { - "description": "Reason for the return.", + "ach": { + "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details" + }, + "type": { + "description": "The US bank account network used to send funds.", "enum": [ - "account_closed", - "account_frozen", - "bank_account_restricted", - "bank_ownership_changed", - "declined", - "incorrect_account_holder_name", - "invalid_account_number", - "invalid_currency", - "no_account", - "other" + "ach", + "us_domestic_wire" ], "type": "string" }, - "transaction": { - "anyOf": [ - { - "maxLength": 5000, - "type": "string" - }, - { - "$ref": "#/components/schemas/treasury.transaction" - } - ], - "description": "The Transaction associated with this object.", - "x-expansionResources": { - "oneOf": [ - { - "$ref": "#/components/schemas/treasury.transaction" - } - ] - } + "us_domestic_wire": { + "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details" } }, "required": [ - "code", - "transaction" + "type" ], - "title": "TreasuryOutboundPaymentsResourceReturnedStatus", + "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails", "type": "object", "x-expandableFields": [ - "transaction" + "ach", + "us_domestic_wire" ] }, - "treasury_outbound_transfers_resource_returned_details": { + "treasury_outbound_payments_resource_returned_status": { + "description": "", + "properties": { + "code": { + "description": "Reason for the return.", + "enum": [ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "declined", + "incorrect_account_holder_name", + "invalid_account_number", + "invalid_currency", + "no_account", + "other" + ], + "type": "string" + }, + "transaction": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/treasury.transaction" + } + ], + "description": "The Transaction associated with this object.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/treasury.transaction" + } + ] + } + } + }, + "required": [ + "code", + "transaction" + ], + "title": "TreasuryOutboundPaymentsResourceReturnedStatus", + "type": "object", + "x-expandableFields": [ + "transaction" + ] + }, + "treasury_outbound_payments_resource_us_domestic_wire_tracking_details": { + "description": "", + "properties": { + "chips": { + "description": "CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "imad": { + "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "omad": { + "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "chips", + "imad", + "omad" + ], + "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails", + "type": "object", + "x-expandableFields": [] + }, + "treasury_outbound_transfers_resource_ach_tracking_details": { + "description": "", + "properties": { + "trace_id": { + "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "trace_id" + ], + "title": "TreasuryOutboundTransfersResourceACHTrackingDetails", + "type": "object", + "x-expandableFields": [] + }, + "treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details": { + "description": "", + "properties": { + "ach": { + "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details" + }, + "type": { + "description": "The US bank account network used to send funds.", + "enum": [ + "ach", + "us_domestic_wire" + ], + "type": "string" + }, + "us_domestic_wire": { + "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details" + } + }, + "required": [ + "type" + ], + "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails", + "type": "object", + "x-expandableFields": [ + "ach", + "us_domestic_wire" + ] + }, + "treasury_outbound_transfers_resource_returned_details": { "description": "", "properties": { "code": { @@ -56056,6 +62328,37 @@ "in_package": "" } }, + "treasury_outbound_transfers_resource_us_domestic_wire_tracking_details": { + "description": "", + "properties": { + "chips": { + "description": "CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "imad": { + "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "omad": { + "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "chips", + "imad", + "omad" + ], + "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails", + "type": "object", + "x-expandableFields": [] + }, "treasury_received_credits_resource_linked_flows": { "description": "", "properties": { @@ -56104,7 +62407,6 @@ "issuing_authorization", "issuing_transaction", "source_flow", - "source_flow_details", "source_flow_type" ], "title": "TreasuryReceivedCreditsResourceLinkedFlows", @@ -56238,13 +62540,20 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "payout": { + "description": "Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ "debit_reversal", "inbound_transfer", "issuing_authorization", - "issuing_transaction" + "issuing_transaction", + "payout" ], "title": "TreasuryReceivedDebitsResourceLinkedFlows", "type": "object", @@ -56553,7 +62862,7 @@ "x-expandableFields": [] }, "usage_record": { - "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)", + "description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based).", "properties": { "id": { "description": "Unique identifier for the object.", @@ -56700,7 +63009,7 @@ "x-expandableFields": [] }, "webhook_endpoint": { - "description": "You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure)", + "description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)", "properties": { "api_version": { "description": "The API version events are rendered as for this webhook endpoint.", @@ -56758,7 +63067,7 @@ "type": "string" }, "secret": { - "description": "The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation.", + "description": "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.", "maxLength": 5000, "type": "string" }, @@ -56791,6 +63100,13 @@ "x-expandableFields": [], "x-resourceId": "webhook_endpoint", "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/webhook_endpoints/{webhook_endpoint}" + }, { "method_name": "list", "method_on": "service", @@ -56818,13 +63134,6 @@ "method_type": "update", "operation": "post", "path": "/v1/webhook_endpoints/{webhook_endpoint}" - }, - { - "method_name": "delete", - "method_on": "service", - "method_type": "delete", - "operation": "delete", - "path": "/v1/webhook_endpoints/{webhook_endpoint}" } ], "x-stripeResource": { @@ -56857,7 +63166,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2023-10-16", + "version": "2024-06-20", "x-stripeSpecFilename": "spec3.sdk" }, "openapi": "3.0.0", @@ -56928,6 +63237,10 @@ "content": { "application/x-www-form-urlencoded": { "encoding": { + "collection_options": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -56942,13 +63255,39 @@ "type": "string" }, "collect": { - "description": "Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.", + "description": "The collect parameter is deprecated. Use `collection_options` instead.", "enum": [ "currently_due", "eventually_due" ], "type": "string" }, + "collection_options": { + "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.", + "properties": { + "fields": { + "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" + ], + "type": "string" + }, + "future_requirements": { + "description": "Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.", + "enum": [ + "include", + "omit" + ], + "type": "string" + } + }, + "required": [ + "fields" + ], + "title": "collection_options_params", + "type": "object" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -57036,8 +63375,95 @@ "components": { "description": "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).", "properties": { + "account_management": { + "description": "Configuration for the account management embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": { + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + } + }, + "title": "account_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "account_config_param", + "type": "object" + }, "account_onboarding": { "description": "Configuration for the account onboarding embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": { + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + } + }, + "title": "account_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "account_config_param", + "type": "object" + }, + "balances": { + "description": "Configuration for the balances embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": { + "edit_payout_schedule": { + "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", + "type": "boolean" + }, + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + }, + "instant_payouts": { + "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", + "type": "boolean" + }, + "standard_payouts": { + "description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", + "type": "boolean" + } + }, + "title": "payouts_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "payouts_config_param", + "type": "object" + }, + "documents": { + "description": "Configuration for the documents embedded component.", "properties": { "enabled": { "description": "Whether the embedded component is enabled.", @@ -57056,6 +63482,31 @@ "title": "base_config_param", "type": "object" }, + "notification_banner": { + "description": "Configuration for the notification banner embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": { + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + } + }, + "title": "account_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "account_config_param", + "type": "object" + }, "payment_details": { "description": "Configuration for the payment details embedded component.", "properties": { @@ -57070,6 +63521,10 @@ "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, + "destination_on_behalf_of_charge_management": { + "description": "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.", + "type": "boolean" + }, "dispute_management": { "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" @@ -57103,6 +63558,10 @@ "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.", "type": "boolean" }, + "destination_on_behalf_of_charge_management": { + "description": "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.", + "type": "boolean" + }, "dispute_management": { "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.", "type": "boolean" @@ -57136,6 +63595,10 @@ "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", "type": "boolean" }, + "external_account_collection": { + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.", + "type": "boolean" + }, "instant_payouts": { "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.", "type": "boolean" @@ -57154,6 +63617,66 @@ ], "title": "payouts_config_param", "type": "object" + }, + "payouts_list": { + "description": "Configuration for the payouts list embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": {}, + "title": "base_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "base_config_param", + "type": "object" + }, + "tax_registrations": { + "description": "Configuration for the tax registrations embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": {}, + "title": "base_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "base_config_param", + "type": "object" + }, + "tax_settings": { + "description": "Configuration for the tax settings embedded component.", + "properties": { + "enabled": { + "description": "Whether the embedded component is enabled.", + "type": "boolean" + }, + "features": { + "description": "The list of features enabled in the embedded component.", + "properties": {}, + "title": "base_features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "base_config_param", + "type": "object" } }, "title": "account_session_create_components_param", @@ -57208,6 +63731,7 @@ "operationId": "GetAccounts", "parameters": [ { + "description": "Only return connected accounts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -57380,6 +63904,10 @@ "explode": true, "style": "deepObject" }, + "controller": { + "explode": true, + "style": "deepObject" + }, "documents": { "explode": true, "style": "deepObject" @@ -57416,8 +63944,37 @@ "business_profile": { "description": "Business information about the account.", "properties": { + "annual_revenue": { + "description": "The applicant's gross annual revenue for its preceding fiscal year.", + "properties": { + "amount": { + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", + "type": "integer" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "fiscal_year_end": { + "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "amount", + "currency", + "fiscal_year_end" + ], + "title": "annual_revenue_specs", + "type": "object" + }, + "estimated_worker_count": { + "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", + "type": "integer" + }, "mcc": { - "description": "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "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.", "maxLength": 4, "type": "string" }, @@ -57425,7 +63982,7 @@ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -57519,7 +64076,7 @@ "type": "object" }, "business_type": { - "description": "The business type.", + "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", @@ -57530,7 +64087,7 @@ "x-stripeBypassValidation": true }, "capabilities": { - "description": "Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.", + "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.", "properties": { "acss_debit_payments": { "description": "The acss_debit_payments capability.", @@ -57565,6 +64122,17 @@ "title": "capability_param", "type": "object" }, + "amazon_pay_payments": { + "description": "The amazon_pay_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", "properties": { @@ -57697,6 +64265,17 @@ "title": "capability_param", "type": "object" }, + "gb_bank_transfer_payments": { + "description": "The gb_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "giropay_payments": { "description": "The giropay_payments capability.", "properties": { @@ -57752,6 +64331,17 @@ "title": "capability_param", "type": "object" }, + "jp_bank_transfer_payments": { + "description": "The jp_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "klarna_payments": { "description": "The klarna_payments capability.", "properties": { @@ -57796,6 +64386,39 @@ "title": "capability_param", "type": "object" }, + "mobilepay_payments": { + "description": "The mobilepay_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, + "multibanco_payments": { + "description": "The multibanco_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, + "mx_bank_transfer_payments": { + "description": "The mx_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "oxxo_payments": { "description": "The oxxo_payments capability.", "properties": { @@ -57851,6 +64474,17 @@ "title": "capability_param", "type": "object" }, + "sepa_bank_transfer_payments": { + "description": "The sepa_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", "properties": { @@ -57873,6 +64507,17 @@ "title": "capability_param", "type": "object" }, + "swish_payments": { + "description": "The swish_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", "properties": { @@ -57917,6 +64562,17 @@ "title": "capability_param", "type": "object" }, + "twint_payments": { + "description": "The twint_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", "properties": { @@ -57928,6 +64584,17 @@ "title": "capability_param", "type": "object" }, + "us_bank_transfer_payments": { + "description": "The us_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "zip_payments": { "description": "The zip_payments capability.", "properties": { @@ -57944,7 +64611,7 @@ "type": "object" }, "company": { - "description": "Information about the company or business. This field is available for any `business_type`.", + "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.", "properties": { "address": { "description": "The company's primary address.", @@ -57980,7 +64647,7 @@ "type": "string" } }, - "title": "address_specs", + "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { @@ -58068,11 +64735,11 @@ "type": "object" }, "directors_provided": { - "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](https://stripe.com/docs/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.", + "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.", "type": "boolean" }, "executives_provided": { - "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](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement.", + "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.", "type": "boolean" }, "export_license_id": { @@ -58101,7 +64768,7 @@ "type": "string" }, "owners_provided": { - "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](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement.", + "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.", "type": "boolean" }, "ownership_declaration": { @@ -58136,7 +64803,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.", + "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", @@ -58154,6 +64821,7 @@ "public_company", "public_corporation", "public_partnership", + "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", @@ -58208,20 +64876,81 @@ "title": "company_specs", "type": "object" }, + "controller": { + "description": "A hash of configuration describing the account controller's attributes.", + "properties": { + "fees": { + "description": "A hash of configuration for who pays Stripe fees for product usage on this account.", + "properties": { + "payer": { + "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" + ], + "type": "string" + } + }, + "title": "controller_fees_specs", + "type": "object" + }, + "losses": { + "description": "A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.", + "properties": { + "payments": { + "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" + ], + "type": "string" + } + }, + "title": "controller_losses_specs", + "type": "object" + }, + "requirement_collection": { + "description": "A value indicating responsibility for collecting updated information when requirements on the account are due or change. Defaults to `stripe`.", + "enum": [ + "application", + "stripe" + ], + "type": "string" + }, + "stripe_dashboard": { + "description": "A hash of configuration for Stripe-hosted dashboards.", + "properties": { + "type": { + "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" + ], + "type": "string" + } + }, + "title": "controller_dashboard_specs", + "type": "object" + } + }, + "title": "controller_specs", + "type": "object" + }, "country": { "description": "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.", "maxLength": 5000, "type": "string" }, "default_currency": { - "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).", + "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "type": "string" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { - "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 voided check.", + "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.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", @@ -58330,7 +65059,7 @@ "type": "object" }, "email": { - "description": "The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.", + "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.", "type": "string" }, "expand": { @@ -58342,13 +65071,13 @@ "type": "array" }, "external_account": { - "description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.", + "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.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After 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.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "individual": { - "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.", + "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/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.", "properties": { "address": { "description": "The individual's primary address.", @@ -58388,7 +65117,7 @@ "type": "object" }, "address_kana": { - "description": "The Kana variation of the the individual's primary address (Japan only).", + "description": "The Kana variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", @@ -58430,7 +65159,7 @@ "type": "object" }, "address_kanji": { - "description": "The Kanji variation of the the individual's primary address (Japan only).", + "description": "The Kanji variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", @@ -58515,7 +65244,7 @@ "type": "string" }, "first_name_kana": { - "description": "The Kana variation of the the individual's first name (Japan only).", + "description": "The Kana variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, @@ -58547,12 +65276,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -58642,6 +65371,44 @@ "title": "address_specs", "type": "object" }, + "relationship": { + "description": "Describes the person’s relationship to the account.", + "properties": { + "director": { + "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", + "type": "boolean" + }, + "executive": { + "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", + "type": "boolean" + }, + "owner": { + "description": "Whether the person is an owner of the account’s legal entity.", + "type": "boolean" + }, + "percent_ownership": { + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The percent owned by the person of the account's legal entity." + }, + "title": { + "description": "The person's title (e.g., CEO, Support Engineer).", + "maxLength": 5000, + "type": "string" + } + }, + "title": "individual_relationship_specs", + "type": "object" + }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", "maxLength": 5000, @@ -58754,7 +65521,7 @@ "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/docs/issuing/connect/tos_acceptance).", + "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", @@ -58849,17 +65616,17 @@ "description": "Settings that apply across payment methods for charging on the account.", "properties": { "statement_descriptor": { - "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.", + "description": "The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kana": { - "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).", + "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kanji": { - "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).", + "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" } @@ -58871,11 +65638,11 @@ "description": "Settings specific to the account's payouts.", "properties": { "debit_negative_balances": { - "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).", + "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).", "type": "boolean" }, "schedule": { - "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](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation.", + "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.", "properties": { "delay_days": { "anyOf": [ @@ -58890,7 +65657,7 @@ "type": "integer" } ], - "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule)." + "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", @@ -58978,7 +65745,7 @@ "type": "object" }, "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).", + "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). 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. This property defaults to a `full` service agreement when empty.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted their service agreement.", @@ -59045,7 +65812,7 @@ }, "/v1/accounts/{account}": { "delete": { - "description": "

With Connect, you can delete accounts you manage.

\n\n

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

\n\n

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

", + "description": "

With Connect, you can delete accounts you manage.

\n\n

Test-mode accounts can be deleted at any time.

\n\n

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

\n\n

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

", "operationId": "DeleteAccountsAccount", "parameters": [ { @@ -59162,7 +65929,7 @@ } }, "post": { - "description": "

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

\n\n

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an Account Link\nfor a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express\nbelow.

\n\n

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

", + "description": "

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

\n\n

For accounts where controller.requirement_collection\nis application, which includes Custom accounts, you can update any information on the account.

\n\n

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.

\n\n

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

", "operationId": "PostAccountsAccount", "parameters": [ { @@ -59228,8 +65995,37 @@ "business_profile": { "description": "Business information about the account.", "properties": { + "annual_revenue": { + "description": "The applicant's gross annual revenue for its preceding fiscal year.", + "properties": { + "amount": { + "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).", + "type": "integer" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "fiscal_year_end": { + "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "amount", + "currency", + "fiscal_year_end" + ], + "title": "annual_revenue_specs", + "type": "object" + }, + "estimated_worker_count": { + "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.", + "type": "integer" + }, "mcc": { - "description": "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.", + "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.", "maxLength": 4, "type": "string" }, @@ -59237,7 +66033,7 @@ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.", "properties": { "amount": { - "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).", "type": "integer" }, "currency": { @@ -59331,7 +66127,7 @@ "type": "object" }, "business_type": { - "description": "The business type.", + "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", @@ -59342,7 +66138,7 @@ "x-stripeBypassValidation": true }, "capabilities": { - "description": "Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.", + "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.", "properties": { "acss_debit_payments": { "description": "The acss_debit_payments capability.", @@ -59377,6 +66173,17 @@ "title": "capability_param", "type": "object" }, + "amazon_pay_payments": { + "description": "The amazon_pay_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "au_becs_debit_payments": { "description": "The au_becs_debit_payments capability.", "properties": { @@ -59509,6 +66316,17 @@ "title": "capability_param", "type": "object" }, + "gb_bank_transfer_payments": { + "description": "The gb_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "giropay_payments": { "description": "The giropay_payments capability.", "properties": { @@ -59564,6 +66382,17 @@ "title": "capability_param", "type": "object" }, + "jp_bank_transfer_payments": { + "description": "The jp_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "klarna_payments": { "description": "The klarna_payments capability.", "properties": { @@ -59608,6 +66437,39 @@ "title": "capability_param", "type": "object" }, + "mobilepay_payments": { + "description": "The mobilepay_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, + "multibanco_payments": { + "description": "The multibanco_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, + "mx_bank_transfer_payments": { + "description": "The mx_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "oxxo_payments": { "description": "The oxxo_payments capability.", "properties": { @@ -59663,6 +66525,17 @@ "title": "capability_param", "type": "object" }, + "sepa_bank_transfer_payments": { + "description": "The sepa_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "sepa_debit_payments": { "description": "The sepa_debit_payments capability.", "properties": { @@ -59685,6 +66558,17 @@ "title": "capability_param", "type": "object" }, + "swish_payments": { + "description": "The swish_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "tax_reporting_us_1099_k": { "description": "The tax_reporting_us_1099_k capability.", "properties": { @@ -59729,6 +66613,17 @@ "title": "capability_param", "type": "object" }, + "twint_payments": { + "description": "The twint_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "us_bank_account_ach_payments": { "description": "The us_bank_account_ach_payments capability.", "properties": { @@ -59740,6 +66635,17 @@ "title": "capability_param", "type": "object" }, + "us_bank_transfer_payments": { + "description": "The us_bank_transfer_payments capability.", + "properties": { + "requested": { + "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.", + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "zip_payments": { "description": "The zip_payments capability.", "properties": { @@ -59756,7 +66662,7 @@ "type": "object" }, "company": { - "description": "Information about the company or business. This field is available for any `business_type`.", + "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.", "properties": { "address": { "description": "The company's primary address.", @@ -59792,7 +66698,7 @@ "type": "string" } }, - "title": "address_specs", + "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { @@ -59880,11 +66786,11 @@ "type": "object" }, "directors_provided": { - "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](https://stripe.com/docs/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.", + "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.", "type": "boolean" }, "executives_provided": { - "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](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement.", + "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.", "type": "boolean" }, "export_license_id": { @@ -59913,7 +66819,7 @@ "type": "string" }, "owners_provided": { - "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](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement.", + "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.", "type": "boolean" }, "ownership_declaration": { @@ -59948,7 +66854,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.", + "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", @@ -59966,6 +66872,7 @@ "public_company", "public_corporation", "public_partnership", + "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", @@ -60021,14 +66928,14 @@ "type": "object" }, "default_currency": { - "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).", + "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", "type": "string" }, "documents": { "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { - "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 voided check.", + "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.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", @@ -60137,7 +67044,7 @@ "type": "object" }, "email": { - "description": "The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.", + "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.", "type": "string" }, "expand": { @@ -60149,13 +67056,13 @@ "type": "array" }, "external_account": { - "description": "A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.", + "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.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After 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.", "maxLength": 5000, "type": "string", "x-stripeBypassValidation": true }, "individual": { - "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.", + "description": "Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/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.", "properties": { "address": { "description": "The individual's primary address.", @@ -60195,7 +67102,7 @@ "type": "object" }, "address_kana": { - "description": "The Kana variation of the the individual's primary address (Japan only).", + "description": "The Kana variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", @@ -60237,7 +67144,7 @@ "type": "object" }, "address_kanji": { - "description": "The Kanji variation of the the individual's primary address (Japan only).", + "description": "The Kanji variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", @@ -60322,7 +67229,7 @@ "type": "string" }, "first_name_kana": { - "description": "The Kana variation of the the individual's first name (Japan only).", + "description": "The Kana variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, @@ -60354,12 +67261,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -60449,6 +67356,44 @@ "title": "address_specs", "type": "object" }, + "relationship": { + "description": "Describes the person’s relationship to the account.", + "properties": { + "director": { + "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", + "type": "boolean" + }, + "executive": { + "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", + "type": "boolean" + }, + "owner": { + "description": "Whether the person is an owner of the account’s legal entity.", + "type": "boolean" + }, + "percent_ownership": { + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The percent owned by the person of the account's legal entity." + }, + "title": { + "description": "The person's title (e.g., CEO, Support Engineer).", + "maxLength": 5000, + "type": "string" + } + }, + "title": "individual_relationship_specs", + "type": "object" + }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", "maxLength": 5000, @@ -60561,7 +67506,7 @@ "description": "Settings specific to the account's use of the Card Issuing product.", "properties": { "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](https://stripe.com/docs/issuing/connect/tos_acceptance).", + "description": "Details on the account's acceptance of the [Stripe Issuing Terms and Disclosures](/issuing/connect/tos_acceptance).", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted the service agreement.", @@ -60652,21 +67597,46 @@ "title": "card_payments_settings_specs", "type": "object" }, + "invoices": { + "description": "Settings specific to the account's use of Invoices.", + "properties": { + "default_account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized." + } + }, + "title": "invoices_settings_specs", + "type": "object" + }, "payments": { "description": "Settings that apply across payment methods for charging on the account.", "properties": { "statement_descriptor": { - "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.", + "description": "The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kana": { - "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).", + "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" }, "statement_descriptor_kanji": { - "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).", + "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).", "maxLength": 22, "type": "string" } @@ -60678,11 +67648,11 @@ "description": "Settings specific to the account's payouts.", "properties": { "debit_negative_balances": { - "description": "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).", + "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).", "type": "boolean" }, "schedule": { - "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](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation.", + "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.", "properties": { "delay_days": { "anyOf": [ @@ -60697,7 +67667,7 @@ "type": "integer" } ], - "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](https://stripe.com/docs/connect/manage-payout-schedule)." + "description": "The number of days charge funds are held before being paid out. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `interval` is `manual`. [Learn more about controlling payout delay days](/connect/manage-payout-schedule)." }, "interval": { "description": "How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.", @@ -60785,7 +67755,7 @@ "type": "object" }, "tos_acceptance": { - "description": "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).", + "description": "Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). 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. This property defaults to a `full` service agreement when empty.", "properties": { "date": { "description": "The Unix timestamp marking when the account representative accepted their service agreement.", @@ -61065,7 +68035,7 @@ "type": "array" }, "requested": { - "description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Most capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.", + "description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.", "type": "boolean" } }, @@ -61478,7 +68448,7 @@ } }, "post": { - "description": "

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

\n\n

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

", + "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\n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n\n

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

", "operationId": "PostAccountsAccountExternalAccountsId", "parameters": [ { @@ -61585,7 +68555,7 @@ "description": "Documents that may be submitted to satisfy various informational requests.", "properties": { "bank_account_ownership_verification": { - "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 voided check.", + "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.", "properties": { "files": { "description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.", @@ -61676,7 +68646,7 @@ }, "/v1/accounts/{account}/login_links": { "post": { - "description": "

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

\n\n

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

", + "description": "

Creates a single-use login link for a connected account to access the Express Dashboard.

\n\n

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

", "operationId": "PostAccountsAccountLoginLinks", "parameters": [ { @@ -61981,7 +68951,7 @@ "additionalProperties": false, "properties": { "additional_tos_acceptances": { - "description": "Details on the legal guardian's acceptance of the required Stripe agreements.", + "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", @@ -62052,7 +69022,7 @@ "type": "string" } }, - "title": "address_specs", + "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { @@ -62305,12 +69275,12 @@ "type": "string" }, "id_number": { - "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -62357,7 +69327,7 @@ "type": "string" }, "person_token": { - "description": "A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person.", + "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, @@ -62749,7 +69719,7 @@ "additionalProperties": false, "properties": { "additional_tos_acceptances": { - "description": "Details on the legal guardian's acceptance of the required Stripe agreements.", + "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", @@ -62820,7 +69790,7 @@ "type": "string" } }, - "title": "address_specs", + "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { @@ -63073,12 +70043,12 @@ "type": "string" }, "id_number": { - "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -63125,7 +70095,7 @@ "type": "string" }, "person_token": { - "description": "A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person.", + "description": "A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.", "maxLength": 5000, "type": "string" }, @@ -63299,7 +70269,7 @@ }, "/v1/accounts/{account}/reject": { "post": { - "description": "

With Connect, you may flag accounts as suspicious.

\n\n

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

", + "description": "

With Connect, you can reject accounts that you have flagged as suspicious.

\n\n

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

", "operationId": "PostAccountsAccountReject", "parameters": [ { @@ -63703,6 +70673,7 @@ "style": "form" }, { + "description": "Only return applications fees that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -64827,6 +71798,7 @@ "operationId": "GetBalanceTransactions", "parameters": [ { + "description": "Only return transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -65094,18 +72066,21 @@ } } }, - "/v1/billing_portal/configurations": { + "/v1/billing/alerts": { "get": { - "description": "

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

", - "operationId": "GetBillingPortalConfigurations", + "description": "

Lists billing active and inactive alerts

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

Creates a billing alert

", + "operationId": "PostBillingAlerts", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "filter": { + "explode": true, + "style": "deepObject" + }, + "usage_threshold_config": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "alert_type": { + "description": "The type of alert to create.", + "enum": [ + "usage_threshold" + ], + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "filter": { + "description": "Filters to limit the scope of an alert.", + "properties": { + "customer": { + "description": "Limit the scope to this alert only to this customer.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "alert_filter", + "type": "object" + }, + "title": { + "description": "The title of the alert.", + "maxLength": 256, + "type": "string" + }, + "usage_threshold_config": { + "description": "The configuration of the usage threshold.", + "properties": { + "gte": { + "description": "Defines at which value the alert will fire.", + "type": "integer" + }, + "meter": { + "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.", + "maxLength": 5000, + "type": "string" + }, + "recurrence": { + "description": "Whether the alert should only fire only once, or once per billing cycle.", + "enum": [ + "one_time" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "gte", + "recurrence" + ], + "title": "usage_threshold_config", + "type": "object" + } + }, + "required": [ + "alert_type", + "title" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.alert" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/alerts/{id}": { + "get": { + "description": "

Retrieves a billing alert given an ID

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

Reactivates this alert, allowing it to trigger again.

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

Archives this alert, removing it from the list view and APIs. This is non-reversible.

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

Deactivates this alert, preventing it from triggering.

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

Creates a billing meter event adjustment

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

Creates a billing meter event

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

Retrieve a list of billing meters.

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

Creates a billing meter

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

Retrieves a billing meter given an ID

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

Updates a billing meter

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

Deactivates a billing meter

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

Retrieve a list of billing meter event summaries.

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

Reactivates a billing meter

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

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

", + "operationId": "GetBillingPortalConfigurations", + "parameters": [ + { + "description": "Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).", + "in": "query", + "name": "active", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).", + "in": "query", + "name": "is_default", + "required": false, + "schema": { + "type": "boolean" }, "style": "form" }, @@ -65469,17 +73893,6 @@ "title": "subscription_cancel_creation_param", "type": "object" }, - "subscription_pause": { - "description": "Information about pausing subscriptions in the portal.", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "title": "subscription_pause_param", - "type": "object" - }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", "properties": { @@ -65950,17 +74363,6 @@ "title": "subscription_cancel_updating_param", "type": "object" }, - "subscription_pause": { - "description": "Information about pausing subscriptions in the portal.", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "title": "subscription_pause_param", - "type": "object" - }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", "properties": { @@ -66389,7 +74791,7 @@ "type": "string" }, "on_behalf_of": { - "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", + "description": "The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.", "type": "string" }, "return_url": { @@ -66436,6 +74838,7 @@ "operationId": "GetCharges", "parameters": [ { + "description": "Only return charges that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -66539,7 +74942,7 @@ "style": "form" }, { - "description": "Only return charges for this transfer group.", + "description": "Only return charges for this transfer group, limited to 100.", "in": "query", "name": "transfer_group", "required": false, @@ -66623,7 +75026,7 @@ } }, "post": { - "description": "

Use the Payment Intents API to initiate a new payment instead\nof using this method. Confirmation of the PaymentIntent creates the Charge\nobject used to request payment, so this method is limited to legacy integrations.

", + "description": "

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

", "operationId": "PostCharges", "requestBody": { "content": { @@ -66665,7 +75068,7 @@ "type": "integer" }, "application_fee_amount": { - "description": "A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees).", + "description": "A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees).", "type": "integer" }, "capture": { @@ -66730,7 +75133,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "on_behalf_of": { - "description": "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of).", + "description": "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant).", "maxLength": 5000, "type": "string" }, @@ -66825,12 +75228,12 @@ "x-stripeBypassValidation": true }, "statement_descriptor": { - "description": "For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 22, "type": "string" }, @@ -67347,12 +75750,12 @@ "type": "string" }, "statement_descriptor": { - "description": "For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 22, "type": "string" }, @@ -67617,7 +76020,7 @@ "operationId": "GetCheckoutSessions", "parameters": [ { - "description": "Only return the Checkout Sessions that were created during the given date interval.", + "description": "Only return Checkout Sessions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -67907,6 +76310,10 @@ "explode": true, "style": "deepObject" }, + "payment_method_data": { + "explode": true, + "style": "deepObject" + }, "payment_method_options": { "explode": true, "style": "deepObject" @@ -67919,6 +76326,10 @@ "explode": true, "style": "deepObject" }, + "saved_payment_method_options": { + "explode": true, + "style": "deepObject" + }, "setup_intent_data": { "explode": true, "style": "deepObject" @@ -67978,6 +76389,28 @@ "enabled": { "description": "Set to true to enable automatic taxes.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -67987,7 +76420,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Specify whether Checkout should collect the customer's billing address.", + "description": "Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -67995,7 +76428,7 @@ "type": "string" }, "cancel_url": { - "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.", + "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`.", "maxLength": 5000, "type": "string" }, @@ -68050,12 +76483,17 @@ "type": "string" }, "custom_fields": { - "description": "Collect additional information from your customer using custom fields. Up to 2 fields are supported.", + "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "properties": { "dropdown": { "description": "Configuration for `type=dropdown` fields.", "properties": { + "default_value": { + "description": "The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.", + "maxLength": 100, + "type": "string" + }, "options": { "description": "The options available for the customer to select. Up to 200 options allowed.", "items": { @@ -68118,6 +76556,11 @@ "numeric": { "description": "Configuration for `type=numeric` fields.", "properties": { + "default_value": { + "description": "The value that will pre-fill the field on the payment page.", + "maxLength": 255, + "type": "string" + }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" @@ -68137,6 +76580,11 @@ "text": { "description": "Configuration for `type=text` fields.", "properties": { + "default_value": { + "description": "The value that will pre-fill the field on the payment page.", + "maxLength": 255, + "type": "string" + }, "maximum_length": { "description": "The maximum character length constraint for the customer's input.", "type": "integer" @@ -68394,13 +76842,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -68432,6 +76880,28 @@ "maxLength": 5000, "type": "string" }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, "metadata": { "additionalProperties": { "type": "string" @@ -68580,7 +77050,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -68813,12 +77283,12 @@ "type": "object" }, "statement_descriptor": { - "description": "Extra information about the payment. This will appear on your\ncustomer's statement when this payment succeeds in creating a charge.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about the charge that customers see on their statements. Concatenated with the\nprefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete\nstatement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 22, "type": "string" }, @@ -68849,7 +77319,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\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://stripe.com/docs/payments/checkout/free-trials).", + "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://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -68861,6 +77331,22 @@ "maxLength": 100, "type": "string" }, + "payment_method_data": { + "description": "This parameter allows you to set some attributes on the payment method created during a Checkout session.", + "properties": { + "allow_redisplay": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_data_param", + "type": "object" + }, "payment_method_options": { "description": "Payment-method-specific configuration.", "properties": { @@ -68930,7 +77416,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -68956,7 +77442,7 @@ "description": "contains details about the Affirm payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -68970,7 +77456,7 @@ "description": "contains details about the Afterpay Clearpay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -68984,7 +77470,7 @@ "description": "contains details about the Alipay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -68994,11 +77480,26 @@ "title": "payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "contains details about the AmazonPay payment method options.", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, "au_becs_debit": { "description": "contains details about the AU Becs Debit payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69012,7 +77513,7 @@ "description": "contains details about the Bacs Debit payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -69028,7 +77529,7 @@ "description": "contains details about the Bancontact payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69046,7 +77547,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -69072,8 +77573,18 @@ "title": "installments_param", "type": "object" }, + "request_three_d_secure": { + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "enum": [ + "any", + "automatic", + "challenge" + ], + "type": "string", + "x-stripeBypassValidation": true + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -69098,7 +77609,7 @@ "description": "contains details about the Cashapp Pay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -69175,7 +77686,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69189,7 +77700,7 @@ "description": "contains details about the EPS payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69203,7 +77714,7 @@ "description": "contains details about the FPX payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69217,7 +77728,7 @@ "description": "contains details about the Giropay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69231,7 +77742,7 @@ "description": "contains details about the Grabpay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69245,7 +77756,7 @@ "description": "contains details about the Ideal payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69259,7 +77770,7 @@ "description": "contains details about the Klarna payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69277,7 +77788,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69291,7 +77802,7 @@ "description": "contains details about the Link payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -69302,6 +77813,34 @@ "title": "payment_method_options_param", "type": "object" }, + "mobilepay": { + "description": "contains details about the Mobilepay payment method options.", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + "multibanco": { + "description": "contains details about the Multibanco payment method options.", + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, "oxxo": { "description": "contains details about the OXXO payment method options.", "properties": { @@ -69310,7 +77849,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69324,7 +77863,7 @@ "description": "contains details about the P24 payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69342,7 +77881,7 @@ "description": "contains details about the PayNow payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69402,7 +77941,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -69429,7 +77968,7 @@ "description": "contains details about the RevolutPay payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -69444,7 +77983,7 @@ "description": "contains details about the Sepa Debit payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -69460,7 +77999,7 @@ "description": "contains details about the Sofort payment method options.", "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69470,6 +78009,18 @@ "title": "payment_method_options_param", "type": "object" }, + "swish": { + "description": "contains details about the Swish payment method options.", + "properties": { + "reference": { + "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, "us_bank_account": { "description": "contains details about the Us Bank Account payment method options.", "properties": { @@ -69496,6 +78047,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -69508,7 +78060,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -69548,7 +78100,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" ], @@ -69573,6 +78125,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -69589,6 +78142,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -69598,6 +78153,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -69622,7 +78179,7 @@ "type": "object" }, "redirect_on_completion": { - "description": "This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.", + "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`.", "enum": [ "always", "if_required", @@ -69635,6 +78192,33 @@ "maxLength": 5000, "type": "string" }, + "saved_payment_method_options": { + "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.", + "properties": { + "allow_redisplay_filters": { + "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": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_save": { + "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string" + } + }, + "title": "saved_payment_method_options_param", + "type": "object" + }, "setup_intent_data": { "description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.", "properties": { @@ -69924,7 +78508,7 @@ "type": "string" }, "shipping_rate_data": { - "description": "Parameters to be passed to Shipping Rate creation for this shipping option", + "description": "Parameters to be passed to Shipping Rate creation for this shipping option.", "properties": { "delivery_estimate": { "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.", @@ -70056,7 +78640,7 @@ "type": "string" }, "type": { - "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.", + "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], @@ -70076,7 +78660,7 @@ "type": "array" }, "submit_type": { - "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode, but not Checkout Sessions\nin `subscription` or `setup` mode. Possible values are `auto`, `pay`, `book`, `donate`. If blank or `auto`, `pay` is used.", + "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.", "enum": [ "auto", "book", @@ -70110,6 +78694,35 @@ "maxLength": 500, "type": "string" }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings_params", + "type": "object" + }, "metadata": { "additionalProperties": { "type": "string" @@ -70195,10 +78808,10 @@ "type": "string" }, "tax_id_collection": { - "description": "Controls tax ID collection settings for the session.", + "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { - "description": "Set to true to enable Tax ID collection.", + "description": "Enable tax ID collection during checkout. Defaults to `false`.", "type": "boolean" } }, @@ -70209,7 +78822,7 @@ "type": "object" }, "ui_mode": { - "description": "`ui_mode` can be `hosted` or `embedded`. The default is `hosted`.", + "description": "The UI mode of the Session. Defaults to `hosted`.", "enum": [ "embedded", "hosted" @@ -70314,12 +78927,10 @@ "description": "Error response." } } - } - }, - "/v1/checkout/sessions/{session}/expire": { + }, "post": { - "description": "

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

\n\n

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

", - "operationId": "PostCheckoutSessionsSessionExpire", + "description": "

Updates a Session object.

", + "operationId": "PostCheckoutSessionsSession", "parameters": [ { "in": "path", @@ -70339,6 +78950,10 @@ "expand": { "explode": true, "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -70351,6 +78966,23 @@ "type": "string" }, "type": "array" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." } }, "type": "object" @@ -70383,47 +79015,11 @@ } } }, - "/v1/checkout/sessions/{session}/line_items": { - "get": { - "description": "

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

", - "operationId": "GetCheckoutSessionsSessionLineItems", + "/v1/checkout/sessions/{session}/expire": { + "post": { + "description": "

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

\n\n

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

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

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

", - "operationId": "GetClimateOrders", + "description": "

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

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

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

", + "operationId": "GetClimateOrders", "parameters": [ { "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", @@ -70937,7 +79636,7 @@ }, "/v1/climate/orders/{order}/cancel": { "post": { - "description": "

Cancels a Climate order. You can cancel an order within 30 days 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.

", + "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.

", "operationId": "PostClimateOrdersOrderCancel", "parameters": [ { @@ -71391,6 +80090,74 @@ } } }, + "/v1/confirmation_tokens/{confirmation_token}": { + "get": { + "description": "

Retrieves an existing ConfirmationToken object

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

Lists all Country Spec objects available in the API.

", @@ -72143,6 +80910,43 @@ "description": "

Returns a list of credit notes.

", "operationId": "GetCreditNotes", "parameters": [ + { + "description": "Only return credit notes that were created during the given date interval.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "anyOf": [ + { + "properties": { + "gt": { + "description": "Minimum value to filter by (exclusive)", + "type": "integer" + }, + "gte": { + "description": "Minimum value to filter by (inclusive)", + "type": "integer" + }, + "lt": { + "description": "Maximum value to filter by (exclusive)", + "type": "integer" + }, + "lte": { + "description": "Maximum value to filter by (inclusive)", + "type": "integer" + } + }, + "title": "range_query_specs", + "type": "object" + }, + { + "type": "integer" + } + ] + }, + "style": "deepObject" + }, { "description": "Only return credit notes for the customer specified by this customer ID.", "in": "query", @@ -72324,6 +81128,14 @@ "format": "unix-time", "type": "integer" }, + "email_type": { + "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" + ], + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -72557,6 +81369,20 @@ }, "style": "form" }, + { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "in": "query", + "name": "email_type", + "required": false, + "schema": { + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, + "style": "form" + }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, @@ -72858,6 +81684,20 @@ }, "style": "form" }, + { + "description": "Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.", + "in": "query", + "name": "email_type", + "required": false, + "schema": { + "enum": [ + "credit_note", + "none" + ], + "type": "string" + }, + "style": "form" + }, { "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", "in": "query", @@ -73193,7 +82033,7 @@ }, "/v1/credit_notes/{credit_note}/lines": { "get": { - "description": "

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

", + "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": [ { @@ -73545,7 +82385,7 @@ }, "/v1/customer_sessions": { "post": { - "description": "

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

", + "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": { @@ -73564,7 +82404,7 @@ "additionalProperties": false, "properties": { "components": { - "description": "Configuration for each component. 1 component must be enabled.", + "description": "Configuration for each component. Exactly 1 component must be enabled.", "properties": { "buy_button": { "description": "Configuration for buy button.", @@ -73580,6 +82420,78 @@ "title": "buy_button_param", "type": "object" }, + "payment_element": { + "description": "Configuration for the Payment Element.", + "properties": { + "enabled": { + "description": "Whether the Payment Element is enabled.", + "type": "boolean" + }, + "features": { + "description": "This hash defines whether the Payment Element supports certain features.", + "properties": { + "payment_method_allow_redisplay_filters": { + "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": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "type": "array" + }, + "payment_method_redisplay": { + "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.", + "enum": [ + "disabled", + "enabled" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_redisplay_limit": { + "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.", + "type": "integer" + }, + "payment_method_remove": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "payment_method_save_usage": { + "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" + ], + "type": "string" + } + }, + "title": "features_param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "payment_element_param", + "type": "object" + }, "pricing_table": { "description": "Configuration for the pricing table.", "properties": { @@ -73599,7 +82511,7 @@ "type": "object" }, "customer": { - "description": "The ID of an existing customer for which to create the customer session.", + "description": "The ID of an existing customer for which to create the Customer Session.", "maxLength": 5000, "type": "string" }, @@ -73652,6 +82564,7 @@ "operationId": "GetCustomers", "parameters": [ { + "description": "Only return customers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -73986,13 +82899,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -74038,7 +82951,7 @@ "type": "string" } }, - "title": "rendering_options_param", + "title": "customer_rendering_options_param", "type": "object" }, { @@ -74098,7 +83011,7 @@ "type": "array" }, "promotion_code": { - "description": "The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.", + "description": "The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.", "maxLength": 5000, "type": "string" }, @@ -74219,7 +83132,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -74227,6 +83140,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -74236,11 +83150,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -74250,6 +83166,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -74260,13 +83177,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -74773,13 +83694,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -74825,7 +83746,7 @@ "type": "string" } }, - "title": "rendering_options_param", + "title": "customer_rendering_options_param", "type": "object" }, { @@ -74881,7 +83802,7 @@ "type": "array" }, "promotion_code": { - "description": "The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.", + "description": "The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.", "maxLength": 5000, "type": "string" }, @@ -76010,6 +84931,21 @@ "description": "

Returns a list of PaymentMethods for a given Customer

", "operationId": "GetCustomersCustomerPaymentMethods", "parameters": [ + { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "in": "query", + "name": "allow_redisplay", + "required": false, + "schema": { + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "style": "form" + }, { "in": "path", "name": "customer", @@ -76076,6 +85012,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -76092,6 +85029,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -76101,6 +85040,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -77138,7 +86079,7 @@ "type": "array" }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -77146,6 +86087,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -77155,11 +86097,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -77169,6 +86113,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -77179,13 +86124,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -77404,6 +86353,7 @@ "style": "form" }, { + "description": "Only return disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -77933,197 +86883,20 @@ } } }, - "/v1/ephemeral_keys": { - "post": { - "description": "

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

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

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

", - "operationId": "DeleteEphemeralKeysKey", + "/v1/entitlements/active_entitlements": { + "get": { + "description": "

Retrieve a list of active entitlements for a customer

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

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

", - "operationId": "GetEvents", - "parameters": [ - { - "explode": true, - "in": "query", - "name": "created", - "required": false, - "schema": { - "anyOf": [ - { - "properties": { - "gt": { - "description": "Minimum value to filter by (exclusive)", - "type": "integer" - }, - "gte": { - "description": "Minimum value to filter by (inclusive)", - "type": "integer" - }, - "lt": { - "description": "Maximum value to filter by (exclusive)", - "type": "integer" - }, - "lte": { - "description": "Maximum value to filter by (inclusive)", - "type": "integer" - } - }, - "title": "range_query_specs", - "type": "object" - }, - { - "type": "integer" - } - ] - }, - "style": "deepObject" - }, - { - "description": "Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.", - "in": "query", - "name": "delivery_success", - "required": false, - "schema": { - "type": "boolean" - }, "style": "form" }, { @@ -78172,32 +86945,804 @@ "type": "string" }, "style": "form" - }, - { - "description": "A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.", - "in": "query", - "name": "type", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.", - "explode": true, - "in": "query", - "name": "types", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/entitlements.active_entitlement" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "EntitlementsResourceCustomerEntitlementList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/entitlements/active_entitlements/{id}": { + "get": { + "description": "

Retrieve an active entitlement

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

Retrieve a list of features

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

Creates a feature

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

Retrieves a feature

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

Update a feature’s metadata or permanently deactivate it.

", + "operationId": "PostEntitlementsFeaturesId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "active": { + "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "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": { + "description": "The feature's name, for your own purpose, not meant to be displayable to the customer.", + "maxLength": 80, + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/entitlements.feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/ephemeral_keys": { + "post": { + "description": "

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

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

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

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

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

", + "operationId": "GetEvents", + "parameters": [ + { + "description": "Only return events that were created during the given date interval.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "anyOf": [ + { + "properties": { + "gt": { + "description": "Minimum value to filter by (exclusive)", + "type": "integer" + }, + "gte": { + "description": "Minimum value to filter by (inclusive)", + "type": "integer" + }, + "lt": { + "description": "Maximum value to filter by (exclusive)", + "type": "integer" + }, + "lte": { + "description": "Maximum value to filter by (inclusive)", + "type": "integer" + } + }, + "title": "range_query_specs", + "type": "object" + }, + { + "type": "integer" + } + ] + }, + "style": "deepObject" + }, + { + "description": "Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.", + "in": "query", + "name": "delivery_success", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.", + "explode": true, + "in": "query", + "name": "types", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" } ], "requestBody": { @@ -78275,7 +87820,7 @@ }, "/v1/events/{id}": { "get": { - "description": "

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

", + "description": "

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": [ { @@ -78541,6 +88086,7 @@ "operationId": "GetFileLinks", "parameters": [ { + "description": "Only return links that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -78988,6 +88534,7 @@ "operationId": "GetFiles", "parameters": [ { + "description": "Only return files that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -79937,7 +89484,7 @@ "type": "array" }, "features": { - "description": "The list of account features to which you would like to subscribe.`.", + "description": "The list of account features to which you would like to subscribe.", "items": { "enum": [ "transactions" @@ -80137,6 +89684,20 @@ "filters": { "description": "Filters to restrict the kinds of accounts to collect.", "properties": { + "account_subcategories": { + "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.", + "items": { + "enum": [ + "checking", + "credit_card", + "line_of_credit", + "mortgage", + "savings" + ], + "type": "string" + }, + "type": "array" + }, "countries": { "description": "List of countries from which to collect accounts.", "items": { @@ -80146,9 +89707,6 @@ "type": "array" } }, - "required": [ - "countries" - ], "title": "filters_params", "type": "object" }, @@ -80553,12 +90111,372 @@ } } }, + "/v1/forwarding/requests": { + "get": { + "description": "

Lists all ForwardingRequest objects.

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

Creates a ForwardingRequest object.

", + "operationId": "PostForwardingRequests", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "replacements": { + "explode": true, + "style": "deepObject" + }, + "request": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "payment_method": { + "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", + "maxLength": 5000, + "type": "string" + }, + "replacements": { + "description": "The field kinds to be replaced in the forwarded request.", + "items": { + "enum": [ + "card_cvc", + "card_expiry", + "card_number", + "cardholder_name" + ], + "type": "string" + }, + "type": "array" + }, + "request": { + "description": "The request body and headers to be sent to the destination endpoint.", + "properties": { + "body": { + "description": "The body payload to send to the destination endpoint.", + "maxLength": 5000, + "type": "string" + }, + "headers": { + "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.", + "items": { + "properties": { + "name": { + "description": "The header name.", + "maxLength": 5000, + "type": "string" + }, + "value": { + "description": "The header value.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "title": "header_param", + "type": "object" + }, + "type": "array" + } + }, + "title": "request_param", + "type": "object" + }, + "url": { + "description": "The destination URL for the forwarded request. Must be supported by the config.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "payment_method", + "replacements", + "url" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/forwarding.request" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/forwarding/requests/{id}": { + "get": { + "description": "

Retrieves a ForwardingRequest object.

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

List all verification reports.

", "operationId": "GetIdentityVerificationReports", "parameters": [ { + "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", + "in": "query", + "name": "client_reference_id", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Only return VerificationReports that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -80815,6 +90733,18 @@ "operationId": "GetIdentityVerificationSessions", "parameters": [ { + "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", + "in": "query", + "name": "client_reference_id", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Only return VerificationSessions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -80886,6 +90816,16 @@ }, "style": "form" }, + { + "in": "query", + "name": "related_customer", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", "in": "query", @@ -81004,11 +90944,20 @@ "options": { "explode": true, "style": "deepObject" + }, + "provided_details": { + "explode": true, + "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { + "client_reference_id": { + "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.", + "maxLength": 5000, + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -81072,28 +91021,50 @@ "title": "session_options_param", "type": "object" }, + "provided_details": { + "description": "Details provided about the user being verified. These details may be shown to the user.", + "properties": { + "email": { + "description": "Email of user being verified", + "type": "string" + }, + "phone": { + "description": "Phone number of user being verified", + "type": "string" + } + }, + "title": "provided_details_param", + "type": "object" + }, + "related_customer": { + "description": "Token referencing a Customer resource.", + "maxLength": 5000, + "type": "string" + }, "return_url": { "description": "The URL that the user will be redirected to upon completing the verification flow.", "type": "string" }, "type": { - "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", + "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.", "enum": [ "document", "id_number" ], "type": "string", "x-stripeBypassValidation": true + }, + "verification_flow": { + "description": "The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.", + "maxLength": 5000, + "type": "string" } }, - "required": [ - "type" - ], "type": "object" } } }, - "required": true + "required": false }, "responses": { "200": { @@ -81216,6 +91187,10 @@ "options": { "explode": true, "style": "deepObject" + }, + "provided_details": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -81284,6 +91259,21 @@ "title": "session_options_param", "type": "object" }, + "provided_details": { + "description": "Details provided about the user being verified. These details may be shown to the user.", + "properties": { + "email": { + "description": "Email of user being verified", + "type": "string" + }, + "phone": { + "description": "Phone number of user being verified", + "type": "string" + } + }, + "title": "provided_details_param", + "type": "object" + }, "type": { "description": "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.", "enum": [ @@ -81464,6 +91454,7 @@ "operationId": "GetInvoiceitems", "parameters": [ { + "description": "Only return invoice items that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -81726,393 +91717,9 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" - } - }, - "title": "discounts_data_param", - "type": "object" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The coupons to redeem into discounts for the invoice item or invoice line item." - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "invoice": { - "description": "The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.", - "maxLength": 5000, - "type": "string" - }, - "metadata": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." - }, - "period": { - "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", - "properties": { - "end": { - "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", - "format": "unix-time", - "type": "integer" - }, - "start": { - "description": "The start of the period. This value is inclusive.", - "format": "unix-time", - "type": "integer" - } - }, - "required": [ - "end", - "start" - ], - "title": "period", - "type": "object" - }, - "price": { - "description": "The ID of the price object.", - "maxLength": 5000, - "type": "string" - }, - "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", - "properties": { - "currency": { - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", - "type": "string" - }, - "product": { - "description": "The ID of the product that this price will belong to.", - "maxLength": 5000, - "type": "string" - }, - "tax_behavior": { - "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", - "enum": [ - "exclusive", - "inclusive", - "unspecified" - ], - "type": "string" - }, - "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", - "type": "integer" - }, - "unit_amount_decimal": { - "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", - "format": "decimal", - "type": "string" - } - }, - "required": [ - "currency", - "product" - ], - "title": "one_time_price_data", - "type": "object" - }, - "quantity": { - "description": "Non-negative integer. The quantity of units for the invoice item.", - "type": "integer" - }, - "subscription": { - "description": "The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.", - "maxLength": 5000, - "type": "string" - }, - "tax_behavior": { - "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", - "enum": [ - "exclusive", - "inclusive", - "unspecified" - ], - "type": "string" - }, - "tax_code": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." - }, - "tax_rates": { - "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "unit_amount": { - "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.", - "type": "integer" - }, - "unit_amount_decimal": { - "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", - "format": "decimal", - "type": "string" - } - }, - "required": [ - "customer" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/invoiceitem" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/invoiceitems/{invoiceitem}": { - "delete": { - "description": "

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

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

Retrieves the invoice item with the given ID.

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

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

", - "operationId": "PostInvoiceitemsInvoiceitem", - "parameters": [ - { - "in": "path", - "name": "invoiceitem", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "discounts": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - }, - "period": { - "explode": true, - "style": "deepObject" - }, - "price_data": { - "explode": true, - "style": "deepObject" - }, - "tax_code": { - "explode": true, - "style": "deepObject" - }, - "tax_rates": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "amount": { - "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", - "type": "integer" - }, - "description": { - "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", - "maxLength": 5000, - "type": "string" - }, - "discountable": { - "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.", - "type": "boolean" - }, - "discounts": { - "anyOf": [ - { - "items": { - "properties": { - "coupon": { - "description": "ID of the coupon to create a new discount for.", - "maxLength": 5000, - "type": "string" }, - "discount": { - "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", "maxLength": 5000, "type": "string" } @@ -82129,7 +91736,7 @@ "type": "string" } ], - "description": "The coupons & 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." + "description": "The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item." }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -82139,6 +91746,11 @@ }, "type": "array" }, + "invoice": { + "description": "The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.", + "maxLength": 5000, + "type": "string" + }, "metadata": { "anyOf": [ { @@ -82178,12 +91790,401 @@ "type": "object" }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the invoice item.", + "type": "integer" + }, + "subscription": { + "description": "The ID of a subscription to add this invoice item to. When left blank, the invoice item 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.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "tax_code": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." + }, + "tax_rates": { + "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "unit_amount": { + "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "customer" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoiceitem" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoiceitems/{invoiceitem}": { + "delete": { + "description": "

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

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

Retrieves the invoice item with the given ID.

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

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

", + "operationId": "PostInvoiceitemsInvoiceitem", + "parameters": [ + { + "in": "path", + "name": "invoiceitem", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "discounts": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + }, + "period": { + "explode": true, + "style": "deepObject" + }, + "price_data": { + "explode": true, + "style": "deepObject" + }, + "tax_code": { + "explode": true, + "style": "deepObject" + }, + "tax_rates": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -82325,6 +92326,7 @@ "style": "form" }, { + "description": "Only return invoices that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -82534,7 +92536,7 @@ "object", "url" ], - "title": "InvoicesList", + "title": "InvoicesResourceList", "type": "object", "x-expandableFields": [ "data" @@ -82591,19 +92593,19 @@ "explode": true, "style": "deepObject" }, - "metadata": { + "issuer": { "explode": true, "style": "deepObject" }, - "payment_settings": { + "metadata": { "explode": true, "style": "deepObject" }, - "rendering": { + "payment_settings": { "explode": true, "style": "deepObject" }, - "rendering_options": { + "rendering": { "explode": true, "style": "deepObject" }, @@ -82655,6 +92657,28 @@ "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -82681,13 +92705,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -82755,6 +92779,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -82769,7 +92798,7 @@ "type": "string" } ], - "description": "The coupons 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." + "description": "The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts." }, "due_date": { "description": "The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.", @@ -82818,6 +92847,28 @@ "title": "from_invoice", "type": "object" }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, "metadata": { "anyOf": [ { @@ -82835,6 +92886,11 @@ ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, + "number": { + "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.", + "maxLength": 26, + "type": "string" + }, "on_behalf_of": { "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", "type": "string" @@ -82945,11 +93001,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -82960,12 +93016,11 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", @@ -82985,10 +93040,11 @@ "type": "object" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", - "automatic" + "automatic", + "challenge" ], "type": "string" } @@ -83068,6 +93124,22 @@ ], "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, "us_bank_account": { "anyOf": [ { @@ -83075,6 +93147,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -83095,6 +93185,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -83141,6 +93232,7 @@ "ach_credit_transfer", "ach_debit", "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -83155,13 +93247,16 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", "promptpay", + "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", + "swish", "us_bank_account", "wechat_pay" ], @@ -83184,13 +93279,13 @@ "type": "object" }, "pending_invoice_items_behavior": { - "description": "How to handle pending invoice items on invoice creation. One of `include` or `exclude`. `include` will include any pending invoice items, and will create an empty draft invoice if no pending invoice items exist. `exclude` will always create an empty invoice draft regardless if there are pending invoice items or not. Defaults to `exclude` if the parameter is omitted.", + "description": "How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.", "enum": [ "exclude", - "include", - "include_and_require" + "include" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "rendering": { "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.", @@ -83224,32 +93319,6 @@ "title": "rendering_param", "type": "object" }, - "rendering_options": { - "anyOf": [ - { - "properties": { - "amount_tax_display": { - "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" - ], - "type": "string" - } - }, - "title": "rendering_options_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering." - }, "shipping_cost": { "description": "Settings for the cost of shipping for this invoice.", "properties": { @@ -83391,7 +93460,7 @@ "type": "string" }, "type": { - "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.", + "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], @@ -83535,6 +93604,1608 @@ } } }, + "/v1/invoices/create_preview": { + "post": { + "description": "

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

\n\n

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\n

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

\n\n

Note: 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": { + "encoding": { + "automatic_tax": { + "explode": true, + "style": "deepObject" + }, + "customer_details": { + "explode": true, + "style": "deepObject" + }, + "discounts": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_items": { + "explode": true, + "style": "deepObject" + }, + "issuer": { + "explode": true, + "style": "deepObject" + }, + "on_behalf_of": { + "explode": true, + "style": "deepObject" + }, + "schedule_details": { + "explode": true, + "style": "deepObject" + }, + "subscription_details": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "automatic_tax": { + "description": "Settings for automatic tax lookup for this invoice preview.", + "properties": { + "enabled": { + "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", + "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_param", + "type": "object" + }, + "coupon": { + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "maxLength": 5000, + "type": "string" + }, + "currency": { + "description": "The currency to preview this invoice in. Defaults to that of `customer` if not specified.", + "type": "string" + }, + "customer": { + "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", + "maxLength": 5000, + "type": "string" + }, + "customer_details": { + "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.", + "properties": { + "address": { + "anyOf": [ + { + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The customer's address." + }, + "shipping": { + "anyOf": [ + { + "properties": { + "address": { + "description": "Customer shipping address.", + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "optional_fields_address", + "type": "object" + }, + "name": { + "description": "Customer name.", + "maxLength": 5000, + "type": "string" + }, + "phone": { + "description": "Customer phone (including extension).", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "customer_shipping", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The customer's shipping information. Appears on invoices emailed to this customer." + }, + "tax": { + "description": "Tax details about the customer.", + "properties": { + "ip_address": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + } + }, + "title": "tax_param", + "type": "object" + }, + "tax_exempt": { + "description": "The customer's tax exemption. One of `none`, `exempt`, or `reverse`.", + "enum": [ + "", + "exempt", + "none", + "reverse" + ], + "type": "string" + }, + "tax_ids": { + "description": "The customer's tax IDs.", + "items": { + "properties": { + "type": { + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "enum": [ + "ad_nrt", + "ae_trn", + "ar_cuit", + "au_abn", + "au_arn", + "bg_uic", + "bh_vat", + "bo_tin", + "br_cnpj", + "br_cpf", + "ca_bn", + "ca_gst_hst", + "ca_pst_bc", + "ca_pst_mb", + "ca_pst_sk", + "ca_qst", + "ch_uid", + "ch_vat", + "cl_tin", + "cn_tin", + "co_nit", + "cr_tin", + "de_stn", + "do_rcn", + "ec_ruc", + "eg_tin", + "es_cif", + "eu_oss_vat", + "eu_vat", + "gb_vat", + "ge_vat", + "hk_br", + "hr_oib", + "hu_tin", + "id_npwp", + "il_vat", + "in_gst", + "is_vat", + "jp_cn", + "jp_rn", + "jp_trn", + "ke_pin", + "kr_brn", + "kz_bin", + "li_uid", + "mx_rfc", + "my_frp", + "my_itn", + "my_sst", + "ng_tin", + "no_vat", + "no_voec", + "nz_gst", + "om_vat", + "pe_ruc", + "ph_tin", + "ro_tin", + "rs_pib", + "ru_inn", + "ru_kpp", + "sa_vat", + "sg_gst", + "sg_uen", + "si_tin", + "sv_nit", + "th_vat", + "tr_tin", + "tw_vat", + "ua_vat", + "us_ein", + "uy_ruc", + "ve_rif", + "vn_tin", + "za_vat" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + }, + "value": { + "description": "Value of the tax ID.", + "type": "string" + } + }, + "required": [ + "type", + "value" + ], + "title": "data_params", + "type": "object" + }, + "type": "array" + } + }, + "title": "customer_details_param", + "type": "object" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_items": { + "description": "List of invoice items to add or update in the upcoming invoice preview.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of previewed invoice item.", + "type": "integer" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.", + "type": "string" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the invoice item in the preview." + }, + "invoiceitem": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the invoice item.", + "type": "integer" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "tax_code": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item." + }, + "unit_amount": { + "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "title": "invoice_item_preview_params", + "type": "object" + }, + "type": "array" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, + "on_behalf_of": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." + }, + "preview_mode": { + "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.", + "enum": [ + "next", + "recurring" + ], + "type": "string" + }, + "schedule": { + "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", + "maxLength": 5000, + "type": "string" + }, + "schedule_details": { + "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", + "properties": { + "end_behavior": { + "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" + ], + "type": "string" + }, + "phases": { + "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.", + "items": { + "properties": { + "add_invoice_items": { + "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": { + "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "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.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data_with_negative_amounts", + "type": "object" + }, + "quantity": { + "description": "Quantity for this item. Defaults to 1.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." + } + }, + "title": "add_invoice_item_entry", + "type": "object", + "x-stripeParam": { + "class_name": "AddInvoiceItem" + } + }, + "type": "array" + }, + "application_fee_percent": { + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. 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).", + "type": "number" + }, + "automatic_tax": { + "description": "Automatic tax settings for this phase.", + "properties": { + "enabled": { + "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", + "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_config", + "type": "object" + }, + "billing_cycle_anchor": { + "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://stripe.com/docs/billing/subscriptions/billing-cycle).", + "enum": [ + "automatic", + "phase_start" + ], + "type": "string" + }, + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "amount_gte": { + "description": "Monetary threshold that triggers the subscription to advance to a new billing period", + "type": "integer" + }, + "reset_billing_cycle_anchor": { + "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", + "type": "boolean" + } + }, + "title": "billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." + }, + "collection_method": { + "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", + "enum": [ + "charge_automatically", + "send_invoice" + ], + "type": "string" + }, + "coupon": { + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "maxLength": 5000, + "type": "string" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "default_payment_method": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." + }, + "description": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "end_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set." + }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "days_until_due": { + "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", + "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings", + "type": "object" + }, + "items": { + "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "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://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/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`.", + "type": "object" + }, + "plan": { + "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The ID of the price object.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "description": "The recurring components of a price such as `interval` and `interval_count`.", + "properties": { + "interval": { + "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." + } + }, + "title": "configuration_item_params", + "type": "object" + }, + "type": "array" + }, + "iterations": { + "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.", + "type": "integer" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, 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`.", + "type": "object" + }, + "on_behalf_of": { + "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", + "type": "string" + }, + "proration_behavior": { + "description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "start_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase." + }, + "transfer_data": { + "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", + "properties": { + "amount_percent": { + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", + "type": "number" + }, + "destination": { + "description": "ID of an existing, connected Stripe account.", + "type": "string" + } + }, + "required": [ + "destination" + ], + "title": "transfer_data_specs", + "type": "object" + }, + "trial": { + "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", + "type": "boolean" + }, + "trial_end": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "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`" + } + }, + "required": [ + "items" + ], + "title": "phase_configuration_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "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" + ], + "type": "string" + } + }, + "title": "schedule_details_params", + "type": "object" + }, + "subscription": { + "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_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.", + "maxLength": 5000, + "type": "string" + }, + "subscription_details": { + "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", + "properties": { + "billing_cycle_anchor": { + "anyOf": [ + { + "enum": [ + "now", + "unchanged" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`." + }, + "cancel_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." + }, + "cancel_at_period_end": { + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", + "type": "boolean" + }, + "cancel_now": { + "description": "This simulates the subscription being canceled or expired immediately.", + "type": "boolean" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "items": { + "description": "A list of up to 20 subscription items, each with an attached price.", + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "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://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "clear_usage": { + "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "type": "boolean" + }, + "deleted": { + "description": "A flag that, if set to `true`, will delete the specified item.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "id": { + "description": "Subscription item to update.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "plan": { + "description": "Plan ID for this item, as a string.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "description": "The recurring components of a price such as `interval` and `interval_count`.", + "properties": { + "interval": { + "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "description": "Quantity for this item.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." + } + }, + "title": "subscription_item_update_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "description": "If 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", + "type": "integer" + }, + "resume_at": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "start_date": { + "description": "Date a subscription is intended to start (can be future or past).", + "format": "unix-time", + "type": "integer" + }, + "trial_end": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "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." + } + }, + "title": "subscription_details_params", + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/invoices/search": { "get": { "description": "

Search for invoices you’ve previously created using Stripe’s Search Query Language.\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.

", @@ -83670,7 +95341,7 @@ }, "/v1/invoices/upcoming": { "get": { - "description": "

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

\n\n

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\n

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

", + "description": "

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

\n\n

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\n

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

\n\n

Note: 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": "GetInvoicesUpcoming", "parameters": [ { @@ -83684,6 +95355,28 @@ "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -83695,7 +95388,7 @@ "style": "deepObject" }, { - "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "in": "query", "name": "coupon", "required": false, @@ -83885,7 +95578,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -83893,6 +95586,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -83902,11 +95596,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -83916,6 +95612,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -83926,13 +95623,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -83979,7 +95680,7 @@ "style": "deepObject" }, { - "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.", + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", "explode": true, "in": "query", "name": "discounts", @@ -83998,6 +95699,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -84070,183 +95776,878 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the invoice item in the preview." + }, + "invoiceitem": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the invoice item.", + "type": "integer" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "tax_code": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item." + }, + "unit_amount": { + "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "title": "invoice_item_preview_params", + "type": "object" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "explode": true, + "in": "query", + "name": "issuer", + "required": false, + "schema": { + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", + "explode": true, + "in": "query", + "name": "on_behalf_of", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "style": "deepObject" + }, + { + "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.", + "in": "query", + "name": "preview_mode", + "required": false, + "schema": { + "enum": [ + "next", + "recurring" + ], + "type": "string" + }, + "style": "form" + }, + { + "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", + "in": "query", + "name": "schedule", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", + "explode": true, + "in": "query", + "name": "schedule_details", + "required": false, + "schema": { + "properties": { + "end_behavior": { + "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" + ], + "type": "string" + }, + "phases": { + "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.", + "items": { + "properties": { + "add_invoice_items": { + "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": { + "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "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.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data_with_negative_amounts", + "type": "object" + }, + "quantity": { + "description": "Quantity for this item. Defaults to 1.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." + } + }, + "title": "add_invoice_item_entry", + "type": "object", + "x-stripeParam": { + "class_name": "AddInvoiceItem" + } + }, + "type": "array" + }, + "application_fee_percent": { + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. 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).", + "type": "number" + }, + "automatic_tax": { + "description": "Automatic tax settings for this phase.", + "properties": { + "enabled": { + "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", + "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_config", + "type": "object" + }, + "billing_cycle_anchor": { + "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://stripe.com/docs/billing/subscriptions/billing-cycle).", + "enum": [ + "automatic", + "phase_start" + ], + "type": "string" + }, + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "amount_gte": { + "description": "Monetary threshold that triggers the subscription to advance to a new billing period", + "type": "integer" + }, + "reset_billing_cycle_anchor": { + "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", + "type": "boolean" + } + }, + "title": "billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." + }, + "collection_method": { + "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", + "enum": [ + "charge_automatically", + "send_invoice" + ], + "type": "string" + }, + "coupon": { + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "maxLength": 5000, + "type": "string" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "default_payment_method": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." + }, + "description": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "end_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set." + }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "days_until_due": { + "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", + "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings", + "type": "object" + }, + "items": { + "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "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://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/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`.", + "type": "object" + }, + "plan": { + "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The ID of the price object.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "description": "The recurring components of a price such as `interval` and `interval_count`.", + "properties": { + "interval": { + "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." } }, - "title": "discounts_data_param", + "title": "configuration_item_params", "type": "object" }, "type": "array" }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The coupons to redeem into discounts for the invoice item in the preview." - }, - "invoiceitem": { - "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.", - "maxLength": 5000, - "type": "string" - }, - "metadata": { - "anyOf": [ - { + "iterations": { + "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.", + "type": "integer" + }, + "metadata": { "additionalProperties": { "type": "string" }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, 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`.", "type": "object" }, - { - "enum": [ - "" - ], + "on_behalf_of": { + "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", "type": "string" - } - ], - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." - }, - "period": { - "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", - "properties": { - "end": { - "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", - "format": "unix-time", - "type": "integer" }, - "start": { - "description": "The start of the period. This value is inclusive.", - "format": "unix-time", - "type": "integer" - } - }, - "required": [ - "end", - "start" - ], - "title": "period", - "type": "object" - }, - "price": { - "description": "The ID of the price object.", - "maxLength": 5000, - "type": "string" - }, - "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", - "properties": { - "currency": { - "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).", + "proration_behavior": { + "description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], "type": "string" }, - "product": { - "description": "The ID of the product that this price will belong to.", - "maxLength": 5000, - "type": "string" + "start_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase." }, - "tax_behavior": { - "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", - "enum": [ - "exclusive", - "inclusive", - "unspecified" + "transfer_data": { + "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", + "properties": { + "amount_percent": { + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", + "type": "number" + }, + "destination": { + "description": "ID of an existing, connected Stripe account.", + "type": "string" + } + }, + "required": [ + "destination" ], - "type": "string" + "title": "transfer_data_specs", + "type": "object" }, - "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", - "type": "integer" + "trial": { + "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", + "type": "boolean" }, - "unit_amount_decimal": { - "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", - "format": "decimal", - "type": "string" + "trial_end": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "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`" } }, "required": [ - "currency", - "product" + "items" ], - "title": "one_time_price_data", + "title": "phase_configuration_params", "type": "object" }, - "quantity": { - "description": "Non-negative integer. The quantity of units for the invoice item.", - "type": "integer" - }, - "tax_behavior": { - "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", - "enum": [ - "exclusive", - "inclusive", - "unspecified" - ], - "type": "string" - }, - "tax_code": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." - }, - "tax_rates": { - "anyOf": [ - { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item." - }, - "unit_amount": { - "description": "The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.", - "type": "integer" - }, - "unit_amount_decimal": { - "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", - "format": "decimal", - "type": "string" - } + "type": "array" }, - "title": "invoice_item_preview_params", - "type": "object" + "proration_behavior": { + "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" + ], + "type": "string" + } }, - "type": "array" + "title": "schedule_details_params", + "type": "object" }, "style": "deepObject" }, { - "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", - "in": "query", - "name": "schedule", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", + "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.", "in": "query", "name": "subscription", "required": false, @@ -84257,7 +96658,7 @@ "style": "form" }, { - "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.", + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.", "explode": true, "in": "query", "name": "subscription_billing_cycle_anchor", @@ -84281,7 +96682,7 @@ "style": "deepObject" }, { - "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", + "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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.", "explode": true, "in": "query", "name": "subscription_cancel_at", @@ -84303,7 +96704,7 @@ "style": "deepObject" }, { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", "in": "query", "name": "subscription_cancel_at_period_end", "required": false, @@ -84313,7 +96714,7 @@ "style": "form" }, { - "description": "This simulates the subscription being canceled or expired immediately.", + "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.", "in": "query", "name": "subscription_cancel_now", "required": false, @@ -84323,7 +96724,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.", + "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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.", "explode": true, "in": "query", "name": "subscription_default_tax_rates", @@ -84348,7 +96749,316 @@ "style": "deepObject" }, { - "description": "A list of up to 20 subscription items, each with an attached price.", + "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", + "explode": true, + "in": "query", + "name": "subscription_details", + "required": false, + "schema": { + "properties": { + "billing_cycle_anchor": { + "anyOf": [ + { + "enum": [ + "now", + "unchanged" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`." + }, + "cancel_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." + }, + "cancel_at_period_end": { + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", + "type": "boolean" + }, + "cancel_now": { + "description": "This simulates the subscription being canceled or expired immediately.", + "type": "boolean" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "items": { + "description": "A list of up to 20 subscription items, each with an attached price.", + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "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://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "clear_usage": { + "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "type": "boolean" + }, + "deleted": { + "description": "A flag that, if set to `true`, will delete the specified item.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "id": { + "description": "Subscription item to update.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "plan": { + "description": "Plan ID for this item, as a string.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "description": "The recurring components of a price such as `interval` and `interval_count`.", + "properties": { + "interval": { + "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "description": "Quantity for this item.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." + } + }, + "title": "subscription_item_update_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "description": "If 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", + "type": "integer" + }, + "resume_at": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "start_date": { + "description": "Date a subscription is intended to start (can be future or past).", + "format": "unix-time", + "type": "integer" + }, + "trial_end": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "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." + } + }, + "title": "subscription_details_params", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.", "explode": true, "in": "query", "name": "subscription_items", @@ -84388,6 +97098,41 @@ "description": "A flag that, if set to `true`, will delete the specified item.", "type": "boolean" }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "id": { "description": "Subscription item to update.", "maxLength": 5000, @@ -84416,12 +97161,12 @@ "type": "string" }, "price": { - "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -84446,7 +97191,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -84514,7 +97259,7 @@ "style": "deepObject" }, { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.", "in": "query", "name": "subscription_proration_behavior", "required": false, @@ -84529,7 +97274,7 @@ "style": "form" }, { - "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'.", + "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.", "in": "query", "name": "subscription_proration_date", "required": false, @@ -84540,7 +97285,7 @@ "style": "form" }, { - "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.", + "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.", "in": "query", "name": "subscription_resume_at", "required": false, @@ -84554,7 +97299,7 @@ "style": "form" }, { - "description": "Date a subscription is intended to start (can be future or past).", + "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.", "in": "query", "name": "subscription_start_date", "required": false, @@ -84565,7 +97310,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required.", + "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.", "explode": true, "in": "query", "name": "subscription_trial_end", @@ -84651,6 +97396,28 @@ "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -84662,7 +97429,7 @@ "style": "deepObject" }, { - "description": "The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "in": "query", "name": "coupon", "required": false, @@ -84852,7 +97619,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -84860,6 +97627,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -84869,11 +97637,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -84883,6 +97653,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -84893,13 +97664,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -84946,7 +97721,7 @@ "style": "deepObject" }, { - "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.", + "description": "The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.", "explode": true, "in": "query", "name": "discounts", @@ -84965,6 +97740,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -85048,6 +97828,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -85108,12 +97893,12 @@ "type": "object" }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -85212,6 +97997,35 @@ }, "style": "deepObject" }, + { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "explode": true, + "in": "query", + "name": "issuer", + "required": false, + "schema": { + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, + "style": "deepObject" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "in": "query", @@ -85222,6 +98036,41 @@ }, "style": "form" }, + { + "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.", + "explode": true, + "in": "query", + "name": "on_behalf_of", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "style": "deepObject" + }, + { + "description": "Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.", + "in": "query", + "name": "preview_mode", + "required": false, + "schema": { + "enum": [ + "next", + "recurring" + ], + "type": "string" + }, + "style": "form" + }, { "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.", "in": "query", @@ -85233,6 +98082,632 @@ }, "style": "form" }, + { + "description": "The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.", + "explode": true, + "in": "query", + "name": "schedule_details", + "required": false, + "schema": { + "properties": { + "end_behavior": { + "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" + ], + "type": "string" + }, + "phases": { + "description": "List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.", + "items": { + "properties": { + "add_invoice_items": { + "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": { + "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "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.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product" + ], + "title": "one_time_price_data_with_negative_amounts", + "type": "object" + }, + "quantity": { + "description": "Quantity for this item. Defaults to 1.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item." + } + }, + "title": "add_invoice_item_entry", + "type": "object", + "x-stripeParam": { + "class_name": "AddInvoiceItem" + } + }, + "type": "array" + }, + "application_fee_percent": { + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. 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).", + "type": "number" + }, + "automatic_tax": { + "description": "Automatic tax settings for this phase.", + "properties": { + "enabled": { + "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", + "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "required": [ + "enabled" + ], + "title": "automatic_tax_config", + "type": "object" + }, + "billing_cycle_anchor": { + "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://stripe.com/docs/billing/subscriptions/billing-cycle).", + "enum": [ + "automatic", + "phase_start" + ], + "type": "string" + }, + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "amount_gte": { + "description": "Monetary threshold that triggers the subscription to advance to a new billing period", + "type": "integer" + }, + "reset_billing_cycle_anchor": { + "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.", + "type": "boolean" + } + }, + "title": "billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds." + }, + "collection_method": { + "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.", + "enum": [ + "charge_automatically", + "send_invoice" + ], + "type": "string" + }, + "coupon": { + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", + "maxLength": 5000, + "type": "string" + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "default_payment_method": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase." + }, + "description": { + "anyOf": [ + { + "maxLength": 500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "end_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set." + }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "days_until_due": { + "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", + "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings", + "type": "object" + }, + "items": { + "description": "List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.", + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "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://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/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`.", + "type": "object" + }, + "plan": { + "description": "The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The ID of the price object.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "description": "The recurring components of a price such as `interval` and `interval_count`.", + "properties": { + "interval": { + "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "description": "Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." + } + }, + "title": "configuration_item_params", + "type": "object" + }, + "type": "array" + }, + "iterations": { + "description": "Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.", + "type": "integer" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, 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`.", + "type": "object" + }, + "on_behalf_of": { + "description": "The account on behalf of which to charge, for each of the associated subscription's invoices.", + "type": "string" + }, + "proration_behavior": { + "description": "Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "start_date": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "description": "The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase." + }, + "transfer_data": { + "description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.", + "properties": { + "amount_percent": { + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.", + "type": "number" + }, + "destination": { + "description": "ID of an existing, connected Stripe account.", + "type": "string" + } + }, + "required": [ + "destination" + ], + "title": "transfer_data_specs", + "type": "object" + }, + "trial": { + "description": "If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.", + "type": "boolean" + }, + "trial_end": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + } + ], + "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`" + } + }, + "required": [ + "items" + ], + "title": "phase_configuration_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "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" + ], + "type": "string" + } + }, + "title": "schedule_details_params", + "type": "object" + }, + "style": "deepObject" + }, { "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", "in": "query", @@ -85245,7 +98720,7 @@ "style": "form" }, { - "description": "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.", + "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.", "in": "query", "name": "subscription", "required": false, @@ -85256,7 +98731,7 @@ "style": "form" }, { - "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.", + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.", "explode": true, "in": "query", "name": "subscription_billing_cycle_anchor", @@ -85280,7 +98755,7 @@ "style": "deepObject" }, { - "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.", + "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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.", "explode": true, "in": "query", "name": "subscription_cancel_at", @@ -85302,7 +98777,7 @@ "style": "deepObject" }, { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", "in": "query", "name": "subscription_cancel_at_period_end", "required": false, @@ -85312,7 +98787,7 @@ "style": "form" }, { - "description": "This simulates the subscription being canceled or expired immediately.", + "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.", "in": "query", "name": "subscription_cancel_now", "required": false, @@ -85322,7 +98797,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.", + "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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.", "explode": true, "in": "query", "name": "subscription_default_tax_rates", @@ -85347,7 +98822,316 @@ "style": "deepObject" }, { - "description": "A list of up to 20 subscription items, each with an attached price.", + "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", + "explode": true, + "in": "query", + "name": "subscription_details", + "required": false, + "schema": { + "properties": { + "billing_cycle_anchor": { + "anyOf": [ + { + "enum": [ + "now", + "unchanged" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`." + }, + "cancel_at": { + "anyOf": [ + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." + }, + "cancel_at_period_end": { + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", + "type": "boolean" + }, + "cancel_now": { + "description": "This simulates the subscription being canceled or expired immediately.", + "type": "boolean" + }, + "default_tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, + "items": { + "description": "A list of up to 20 subscription items, each with an attached price.", + "items": { + "properties": { + "billing_thresholds": { + "anyOf": [ + { + "properties": { + "usage_gte": { + "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://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", + "type": "integer" + } + }, + "required": [ + "usage_gte" + ], + "title": "item_billing_thresholds_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." + }, + "clear_usage": { + "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", + "type": "boolean" + }, + "deleted": { + "description": "A flag that, if set to `true`, will delete the specified item.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, + "id": { + "description": "Subscription item to update.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "plan": { + "description": "Plan ID for this item, as a string.", + "maxLength": 5000, + "type": "string" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to.", + "maxLength": 5000, + "type": "string" + }, + "recurring": { + "description": "The recurring components of a price such as `interval` and `interval_count`.", + "properties": { + "interval": { + "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", + "enum": [ + "day", + "month", + "week", + "year" + ], + "type": "string" + }, + "interval_count": { + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", + "type": "integer" + } + }, + "required": [ + "interval" + ], + "title": "recurring_adhoc", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency", + "product", + "recurring" + ], + "title": "recurring_price_data", + "type": "object" + }, + "quantity": { + "description": "Quantity for this item.", + "type": "integer" + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." + } + }, + "title": "subscription_item_update_params", + "type": "object" + }, + "type": "array" + }, + "proration_behavior": { + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", + "enum": [ + "always_invoice", + "create_prorations", + "none" + ], + "type": "string" + }, + "proration_date": { + "description": "If 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", + "type": "integer" + }, + "resume_at": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "start_date": { + "description": "Date a subscription is intended to start (can be future or past).", + "format": "unix-time", + "type": "integer" + }, + "trial_end": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "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." + } + }, + "title": "subscription_details_params", + "type": "object" + }, + "style": "deepObject" + }, + { + "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.", "explode": true, "in": "query", "name": "subscription_items", @@ -85387,6 +99171,41 @@ "description": "A flag that, if set to `true`, will delete the specified item.", "type": "boolean" }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "id": { "description": "Subscription item to update.", "maxLength": 5000, @@ -85415,12 +99234,12 @@ "type": "string" }, "price": { - "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -85445,7 +99264,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -85513,7 +99332,7 @@ "style": "deepObject" }, { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.", "in": "query", "name": "subscription_proration_behavior", "required": false, @@ -85528,7 +99347,7 @@ "style": "form" }, { - "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'.", + "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.", "in": "query", "name": "subscription_proration_date", "required": false, @@ -85539,7 +99358,7 @@ "style": "form" }, { - "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.", + "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.", "in": "query", "name": "subscription_resume_at", "required": false, @@ -85553,7 +99372,7 @@ "style": "form" }, { - "description": "Date a subscription is intended to start (can be future or past).", + "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.", "in": "query", "name": "subscription_start_date", "required": false, @@ -85564,7 +99383,7 @@ "style": "form" }, { - "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required.", + "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.", "explode": true, "in": "query", "name": "subscription_trial_end", @@ -85839,23 +99658,27 @@ "explode": true, "style": "deepObject" }, + "issuer": { + "explode": true, + "style": "deepObject" + }, "metadata": { "explode": true, "style": "deepObject" }, - "on_behalf_of": { + "number": { "explode": true, "style": "deepObject" }, - "payment_settings": { + "on_behalf_of": { "explode": true, "style": "deepObject" }, - "rendering": { + "payment_settings": { "explode": true, "style": "deepObject" }, - "rendering_options": { + "rendering": { "explode": true, "style": "deepObject" }, @@ -85907,6 +99730,28 @@ "enabled": { "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -85929,13 +99774,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -86018,6 +99863,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -86067,6 +99917,28 @@ "maxLength": 5000, "type": "string" }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, "metadata": { "anyOf": [ { @@ -86084,6 +99956,21 @@ ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, + "number": { + "anyOf": [ + { + "maxLength": 26, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically." + }, "on_behalf_of": { "anyOf": [ { @@ -86204,11 +100091,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -86219,12 +100106,11 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", @@ -86244,10 +100130,11 @@ "type": "object" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", - "automatic" + "automatic", + "challenge" ], "type": "string" } @@ -86327,6 +100214,22 @@ ], "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, "us_bank_account": { "anyOf": [ { @@ -86334,6 +100237,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -86354,6 +100275,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -86400,6 +100322,7 @@ "ach_credit_transfer", "ach_debit", "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -86414,13 +100337,16 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", "promptpay", + "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", + "swish", "us_bank_account", "wechat_pay" ], @@ -86474,32 +100400,6 @@ "title": "rendering_param", "type": "object" }, - "rendering_options": { - "anyOf": [ - { - "properties": { - "amount_tax_display": { - "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" - ], - "type": "string" - } - }, - "title": "rendering_options_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering." - }, "shipping_cost": { "anyOf": [ { @@ -86642,7 +100542,7 @@ "type": "string" }, "type": { - "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.", + "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], @@ -86810,6 +100710,402 @@ } } }, + "/v1/invoices/{invoice}/add_lines": { + "post": { + "description": "

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

", + "operationId": "PostInvoicesInvoiceAddLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to add.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "invoice_item": { + "description": "ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "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.", + "maxLength": 40000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "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.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency" + ], + "title": "one_time_price_data_with_product_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "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.", + "properties": { + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "description": { + "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", + "maxLength": 5000, + "type": "string" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 200, + "type": "string" + }, + "percentage": { + "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.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "title": "lines_data_param", + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/invoices/{invoice}/finalize": { "post": { "description": "

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

", @@ -87108,6 +101404,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -87122,7 +101423,7 @@ "type": "string" } ], - "description": "The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined 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." }, "expand": { "description": "Specifies which fields in the response should be expanded.", @@ -87147,7 +101448,7 @@ "type": "string" } ], - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/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." }, "period": { "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", @@ -87171,12 +101472,12 @@ "type": "object" }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -87288,7 +101589,7 @@ }, "jurisdiction": { "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", - "maxLength": 50, + "maxLength": 200, "type": "string" }, "percentage": { @@ -87314,10 +101615,10 @@ "qst", "rst", "sales_tax", - "service_tax", "vat" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -87576,10 +101877,199 @@ } } }, - "/v1/invoices/{invoice}/send": { + "/v1/invoices/{invoice}/remove_lines": { + "post": { + "description": "

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

", + "operationId": "PostInvoicesInvoiceRemoveLines", + "parameters": [ + { + "in": "path", + "name": "invoice", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." + }, + "lines": { + "description": "The line items to remove.", + "items": { + "properties": { + "behavior": { + "description": "Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.", + "enum": [ + "delete", + "unassign" + ], + "type": "string" + }, + "id": { + "description": "ID of an existing line item to remove from this invoice.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "behavior", + "id" + ], + "title": "lines_data_param", + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "lines" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/invoice" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/invoices/{invoice}/send": { + "post": { + "description": "

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

\n\n

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

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

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

\n\n

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

", - "operationId": "PostInvoicesInvoiceSend", + "description": "

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

", + "operationId": "PostInvoicesInvoiceUpdateLines", "parameters": [ { "in": "path", @@ -87599,6 +102089,14 @@ "expand": { "explode": true, "style": "deepObject" + }, + "invoice_metadata": { + "explode": true, + "style": "deepObject" + }, + "lines": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -87611,13 +102109,337 @@ "type": "string" }, "type": "array" + }, + "invoice_metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/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." + }, + "lines": { + "description": "The line items to update.", + "items": { + "properties": { + "amount": { + "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.", + "type": "integer" + }, + "description": { + "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.", + "maxLength": 5000, + "type": "string" + }, + "discountable": { + "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.", + "type": "boolean" + }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts." + }, + "id": { + "description": "ID of an existing line item on the invoice.", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://stripe.com/docs/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." + }, + "period": { + "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.", + "properties": { + "end": { + "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.", + "format": "unix-time", + "type": "integer" + }, + "start": { + "description": "The start of the period. This value is inclusive.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "end", + "start" + ], + "title": "period", + "type": "object" + }, + "price": { + "description": "The ID of the price object. One of `price` or `price_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "price_data": { + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "product": { + "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.", + "maxLength": 5000, + "type": "string" + }, + "product_data": { + "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.", + "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.", + "maxLength": 40000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "name": { + "description": "The product's name, meant to be displayable to the customer.", + "maxLength": 5000, + "type": "string" + }, + "tax_code": { + "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "product_data", + "type": "object" + }, + "tax_behavior": { + "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", + "enum": [ + "exclusive", + "inclusive", + "unspecified" + ], + "type": "string" + }, + "unit_amount": { + "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.", + "type": "integer" + }, + "unit_amount_decimal": { + "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", + "format": "decimal", + "type": "string" + } + }, + "required": [ + "currency" + ], + "title": "one_time_price_data_with_product_data", + "type": "object" + }, + "quantity": { + "description": "Non-negative integer. The quantity of units for the line item.", + "type": "integer" + }, + "tax_amounts": { + "anyOf": [ + { + "items": { + "properties": { + "amount": { + "description": "The amount, in cents (or local equivalent), of the tax.", + "type": "integer" + }, + "tax_rate_data": { + "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.", + "properties": { + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "description": { + "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", + "maxLength": 5000, + "type": "string" + }, + "display_name": { + "description": "The display name of the tax rate, which will be shown to users.", + "maxLength": 50, + "type": "string" + }, + "inclusive": { + "description": "This specifies if the tax rate is inclusive or exclusive.", + "type": "boolean" + }, + "jurisdiction": { + "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.", + "maxLength": 200, + "type": "string" + }, + "percentage": { + "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.", + "type": "number" + }, + "state": { + "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", + "maxLength": 2, + "type": "string" + }, + "tax_type": { + "description": "The high-level tax type, such as `vat` or `sales_tax`.", + "enum": [ + "amusement_tax", + "communications_tax", + "gst", + "hst", + "igst", + "jct", + "lease_tax", + "pst", + "qst", + "rst", + "sales_tax", + "vat" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "display_name", + "inclusive", + "percentage" + ], + "title": "tax_rate_data_param", + "type": "object" + }, + "taxable_amount": { + "description": "The amount on which tax is calculated, in cents (or local equivalent).", + "type": "integer" + } + }, + "required": [ + "amount", + "tax_rate_data", + "taxable_amount" + ], + "title": "tax_amount_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts." + }, + "tax_rates": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates." + } + }, + "required": [ + "id" + ], + "title": "lines_data_param", + "type": "object" + }, + "type": "array" } }, + "required": [ + "lines" + ], "type": "object" } } }, - "required": false + "required": true }, "responses": { "200": { @@ -87645,7 +102467,7 @@ }, "/v1/invoices/{invoice}/void": { "post": { - "description": "

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

", + "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\n

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

", "operationId": "PostInvoicesInvoiceVoid", "parameters": [ { @@ -88066,6 +102888,7 @@ }, "/v1/issuing/authorizations/{authorization}/approve": { "post": { + "deprecated": true, "description": "

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

", "operationId": "PostIssuingAuthorizationsAuthorizationApprove", "parameters": [ @@ -88158,6 +102981,7 @@ }, "/v1/issuing/authorizations/{authorization}/decline": { "post": { + "deprecated": true, "description": "

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

", "operationId": "PostIssuingAuthorizationsAuthorizationDecline", "parameters": [ @@ -89010,6 +103834,14 @@ }, "type": "array" }, + "allowed_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { @@ -89315,6 +104147,14 @@ }, "type": "array" }, + "blocked_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { @@ -90339,6 +105179,14 @@ }, "type": "array" }, + "allowed_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { @@ -90644,6 +105492,14 @@ }, "type": "array" }, + "blocked_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", "items": { @@ -91146,6 +106002,16 @@ }, "style": "form" }, + { + "in": "query", + "name": "personalization_design", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", "in": "query", @@ -91275,6 +106141,14 @@ "explode": true, "style": "deepObject" }, + "pin": { + "explode": true, + "style": "deepObject" + }, + "second_line": { + "explode": true, + "style": "deepObject" + }, "shipping": { "explode": true, "style": "deepObject" @@ -91314,6 +106188,23 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "personalization_design": { + "description": "The personalization design object belonging to this card.", + "maxLength": 5000, + "type": "string" + }, + "pin": { + "description": "The desired PIN for this card.", + "properties": { + "encrypted_number": { + "description": "The card's desired new PIN, encrypted under Stripe's public key.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "encrypted_pin_param", + "type": "object" + }, "replacement_for": { "description": "The card this is meant to be a replacement for (if any).", "maxLength": 5000, @@ -91330,6 +106221,21 @@ "type": "string", "x-stripeBypassValidation": true }, + "second_line": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The second line to print on the card." + }, "shipping": { "description": "The address where the card will be shipped.", "properties": { @@ -91376,6 +106282,25 @@ "title": "required_address", "type": "object" }, + "address_validation": { + "description": "Address validation settings.", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "title": "address_validation_param", + "type": "object" + }, "customs": { "description": "Customs information for the shipment.", "properties": { @@ -91735,306 +106660,322 @@ }, "type": "array" }, - "blocked_categories": { - "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", + "allowed_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "blocked_categories": { + "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", + "items": { + "enum": [ + "ac_refrigeration_repair", + "accounting_bookkeeping_services", + "advertising_services", + "agricultural_cooperative", + "airlines_air_carriers", + "airports_flying_fields", + "ambulance_services", + "amusement_parks_carnivals", + "antique_reproductions", + "antique_shops", + "aquariums", + "architectural_surveying_services", + "art_dealers_and_galleries", + "artists_supply_and_craft_shops", + "auto_and_home_supply_stores", + "auto_body_repair_shops", + "auto_paint_shops", + "auto_service_shops", + "automated_cash_disburse", + "automated_fuel_dispensers", + "automobile_associations", + "automotive_parts_and_accessories_stores", + "automotive_tire_stores", + "bail_and_bond_payments", + "bakeries", + "bands_orchestras", + "barber_and_beauty_shops", + "betting_casino_gambling", + "bicycle_shops", + "billiard_pool_establishments", + "boat_dealers", + "boat_rentals_and_leases", + "book_stores", + "books_periodicals_and_newspapers", + "bowling_alleys", + "bus_lines", + "business_secretarial_schools", + "buying_shopping_services", + "cable_satellite_and_other_pay_television_and_radio", + "camera_and_photographic_supply_stores", + "candy_nut_and_confectionery_stores", + "car_and_truck_dealers_new_used", + "car_and_truck_dealers_used_only", + "car_rental_agencies", + "car_washes", + "carpentry_services", + "carpet_upholstery_cleaning", + "caterers", + "charitable_and_social_service_organizations_fundraising", + "chemicals_and_allied_products", + "child_care_services", + "childrens_and_infants_wear_stores", + "chiropodists_podiatrists", + "chiropractors", + "cigar_stores_and_stands", + "civic_social_fraternal_associations", + "cleaning_and_maintenance", + "clothing_rental", + "colleges_universities", + "commercial_equipment", + "commercial_footwear", + "commercial_photography_art_and_graphics", + "commuter_transport_and_ferries", + "computer_network_services", + "computer_programming", + "computer_repair", + "computer_software_stores", + "computers_peripherals_and_software", + "concrete_work_services", + "construction_materials", + "consulting_public_relations", + "correspondence_schools", + "cosmetic_stores", + "counseling_services", + "country_clubs", + "courier_services", + "court_costs", + "credit_reporting_agencies", + "cruise_lines", + "dairy_products_stores", + "dance_hall_studios_schools", + "dating_escort_services", + "dentists_orthodontists", + "department_stores", + "detective_agencies", + "digital_goods_applications", + "digital_goods_games", + "digital_goods_large_volume", + "digital_goods_media", + "direct_marketing_catalog_merchant", + "direct_marketing_combination_catalog_and_retail_merchant", + "direct_marketing_inbound_telemarketing", + "direct_marketing_insurance_services", + "direct_marketing_other", + "direct_marketing_outbound_telemarketing", + "direct_marketing_subscription", + "direct_marketing_travel", + "discount_stores", + "doctors", + "door_to_door_sales", + "drapery_window_covering_and_upholstery_stores", + "drinking_places", + "drug_stores_and_pharmacies", + "drugs_drug_proprietaries_and_druggist_sundries", + "dry_cleaners", + "durable_goods", + "duty_free_stores", + "eating_places_restaurants", + "educational_services", + "electric_razor_stores", + "electric_vehicle_charging", + "electrical_parts_and_equipment", + "electrical_services", + "electronics_repair_shops", + "electronics_stores", + "elementary_secondary_schools", + "emergency_services_gcas_visa_use_only", + "employment_temp_agencies", + "equipment_rental", + "exterminating_services", + "family_clothing_stores", + "fast_food_restaurants", + "financial_institutions", + "fines_government_administrative_entities", + "fireplace_fireplace_screens_and_accessories_stores", + "floor_covering_stores", + "florists", + "florists_supplies_nursery_stock_and_flowers", + "freezer_and_locker_meat_provisioners", + "fuel_dealers_non_automotive", + "funeral_services_crematories", + "furniture_home_furnishings_and_equipment_stores_except_appliances", + "furniture_repair_refinishing", + "furriers_and_fur_shops", + "general_services", + "gift_card_novelty_and_souvenir_shops", + "glass_paint_and_wallpaper_stores", + "glassware_crystal_stores", + "golf_courses_public", + "government_licensed_horse_dog_racing_us_region_only", + "government_licensed_online_casions_online_gambling_us_region_only", + "government_owned_lotteries_non_us_region", + "government_owned_lotteries_us_region_only", + "government_services", + "grocery_stores_supermarkets", + "hardware_equipment_and_supplies", + "hardware_stores", + "health_and_beauty_spas", + "hearing_aids_sales_and_supplies", + "heating_plumbing_a_c", + "hobby_toy_and_game_shops", + "home_supply_warehouse_stores", + "hospitals", + "hotels_motels_and_resorts", + "household_appliance_stores", + "industrial_supplies", + "information_retrieval_services", + "insurance_default", + "insurance_underwriting_premiums", + "intra_company_purchases", + "jewelry_stores_watches_clocks_and_silverware_stores", + "landscaping_services", + "laundries", + "laundry_cleaning_services", + "legal_services_attorneys", + "luggage_and_leather_goods_stores", + "lumber_building_materials_stores", + "manual_cash_disburse", + "marinas_service_and_supplies", + "marketplaces", + "masonry_stonework_and_plaster", + "massage_parlors", + "medical_and_dental_labs", + "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", + "medical_services", + "membership_organizations", + "mens_and_boys_clothing_and_accessories_stores", + "mens_womens_clothing_stores", + "metal_service_centers", + "miscellaneous", + "miscellaneous_apparel_and_accessory_shops", + "miscellaneous_auto_dealers", + "miscellaneous_business_services", + "miscellaneous_food_stores", + "miscellaneous_general_merchandise", + "miscellaneous_general_services", + "miscellaneous_home_furnishing_specialty_stores", + "miscellaneous_publishing_and_printing", + "miscellaneous_recreation_services", + "miscellaneous_repair_shops", + "miscellaneous_specialty_retail", + "mobile_home_dealers", + "motion_picture_theaters", + "motor_freight_carriers_and_trucking", + "motor_homes_dealers", + "motor_vehicle_supplies_and_new_parts", + "motorcycle_shops_and_dealers", + "motorcycle_shops_dealers", + "music_stores_musical_instruments_pianos_and_sheet_music", + "news_dealers_and_newsstands", + "non_fi_money_orders", + "non_fi_stored_value_card_purchase_load", + "nondurable_goods", + "nurseries_lawn_and_garden_supply_stores", + "nursing_personal_care", + "office_and_commercial_furniture", + "opticians_eyeglasses", + "optometrists_ophthalmologist", + "orthopedic_goods_prosthetic_devices", + "osteopaths", + "package_stores_beer_wine_and_liquor", + "paints_varnishes_and_supplies", + "parking_lots_garages", + "passenger_railways", + "pawn_shops", + "pet_shops_pet_food_and_supplies", + "petroleum_and_petroleum_products", + "photo_developing", + "photographic_photocopy_microfilm_equipment_and_supplies", + "photographic_studios", + "picture_video_production", + "piece_goods_notions_and_other_dry_goods", + "plumbing_heating_equipment_and_supplies", + "political_organizations", + "postal_services_government_only", + "precious_stones_and_metals_watches_and_jewelry", + "professional_services", + "public_warehousing_and_storage", + "quick_copy_repro_and_blueprint", + "railroads", + "real_estate_agents_and_managers_rentals", + "record_stores", + "recreational_vehicle_rentals", + "religious_goods_stores", + "religious_organizations", + "roofing_siding_sheet_metal", + "secretarial_support_services", + "security_brokers_dealers", + "service_stations", + "sewing_needlework_fabric_and_piece_goods_stores", + "shoe_repair_hat_cleaning", + "shoe_stores", + "small_appliance_repair", + "snowmobile_dealers", + "special_trade_services", + "specialty_cleaning", + "sporting_goods_stores", + "sporting_recreation_camps", + "sports_and_riding_apparel_stores", + "sports_clubs_fields", + "stamp_and_coin_stores", + "stationary_office_supplies_printing_and_writing_paper", + "stationery_stores_office_and_school_supply_stores", + "swimming_pools_sales", + "t_ui_travel_germany", + "tailors_alterations", + "tax_payments_government_agencies", + "tax_preparation_services", + "taxicabs_limousines", + "telecommunication_equipment_and_telephone_sales", + "telecommunication_services", + "telegraph_services", + "tent_and_awning_shops", + "testing_laboratories", + "theatrical_ticket_agencies", + "timeshares", + "tire_retreading_and_repair", + "tolls_bridge_fees", + "tourist_attractions_and_exhibits", + "towing_services", + "trailer_parks_campgrounds", + "transportation_services", + "travel_agencies_tour_operators", + "truck_stop_iteration", + "truck_utility_trailer_rentals", + "typesetting_plate_making_and_related_services", + "typewriter_stores", + "u_s_federal_government_agencies_or_departments", + "uniforms_commercial_clothing", + "used_merchandise_and_secondhand_stores", + "utilities", + "variety_stores", + "veterinary_services", + "video_amusement_game_supplies", + "video_game_arcades", + "video_tape_rental_stores", + "vocational_trade_schools", + "watch_jewelry_repair", + "welding_repair", + "wholesale_clubs", + "wig_and_toupee_stores", + "wires_money_orders", + "womens_accessory_and_specialty_shops", + "womens_ready_to_wear_stores", + "wrecking_and_salvage_yards" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "blocked_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", "items": { - "enum": [ - "ac_refrigeration_repair", - "accounting_bookkeeping_services", - "advertising_services", - "agricultural_cooperative", - "airlines_air_carriers", - "airports_flying_fields", - "ambulance_services", - "amusement_parks_carnivals", - "antique_reproductions", - "antique_shops", - "aquariums", - "architectural_surveying_services", - "art_dealers_and_galleries", - "artists_supply_and_craft_shops", - "auto_and_home_supply_stores", - "auto_body_repair_shops", - "auto_paint_shops", - "auto_service_shops", - "automated_cash_disburse", - "automated_fuel_dispensers", - "automobile_associations", - "automotive_parts_and_accessories_stores", - "automotive_tire_stores", - "bail_and_bond_payments", - "bakeries", - "bands_orchestras", - "barber_and_beauty_shops", - "betting_casino_gambling", - "bicycle_shops", - "billiard_pool_establishments", - "boat_dealers", - "boat_rentals_and_leases", - "book_stores", - "books_periodicals_and_newspapers", - "bowling_alleys", - "bus_lines", - "business_secretarial_schools", - "buying_shopping_services", - "cable_satellite_and_other_pay_television_and_radio", - "camera_and_photographic_supply_stores", - "candy_nut_and_confectionery_stores", - "car_and_truck_dealers_new_used", - "car_and_truck_dealers_used_only", - "car_rental_agencies", - "car_washes", - "carpentry_services", - "carpet_upholstery_cleaning", - "caterers", - "charitable_and_social_service_organizations_fundraising", - "chemicals_and_allied_products", - "child_care_services", - "childrens_and_infants_wear_stores", - "chiropodists_podiatrists", - "chiropractors", - "cigar_stores_and_stands", - "civic_social_fraternal_associations", - "cleaning_and_maintenance", - "clothing_rental", - "colleges_universities", - "commercial_equipment", - "commercial_footwear", - "commercial_photography_art_and_graphics", - "commuter_transport_and_ferries", - "computer_network_services", - "computer_programming", - "computer_repair", - "computer_software_stores", - "computers_peripherals_and_software", - "concrete_work_services", - "construction_materials", - "consulting_public_relations", - "correspondence_schools", - "cosmetic_stores", - "counseling_services", - "country_clubs", - "courier_services", - "court_costs", - "credit_reporting_agencies", - "cruise_lines", - "dairy_products_stores", - "dance_hall_studios_schools", - "dating_escort_services", - "dentists_orthodontists", - "department_stores", - "detective_agencies", - "digital_goods_applications", - "digital_goods_games", - "digital_goods_large_volume", - "digital_goods_media", - "direct_marketing_catalog_merchant", - "direct_marketing_combination_catalog_and_retail_merchant", - "direct_marketing_inbound_telemarketing", - "direct_marketing_insurance_services", - "direct_marketing_other", - "direct_marketing_outbound_telemarketing", - "direct_marketing_subscription", - "direct_marketing_travel", - "discount_stores", - "doctors", - "door_to_door_sales", - "drapery_window_covering_and_upholstery_stores", - "drinking_places", - "drug_stores_and_pharmacies", - "drugs_drug_proprietaries_and_druggist_sundries", - "dry_cleaners", - "durable_goods", - "duty_free_stores", - "eating_places_restaurants", - "educational_services", - "electric_razor_stores", - "electric_vehicle_charging", - "electrical_parts_and_equipment", - "electrical_services", - "electronics_repair_shops", - "electronics_stores", - "elementary_secondary_schools", - "emergency_services_gcas_visa_use_only", - "employment_temp_agencies", - "equipment_rental", - "exterminating_services", - "family_clothing_stores", - "fast_food_restaurants", - "financial_institutions", - "fines_government_administrative_entities", - "fireplace_fireplace_screens_and_accessories_stores", - "floor_covering_stores", - "florists", - "florists_supplies_nursery_stock_and_flowers", - "freezer_and_locker_meat_provisioners", - "fuel_dealers_non_automotive", - "funeral_services_crematories", - "furniture_home_furnishings_and_equipment_stores_except_appliances", - "furniture_repair_refinishing", - "furriers_and_fur_shops", - "general_services", - "gift_card_novelty_and_souvenir_shops", - "glass_paint_and_wallpaper_stores", - "glassware_crystal_stores", - "golf_courses_public", - "government_licensed_horse_dog_racing_us_region_only", - "government_licensed_online_casions_online_gambling_us_region_only", - "government_owned_lotteries_non_us_region", - "government_owned_lotteries_us_region_only", - "government_services", - "grocery_stores_supermarkets", - "hardware_equipment_and_supplies", - "hardware_stores", - "health_and_beauty_spas", - "hearing_aids_sales_and_supplies", - "heating_plumbing_a_c", - "hobby_toy_and_game_shops", - "home_supply_warehouse_stores", - "hospitals", - "hotels_motels_and_resorts", - "household_appliance_stores", - "industrial_supplies", - "information_retrieval_services", - "insurance_default", - "insurance_underwriting_premiums", - "intra_company_purchases", - "jewelry_stores_watches_clocks_and_silverware_stores", - "landscaping_services", - "laundries", - "laundry_cleaning_services", - "legal_services_attorneys", - "luggage_and_leather_goods_stores", - "lumber_building_materials_stores", - "manual_cash_disburse", - "marinas_service_and_supplies", - "marketplaces", - "masonry_stonework_and_plaster", - "massage_parlors", - "medical_and_dental_labs", - "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", - "medical_services", - "membership_organizations", - "mens_and_boys_clothing_and_accessories_stores", - "mens_womens_clothing_stores", - "metal_service_centers", - "miscellaneous", - "miscellaneous_apparel_and_accessory_shops", - "miscellaneous_auto_dealers", - "miscellaneous_business_services", - "miscellaneous_food_stores", - "miscellaneous_general_merchandise", - "miscellaneous_general_services", - "miscellaneous_home_furnishing_specialty_stores", - "miscellaneous_publishing_and_printing", - "miscellaneous_recreation_services", - "miscellaneous_repair_shops", - "miscellaneous_specialty_retail", - "mobile_home_dealers", - "motion_picture_theaters", - "motor_freight_carriers_and_trucking", - "motor_homes_dealers", - "motor_vehicle_supplies_and_new_parts", - "motorcycle_shops_and_dealers", - "motorcycle_shops_dealers", - "music_stores_musical_instruments_pianos_and_sheet_music", - "news_dealers_and_newsstands", - "non_fi_money_orders", - "non_fi_stored_value_card_purchase_load", - "nondurable_goods", - "nurseries_lawn_and_garden_supply_stores", - "nursing_personal_care", - "office_and_commercial_furniture", - "opticians_eyeglasses", - "optometrists_ophthalmologist", - "orthopedic_goods_prosthetic_devices", - "osteopaths", - "package_stores_beer_wine_and_liquor", - "paints_varnishes_and_supplies", - "parking_lots_garages", - "passenger_railways", - "pawn_shops", - "pet_shops_pet_food_and_supplies", - "petroleum_and_petroleum_products", - "photo_developing", - "photographic_photocopy_microfilm_equipment_and_supplies", - "photographic_studios", - "picture_video_production", - "piece_goods_notions_and_other_dry_goods", - "plumbing_heating_equipment_and_supplies", - "political_organizations", - "postal_services_government_only", - "precious_stones_and_metals_watches_and_jewelry", - "professional_services", - "public_warehousing_and_storage", - "quick_copy_repro_and_blueprint", - "railroads", - "real_estate_agents_and_managers_rentals", - "record_stores", - "recreational_vehicle_rentals", - "religious_goods_stores", - "religious_organizations", - "roofing_siding_sheet_metal", - "secretarial_support_services", - "security_brokers_dealers", - "service_stations", - "sewing_needlework_fabric_and_piece_goods_stores", - "shoe_repair_hat_cleaning", - "shoe_stores", - "small_appliance_repair", - "snowmobile_dealers", - "special_trade_services", - "specialty_cleaning", - "sporting_goods_stores", - "sporting_recreation_camps", - "sports_and_riding_apparel_stores", - "sports_clubs_fields", - "stamp_and_coin_stores", - "stationary_office_supplies_printing_and_writing_paper", - "stationery_stores_office_and_school_supply_stores", - "swimming_pools_sales", - "t_ui_travel_germany", - "tailors_alterations", - "tax_payments_government_agencies", - "tax_preparation_services", - "taxicabs_limousines", - "telecommunication_equipment_and_telephone_sales", - "telecommunication_services", - "telegraph_services", - "tent_and_awning_shops", - "testing_laboratories", - "theatrical_ticket_agencies", - "timeshares", - "tire_retreading_and_repair", - "tolls_bridge_fees", - "tourist_attractions_and_exhibits", - "towing_services", - "trailer_parks_campgrounds", - "transportation_services", - "travel_agencies_tour_operators", - "truck_stop_iteration", - "truck_utility_trailer_rentals", - "typesetting_plate_making_and_related_services", - "typewriter_stores", - "u_s_federal_government_agencies_or_departments", - "uniforms_commercial_clothing", - "used_merchandise_and_secondhand_stores", - "utilities", - "variety_stores", - "veterinary_services", - "video_amusement_game_supplies", - "video_game_arcades", - "video_tape_rental_stores", - "vocational_trade_schools", - "watch_jewelry_repair", - "welding_repair", - "wholesale_clubs", - "wig_and_toupee_stores", - "wires_money_orders", - "womens_accessory_and_specialty_shops", - "womens_ready_to_wear_stores", - "wrecking_and_salvage_yards" - ], "maxLength": 5000, "type": "string" }, @@ -92528,6 +107469,10 @@ "explode": true, "style": "deepObject" }, + "shipping": { + "explode": true, + "style": "deepObject" + }, "spending_controls": { "explode": true, "style": "deepObject" @@ -92570,6 +107515,10 @@ ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, + "personalization_design": { + "maxLength": 5000, + "type": "string" + }, "pin": { "description": "The desired new PIN for this card.", "properties": { @@ -92582,6 +107531,122 @@ "title": "encrypted_pin_param", "type": "object" }, + "shipping": { + "description": "Updated shipping information for the card.", + "properties": { + "address": { + "description": "The address that the card is shipped to.", + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "city", + "country", + "line1", + "postal_code" + ], + "title": "required_address", + "type": "object" + }, + "address_validation": { + "description": "Address validation settings.", + "properties": { + "mode": { + "description": "The address validation capabilities to use.", + "enum": [ + "disabled", + "normalization_only", + "validation_and_normalization" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "title": "address_validation_param", + "type": "object" + }, + "customs": { + "description": "Customs information for the shipment.", + "properties": { + "eori_number": { + "description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "customs_param", + "type": "object" + }, + "name": { + "description": "The name printed on the shipping label when shipping the card.", + "maxLength": 5000, + "type": "string" + }, + "phone_number": { + "description": "Phone number of the recipient of the shipment.", + "type": "string" + }, + "require_signature": { + "description": "Whether a signature is required for card delivery.", + "type": "boolean" + }, + "service": { + "description": "Shipment service.", + "enum": [ + "express", + "priority", + "standard" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "type": { + "description": "Packaging options.", + "enum": [ + "bulk", + "individual" + ], + "type": "string" + } + }, + "required": [ + "address", + "name" + ], + "title": "shipping_specs", + "type": "object" + }, "spending_controls": { "description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.", "properties": { @@ -92890,6 +107955,14 @@ }, "type": "array" }, + "allowed_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "blocked_categories": { "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", "items": { @@ -93195,6 +108268,14 @@ }, "type": "array" }, + "blocked_merchant_countries": { + "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "spending_limits": { "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", "items": { @@ -93581,7 +108662,7 @@ "operationId": "GetIssuingDisputes", "parameters": [ { - "description": "Select Issuing disputes that were created during the given date interval.", + "description": "Only return Issuing disputes that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -93849,7 +108930,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -93879,7 +108960,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -93894,7 +108975,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94015,7 +109096,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94066,7 +109147,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94112,7 +109193,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94142,7 +109223,7 @@ "return_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94191,6 +109272,52 @@ ], "description": "Evidence provided when `reason` is 'merchandise_not_as_described'." }, + "no_valid_authorization": { + "anyOf": [ + { + "properties": { + "additional_documentation": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." + }, + "explanation": { + "anyOf": [ + { + "maxLength": 2500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Explanation of why the cardholder is disputing this transaction." + } + }, + "title": "no_valid_authorization", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Evidence provided when `reason` is 'no_valid_authorization'." + }, "not_received": { "anyOf": [ { @@ -94227,7 +109354,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94242,7 +109369,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94297,7 +109424,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94312,7 +109439,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94353,6 +109480,7 @@ "duplicate", "fraudulent", "merchandise_not_as_described", + "no_valid_authorization", "not_received", "other", "service_not_as_described" @@ -94396,7 +109524,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94411,7 +109539,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94680,7 +109808,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94710,7 +109838,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94725,7 +109853,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94846,7 +109974,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94897,7 +110025,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94943,7 +110071,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -94973,7 +110101,7 @@ "return_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95022,6 +110150,52 @@ ], "description": "Evidence provided when `reason` is 'merchandise_not_as_described'." }, + "no_valid_authorization": { + "anyOf": [ + { + "properties": { + "additional_documentation": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." + }, + "explanation": { + "anyOf": [ + { + "maxLength": 2500, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Explanation of why the cardholder is disputing this transaction." + } + }, + "title": "no_valid_authorization", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Evidence provided when `reason` is 'no_valid_authorization'." + }, "not_received": { "anyOf": [ { @@ -95058,7 +110232,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95073,7 +110247,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95128,7 +110302,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95143,7 +110317,7 @@ "product_description": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95184,6 +110358,7 @@ "duplicate", "fraudulent", "merchandise_not_as_described", + "no_valid_authorization", "not_received", "other", "service_not_as_described" @@ -95227,7 +110402,7 @@ "cancellation_reason": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95242,7 +110417,7 @@ "explanation": { "anyOf": [ { - "maxLength": 1500, + "maxLength": 2500, "type": "string" }, { @@ -95342,14 +110517,526 @@ } } }, - "/v1/issuing/disputes/{dispute}/submit": { + "/v1/issuing/disputes/{dispute}/submit": { + "post": { + "description": "

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

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

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

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

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

", - "operationId": "PostIssuingDisputesDisputeSubmit", + "description": "

Creates a personalization design object.

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

Retrieves a personalization design object.

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

Updates a card personalization object.

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

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

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

Retrieves a physical bundle object.

", + "operationId": "GetIssuingPhysicalBundlesPhysicalBundle", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "physical_bundle", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.physical_bundle" } } }, @@ -95447,7 +111511,7 @@ "style": "form" }, { - "description": "Select Issuing tokens that were created during the given date interval.", + "description": "Only return Issuing tokens that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -96452,7 +112516,7 @@ "type": "string" }, "confirm": { - "description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).", + "description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).", "type": "boolean" }, "confirmation_method": { @@ -96463,12 +112527,17 @@ ], "type": "string" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\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.", + "maxLength": 5000, + "type": "string" + }, "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", "type": "string" }, "customer": { - "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.", + "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "maxLength": 5000, "type": "string" }, @@ -96649,6 +112718,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -96941,6 +113025,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -97012,6 +113097,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -97048,6 +113145,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -97090,7 +113188,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -97136,6 +113234,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -97143,6 +113253,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -97158,6 +113269,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -97167,6 +113280,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -97282,7 +113397,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97319,7 +113434,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -97332,7 +113447,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -97356,7 +113471,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -97369,7 +113484,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -97394,7 +113509,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97415,12 +113530,46 @@ ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, + "amazon_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." + }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97446,8 +113595,14 @@ "anyOf": [ { "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97457,7 +113612,7 @@ "type": "string" } }, - "title": "payment_method_options_param", + "title": "payment_intent_payment_method_options_param", "type": "object" }, { @@ -97484,7 +113639,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97513,6 +113668,15 @@ "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", "maxLength": 5000, "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", @@ -97536,7 +113700,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97563,7 +113727,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -97587,11 +113751,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -97602,12 +113766,11 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", @@ -97709,6 +113872,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -97729,7 +113893,7 @@ "type": "string" }, "request_incremental_authorization": { - "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", + "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" @@ -97753,7 +113917,7 @@ "type": "string" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -97762,8 +113926,12 @@ "type": "string", "x-stripeBypassValidation": true }, + "require_cvc_recollection": { + "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", + "type": "boolean" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -97934,6 +114102,21 @@ "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" + }, + "routing": { + "description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.", + "properties": { + "requested_priority": { + "description": "Routing requested priority", + "enum": [ + "domestic", + "international" + ], + "type": "string" + } + }, + "title": "routing_payment_method_options_param", + "type": "object" } }, "title": "payment_method_options_param", @@ -97953,7 +114136,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -97961,7 +114144,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -98049,7 +114232,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98073,7 +114256,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98097,7 +114280,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98121,7 +114304,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98145,7 +114328,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98169,7 +114352,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -98211,7 +114394,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -98247,6 +114430,7 @@ "en-NZ", "en-PL", "en-PT", + "en-RO", "en-SE", "en-US", "es-ES", @@ -98263,6 +114447,7 @@ "nl-NL", "pl-PL", "pt-PT", + "ro-RO", "sv-FI", "sv-SE" ], @@ -98270,7 +114455,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98354,7 +114539,7 @@ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98378,7 +114563,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -98391,7 +114576,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -98412,6 +114597,62 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." + }, + "multibanco": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." + }, "oxxo": { "anyOf": [ { @@ -98421,7 +114662,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98445,7 +114686,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98473,7 +114714,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98543,7 +114784,98 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options." + }, + "pix": { + "anyOf": [ + { + "properties": { + "expires_after_seconds": { + "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", + "type": "integer" + }, + "expires_at": { + "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.", + "format": "unix-time", + "type": "integer" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options." + }, + "promptpay": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options." + }, + "revolut_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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", @@ -98562,30 +114894,30 @@ "type": "string" } ], - "description": "If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options." + "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options." }, - "pix": { + "sepa_debit": { "anyOf": [ { "properties": { - "expires_after_seconds": { - "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.", - "type": "integer" - }, - "expires_at": { - "description": "The timestamp at which the Pix expires (between 10 and 1209600 seconds in the future). Defaults to 1 day in the future.", - "format": "unix-time", - "type": "integer" + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" + "", + "none", + "off_session", + "on_session" ], "type": "string" } }, - "title": "payment_method_options_param", + "title": "payment_intent_payment_method_options_param", "type": "object" }, { @@ -98595,38 +114927,28 @@ "type": "string" } ], - "description": "If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options." + "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options." }, - "promptpay": { + "sofort": { "anyOf": [ { "properties": { - "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "preferred_language": { + "description": "Language shown to the payer on redirect.", "enum": [ - "none" + "", + "de", + "en", + "es", + "fr", + "it", + "nl", + "pl" ], "type": "string" - } - }, - "title": "payment_method_options_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options." - }, - "revolut_pay": { - "anyOf": [ - { - "properties": { + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -98645,25 +114967,31 @@ "type": "string" } ], - "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Demo Pay payment method options." + "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." }, - "sepa_debit": { + "swish": { "anyOf": [ { "properties": { - "mandate_options": { - "description": "Additional fields for Mandate creation", - "properties": {}, - "title": "payment_method_options_mandate_options_param", - "type": "object" + "reference": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The order ID displayed in the Swish app after the payment is authorized." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" + "none" ], "type": "string" } @@ -98678,32 +115006,16 @@ "type": "string" } ], - "description": "If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options." + "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options." }, - "sofort": { + "twint": { "anyOf": [ { "properties": { - "preferred_language": { - "description": "Language shown to the payer on redirect.", - "enum": [ - "", - "de", - "en", - "es", - "fr", - "it", - "nl", - "pl" - ], - "type": "string" - }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" + "none" ], "type": "string" } @@ -98718,7 +115030,7 @@ "type": "string" } ], - "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." + "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options." }, "us_bank_account": { "anyOf": [ @@ -98727,6 +115039,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -98747,6 +115078,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -98807,7 +115139,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -98859,7 +115191,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98886,7 +115218,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -98938,7 +115270,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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" @@ -99014,12 +115346,12 @@ "type": "object" }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters.", + "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.", "maxLength": 22, "type": "string" }, @@ -99386,7 +115718,7 @@ "type": "string" }, "customer": { - "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.", + "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.", "maxLength": 5000, "type": "string" }, @@ -99421,7 +115753,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "payment_method": { - "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.", + "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.", "maxLength": 5000, "type": "string" }, @@ -99478,6 +115810,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -99770,6 +116117,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -99841,6 +116189,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -99877,6 +116237,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -99919,7 +116280,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -99965,6 +116326,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -99972,6 +116345,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -99987,6 +116361,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -99996,6 +116372,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -100111,7 +116489,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100148,7 +116526,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -100161,7 +116539,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100185,7 +116563,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -100198,7 +116576,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100223,7 +116601,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100244,12 +116622,46 @@ ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, + "amazon_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." + }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100275,8 +116687,14 @@ "anyOf": [ { "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100286,7 +116704,7 @@ "type": "string" } }, - "title": "payment_method_options_param", + "title": "payment_intent_payment_method_options_param", "type": "object" }, { @@ -100313,7 +116731,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100342,6 +116760,15 @@ "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", "maxLength": 5000, "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", @@ -100365,7 +116792,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100392,7 +116819,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -100416,11 +116843,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -100431,12 +116858,11 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", @@ -100538,6 +116964,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -100558,7 +116985,7 @@ "type": "string" }, "request_incremental_authorization": { - "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", + "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" @@ -100582,7 +117009,7 @@ "type": "string" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -100591,8 +117018,12 @@ "type": "string", "x-stripeBypassValidation": true }, + "require_cvc_recollection": { + "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", + "type": "boolean" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100763,6 +117194,21 @@ "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" + }, + "routing": { + "description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.", + "properties": { + "requested_priority": { + "description": "Routing requested priority", + "enum": [ + "domestic", + "international" + ], + "type": "string" + } + }, + "title": "routing_payment_method_options_param", + "type": "object" } }, "title": "payment_method_options_param", @@ -100782,7 +117228,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -100790,7 +117236,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -100878,7 +117324,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100902,7 +117348,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100926,7 +117372,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100950,7 +117396,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100974,7 +117420,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -100998,7 +117444,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -101040,7 +117486,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -101076,6 +117522,7 @@ "en-NZ", "en-PL", "en-PT", + "en-RO", "en-SE", "en-US", "es-ES", @@ -101092,6 +117539,7 @@ "nl-NL", "pl-PL", "pt-PT", + "ro-RO", "sv-FI", "sv-SE" ], @@ -101099,7 +117547,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101183,7 +117631,7 @@ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101207,7 +117655,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -101220,7 +117668,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -101241,6 +117689,62 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." + }, + "multibanco": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." + }, "oxxo": { "anyOf": [ { @@ -101250,7 +117754,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101274,7 +117778,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101302,7 +117806,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101372,7 +117876,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -101407,7 +117911,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101431,7 +117935,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101454,8 +117958,16 @@ "anyOf": [ { "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -101474,7 +117986,7 @@ "type": "string" } ], - "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Demo Pay payment method options." + "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options." }, "sepa_debit": { "anyOf": [ @@ -101487,7 +117999,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -101528,7 +118040,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -101549,6 +118061,69 @@ ], "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." }, + "swish": { + "anyOf": [ + { + "properties": { + "reference": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The order ID displayed in the Swish app after the payment is authorized." + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_intent_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options." + }, + "twint": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options." + }, "us_bank_account": { "anyOf": [ { @@ -101556,6 +118131,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -101576,6 +118170,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -101636,7 +118231,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -101688,7 +118283,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101715,7 +118310,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -101761,7 +118356,7 @@ "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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": [ "", "off_session", @@ -101848,12 +118443,12 @@ "description": "Shipping information for this PaymentIntent." }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 22, "type": "string" }, @@ -102131,12 +118726,12 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long.", + "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.", "maxLength": 22, "type": "string" }, @@ -102184,7 +118779,7 @@ }, "/v1/payment_intents/{intent}/confirm": { "post": { - "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\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).\nIf 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.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf 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. Read the expanded documentation\nto learn more about manual confirmation.

", + "description": "

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\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).\nIf 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.\nIf the confirmation_method is manual, all payment attempts must be\ninitiated using a secret key.\nIf 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.

", "operationId": "PostPaymentIntentsIntentConfirm", "parameters": [ { @@ -102222,6 +118817,10 @@ "explode": true, "style": "deepObject" }, + "payment_method_types": { + "explode": true, + "style": "deepObject" + }, "radar_options": { "explode": true, "style": "deepObject" @@ -102247,6 +118846,11 @@ ], "type": "string" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this PaymentIntent.\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.", + "maxLength": 5000, + "type": "string" + }, "error_on_requires_action": { "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).", "type": "boolean" @@ -102450,6 +119054,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -102742,6 +119361,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -102813,6 +119433,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -102849,6 +119481,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -102891,7 +119524,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -102937,6 +119570,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -102944,6 +119589,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -102959,6 +119605,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -102968,6 +119616,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -103083,7 +119733,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103120,7 +119770,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -103133,7 +119783,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103157,7 +119807,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -103170,7 +119820,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103195,7 +119845,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103216,12 +119866,46 @@ ], "description": "If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options." }, + "amazon_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `amazon_pay` PaymentMethod, this sub-hash contains details about the Amazon Pay payment method options." + }, "au_becs_debit": { "anyOf": [ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103247,8 +119931,14 @@ "anyOf": [ { "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103258,7 +119948,7 @@ "type": "string" } }, - "title": "payment_method_options_param", + "title": "payment_intent_payment_method_options_param", "type": "object" }, { @@ -103285,7 +119975,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103314,6 +120004,15 @@ "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.", "maxLength": 5000, "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true } }, "title": "payment_intent_payment_method_options_param", @@ -103337,7 +120036,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103364,7 +120063,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -103388,11 +120087,11 @@ { "properties": { "count": { - "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", + "description": "For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.", "type": "integer" }, "interval": { - "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", + "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" ], @@ -103403,12 +120102,11 @@ "enum": [ "fixed_count" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ - "count", - "interval", "type" ], "title": "installment_plan", @@ -103510,6 +120208,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -103530,7 +120229,7 @@ "type": "string" }, "request_incremental_authorization": { - "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", + "description": "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.", "enum": [ "if_available", "never" @@ -103554,7 +120253,7 @@ "type": "string" }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -103563,8 +120262,12 @@ "type": "string", "x-stripeBypassValidation": true }, + "require_cvc_recollection": { + "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).", + "type": "boolean" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103735,6 +120438,21 @@ "request_incremental_authorization_support": { "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.", "type": "boolean" + }, + "routing": { + "description": "Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.", + "properties": { + "requested_priority": { + "description": "Routing requested priority", + "enum": [ + "domestic", + "international" + ], + "type": "string" + } + }, + "title": "routing_payment_method_options_param", + "type": "object" } }, "title": "payment_method_options_param", @@ -103754,7 +120472,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -103762,7 +120480,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -103850,7 +120568,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103874,7 +120592,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103898,7 +120616,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103922,7 +120640,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103946,7 +120664,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -103970,7 +120688,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -104012,7 +120730,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -104048,6 +120766,7 @@ "en-NZ", "en-PL", "en-PT", + "en-RO", "en-SE", "en-US", "es-ES", @@ -104064,6 +120783,7 @@ "nl-NL", "pl-PL", "pt-PT", + "ro-RO", "sv-FI", "sv-SE" ], @@ -104071,7 +120791,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104155,7 +120875,7 @@ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store." }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104179,7 +120899,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` 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 will unset the stored value for this payment method type.", + "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" @@ -104192,7 +120912,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -104213,6 +120933,62 @@ ], "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options." }, + "mobilepay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `MobilePay` PaymentMethod, this sub-hash contains details about the MobilePay payment method options." + }, + "multibanco": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `multibanco` PaymentMethod, this sub-hash contains details about the Multibanco payment method options." + }, "oxxo": { "anyOf": [ { @@ -104222,7 +120998,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104246,7 +121022,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104274,7 +121050,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104344,7 +121120,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -104379,7 +121155,7 @@ "type": "integer" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104403,7 +121179,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104426,8 +121202,16 @@ "anyOf": [ { "properties": { + "capture_method": { + "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" + ], + "type": "string" + }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/strong-customer-authentication).", + "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", @@ -104446,7 +121230,7 @@ "type": "string" } ], - "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Demo Pay payment method options." + "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Revolut Pay payment method options." }, "sepa_debit": { "anyOf": [ @@ -104459,7 +121243,7 @@ "type": "object" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -104500,7 +121284,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -104521,6 +121305,69 @@ ], "description": "If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options." }, + "swish": { + "anyOf": [ + { + "properties": { + "reference": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The order ID displayed in the Swish app after the payment is authorized." + }, + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_intent_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `Swish` PaymentMethod, this sub-hash contains details about the Swish payment method options." + }, + "twint": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "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" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If this is a `twint` PaymentMethod, this sub-hash contains details about the TWINT payment method options." + }, "us_bank_account": { "anyOf": [ { @@ -104528,6 +121375,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -104548,6 +121414,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -104608,7 +121475,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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", @@ -104660,7 +121527,7 @@ "x-stripeBypassValidation": true }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104687,7 +121554,7 @@ { "properties": { "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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" ], @@ -104710,6 +121577,14 @@ "title": "payment_method_options_param", "type": "object" }, + "payment_method_types": { + "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, "radar_options": { "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).", "properties": { @@ -104741,7 +121616,7 @@ "type": "string" }, "setup_future_usage": { - "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\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://stripe.com/docs/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`.", + "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": [ "", "off_session", @@ -104927,7 +121802,7 @@ "type": "object" }, "statement_descriptor": { - "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.", + "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).", "maxLength": 22, "type": "string" }, @@ -105340,6 +122215,28 @@ "enabled": { "description": "If `true`, tax will be calculated automatically using the customer's location.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -105349,7 +122246,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -105402,7 +122299,7 @@ "type": "string" }, "custom_fields": { - "description": "Collect additional information from your customer using custom fields. Up to 2 fields are supported.", + "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported.", "items": { "properties": { "dropdown": { @@ -105683,13 +122580,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -105721,6 +122618,28 @@ "maxLength": 5000, "type": "string" }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, "metadata": { "anyOf": [ { @@ -105864,12 +122783,12 @@ "type": "string" }, "statement_descriptor": { - "description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.", + "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.", "maxLength": 22, "type": "string" }, "statement_descriptor_suffix": { - "description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.", + "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.", "maxLength": 22, "type": "string" }, @@ -105883,7 +122802,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\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://stripe.com/docs/payments/checkout/free-trials).", + "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://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -105912,6 +122831,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -105920,8 +122841,11 @@ "promptpay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -106255,6 +123179,35 @@ "maxLength": 500, "type": "string" }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "subscription_data_invoice_settings_params", + "type": "object" + }, "metadata": { "additionalProperties": { "type": "string" @@ -106303,7 +123256,7 @@ "description": "Controls tax ID collection during checkout.", "properties": { "enabled": { - "description": "Set to `true` to enable tax ID collection.", + "description": "Enable tax ID collection during checkout. Defaults to `false`.", "type": "boolean" } }, @@ -106506,6 +123459,10 @@ "subscription_data": { "explode": true, "style": "deepObject" + }, + "tax_id_collection": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -106570,6 +123527,28 @@ "enabled": { "description": "If `true`, tax will be calculated automatically using the customer's location.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -106579,7 +123558,7 @@ "type": "object" }, "billing_address_collection": { - "description": "Configuration for collecting the customer's billing address.", + "description": "Configuration for collecting the customer's billing address. Defaults to `auto`.", "enum": [ "auto", "required" @@ -106714,7 +123693,7 @@ "type": "string" } ], - "description": "Collect additional information from your customer using custom fields. Up to 2 fields are supported." + "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported." }, "custom_text": { "description": "Display additional text for your customers using custom text.", @@ -106888,13 +123867,13 @@ "items": { "properties": { "name": { - "description": "The name of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The name of the custom field. This may be up to 40 characters.", + "maxLength": 40, "type": "string" }, "value": { - "description": "The value of the custom field. This may be up to 30 characters.", - "maxLength": 30, + "description": "The value of the custom field. This may be up to 140 characters.", + "maxLength": 140, "type": "string" } }, @@ -106926,6 +123905,28 @@ "maxLength": 5000, "type": "string" }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + }, "metadata": { "anyOf": [ { @@ -107079,7 +124080,7 @@ "type": "string" } ], - "description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge." + "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": { "anyOf": [ @@ -107094,7 +124095,7 @@ "type": "string" } ], - "description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor." + "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": { "anyOf": [ @@ -107116,7 +124117,7 @@ "type": "object" }, "payment_method_collection": { - "description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\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://stripe.com/docs/payments/checkout/free-trials).", + "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://stripe.com/docs/payments/checkout/free-trials).", "enum": [ "always", "if_required" @@ -107146,6 +124147,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -107154,8 +124157,11 @@ "promptpay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", - "wechat_pay" + "wechat_pay", + "zip" ], "type": "string", "x-stripeBypassValidation": true @@ -107474,6 +124480,35 @@ "subscription_data": { "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.", "properties": { + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "subscription_data_invoice_settings_params", + "type": "object" + }, "metadata": { "anyOf": [ { @@ -107533,6 +124568,20 @@ }, "title": "subscription_data_update_params", "type": "object" + }, + "tax_id_collection": { + "description": "Controls tax ID collection during checkout.", + "properties": { + "enabled": { + "description": "Enable tax ID collection during checkout. Defaults to `false`.", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "title": "tax_id_collection_params", + "type": "object" } }, "type": "object" @@ -107728,6 +124777,17 @@ }, "style": "deepObject" }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, { "description": "Specifies which fields in the response should be expanded.", "explode": true, @@ -107742,6 +124802,27 @@ "type": "array" }, "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" } ], "requestBody": { @@ -107784,6 +124865,7 @@ "url": { "description": "The URL where this list can be accessed.", "maxLength": 5000, + "pattern": "^/v1/payment_method_configurations", "type": "string" } }, @@ -107838,6 +124920,10 @@ "explode": true, "style": "deepObject" }, + "amazon_pay": { + "explode": true, + "style": "deepObject" + }, "apple_pay": { "explode": true, "style": "deepObject" @@ -107878,6 +124964,10 @@ "explode": true, "style": "deepObject" }, + "customer_balance": { + "explode": true, + "style": "deepObject" + }, "eps": { "explode": true, "style": "deepObject" @@ -107922,6 +125012,14 @@ "explode": true, "style": "deepObject" }, + "mobilepay": { + "explode": true, + "style": "deepObject" + }, + "multibanco": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -107954,6 +125052,14 @@ "explode": true, "style": "deepObject" }, + "swish": { + "explode": true, + "style": "deepObject" + }, + "twint": { + "explode": true, + "style": "deepObject" + }, "us_bank_account": { "explode": true, "style": "deepObject" @@ -107961,6 +125067,10 @@ "wechat_pay": { "explode": true, "style": "deepObject" + }, + "zip": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -107989,8 +125099,100 @@ "title": "payment_method_param", "type": "object" }, - "affirm": { - "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", + "affirm": { + "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "afterpay_clearpay": { + "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "alipay": { + "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "amazon_pay": { + "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "apple_pay": { + "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108012,8 +125214,8 @@ "title": "payment_method_param", "type": "object" }, - "afterpay_clearpay": { - "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.", + "apple_pay_later": { + "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108035,8 +125237,8 @@ "title": "payment_method_param", "type": "object" }, - "alipay": { - "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", + "au_becs_debit": { + "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108058,8 +125260,8 @@ "title": "payment_method_param", "type": "object" }, - "apple_pay": { - "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", + "bacs_debit": { + "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108081,8 +125283,8 @@ "title": "payment_method_param", "type": "object" }, - "apple_pay_later": { - "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", + "bancontact": { + "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108104,8 +125306,8 @@ "title": "payment_method_param", "type": "object" }, - "au_becs_debit": { - "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", + "blik": { + "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108127,8 +125329,8 @@ "title": "payment_method_param", "type": "object" }, - "bacs_debit": { - "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", + "boleto": { + "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108150,8 +125352,8 @@ "title": "payment_method_param", "type": "object" }, - "bancontact": { - "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", + "card": { + "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108173,8 +125375,8 @@ "title": "payment_method_param", "type": "object" }, - "blik": { - "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", + "cartes_bancaires": { + "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108196,8 +125398,8 @@ "title": "payment_method_param", "type": "object" }, - "boleto": { - "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", + "cashapp": { + "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108219,8 +125421,8 @@ "title": "payment_method_param", "type": "object" }, - "card": { - "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", + "customer_balance": { + "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108242,8 +125444,8 @@ "title": "payment_method_param", "type": "object" }, - "cartes_bancaires": { - "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", + "eps": { + "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108265,8 +125467,16 @@ "title": "payment_method_param", "type": "object" }, - "cashapp": { - "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "fpx": { + "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108288,8 +125498,8 @@ "title": "payment_method_param", "type": "object" }, - "eps": { - "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.", + "giropay": { + "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108311,16 +125521,8 @@ "title": "payment_method_param", "type": "object" }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "fpx": { - "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.", + "google_pay": { + "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108342,8 +125544,8 @@ "title": "payment_method_param", "type": "object" }, - "giropay": { - "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.", + "grabpay": { + "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108365,8 +125567,8 @@ "title": "payment_method_param", "type": "object" }, - "google_pay": { - "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.", + "ideal": { + "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108388,8 +125590,8 @@ "title": "payment_method_param", "type": "object" }, - "grabpay": { - "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.", + "jcb": { + "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108411,8 +125613,8 @@ "title": "payment_method_param", "type": "object" }, - "ideal": { - "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.", + "klarna": { + "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108434,8 +125636,8 @@ "title": "payment_method_param", "type": "object" }, - "jcb": { - "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.", + "konbini": { + "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108457,8 +125659,8 @@ "title": "payment_method_param", "type": "object" }, - "klarna": { - "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.", + "link": { + "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108480,8 +125682,8 @@ "title": "payment_method_param", "type": "object" }, - "konbini": { - "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.", + "mobilepay": { + "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108503,8 +125705,8 @@ "title": "payment_method_param", "type": "object" }, - "link": { - "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.", + "multibanco": { + "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.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -108720,6 +125922,52 @@ "title": "payment_method_param", "type": "object" }, + "swish": { + "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "twint": { + "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.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.", "properties": { @@ -108765,6 +126013,29 @@ }, "title": "payment_method_param", "type": "object" + }, + "zip": { + "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" } }, "type": "object" @@ -108899,6 +126170,10 @@ "explode": true, "style": "deepObject" }, + "amazon_pay": { + "explode": true, + "style": "deepObject" + }, "apple_pay": { "explode": true, "style": "deepObject" @@ -108939,6 +126214,10 @@ "explode": true, "style": "deepObject" }, + "customer_balance": { + "explode": true, + "style": "deepObject" + }, "eps": { "explode": true, "style": "deepObject" @@ -108983,6 +126262,14 @@ "explode": true, "style": "deepObject" }, + "mobilepay": { + "explode": true, + "style": "deepObject" + }, + "multibanco": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -109015,6 +126302,14 @@ "explode": true, "style": "deepObject" }, + "swish": { + "explode": true, + "style": "deepObject" + }, + "twint": { + "explode": true, + "style": "deepObject" + }, "us_bank_account": { "explode": true, "style": "deepObject" @@ -109022,6 +126317,10 @@ "wechat_pay": { "explode": true, "style": "deepObject" + }, + "zip": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -109100,31 +126399,77 @@ "title": "payment_method_param", "type": "object" }, - "alipay": { - "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", - "properties": { - "display_preference": { - "description": "Whether or not the payment method should be displayed.", - "properties": { - "preference": { - "description": "The account's preference for whether or not to display this payment method.", - "enum": [ - "none", - "off", - "on" - ], - "type": "string" - } - }, - "title": "display_preference_param", - "type": "object" - } - }, - "title": "payment_method_param", - "type": "object" - }, - "apple_pay": { - "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", + "alipay": { + "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "amazon_pay": { + "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "apple_pay": { + "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "apple_pay_later": { + "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109146,8 +126491,8 @@ "title": "payment_method_param", "type": "object" }, - "apple_pay_later": { - "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.", + "au_becs_debit": { + "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109169,8 +126514,8 @@ "title": "payment_method_param", "type": "object" }, - "au_becs_debit": { - "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.", + "bacs_debit": { + "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109192,8 +126537,8 @@ "title": "payment_method_param", "type": "object" }, - "bacs_debit": { - "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.", + "bancontact": { + "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109215,8 +126560,8 @@ "title": "payment_method_param", "type": "object" }, - "bancontact": { - "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.", + "blik": { + "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109238,8 +126583,8 @@ "title": "payment_method_param", "type": "object" }, - "blik": { - "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.", + "boleto": { + "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109261,8 +126606,8 @@ "title": "payment_method_param", "type": "object" }, - "boleto": { - "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.", + "card": { + "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109284,8 +126629,8 @@ "title": "payment_method_param", "type": "object" }, - "card": { - "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.", + "cartes_bancaires": { + "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109307,8 +126652,8 @@ "title": "payment_method_param", "type": "object" }, - "cartes_bancaires": { - "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.", + "cashapp": { + "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109330,8 +126675,8 @@ "title": "payment_method_param", "type": "object" }, - "cashapp": { - "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.", + "customer_balance": { + "description": "Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details.", "properties": { "display_preference": { "description": "Whether or not the payment method should be displayed.", @@ -109591,6 +126936,52 @@ "title": "payment_method_param", "type": "object" }, + "mobilepay": { + "description": "MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "multibanco": { + "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.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "name": { "description": "Configuration name.", "maxLength": 100, @@ -109780,6 +127171,52 @@ "title": "payment_method_param", "type": "object" }, + "swish": { + "description": "Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "twint": { + "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.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "us_bank_account": { "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.", "properties": { @@ -109825,6 +127262,29 @@ }, "title": "payment_method_param", "type": "object" + }, + "zip": { + "description": "Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability.", + "properties": { + "display_preference": { + "description": "Whether or not the payment method should be displayed.", + "properties": { + "preference": { + "description": "The account's preference for whether or not to display this payment method.", + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" } }, "type": "object" @@ -110345,6 +127805,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -110361,6 +127822,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -110370,6 +127833,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -110475,6 +127940,10 @@ "explode": true, "style": "deepObject" }, + "amazon_pay": { + "explode": true, + "style": "deepObject" + }, "au_becs_debit": { "explode": true, "style": "deepObject" @@ -110555,6 +128024,14 @@ "explode": true, "style": "deepObject" }, + "mobilepay": { + "explode": true, + "style": "deepObject" + }, + "multibanco": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -110595,6 +128072,14 @@ "explode": true, "style": "deepObject" }, + "swish": { + "explode": true, + "style": "deepObject" + }, + "twint": { + "explode": true, + "style": "deepObject" + }, "us_bank_account": { "explode": true, "style": "deepObject" @@ -110656,6 +128141,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -110836,6 +128336,22 @@ "description": "Four-digit number representing the card's expiration year.", "type": "integer" }, + "networks": { + "description": "Contains information about card networks used to process the payment.", + "properties": { + "preferred": { + "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" + ], + "type": "string" + } + }, + "title": "networks_params", + "type": "object" + }, "number": { "description": "The card number, as a string without any separators.", "maxLength": 5000, @@ -111016,6 +128532,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -111087,6 +128604,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -111123,6 +128652,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -111170,7 +128700,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -111216,6 +128746,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -111223,6 +128765,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -111239,6 +128782,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -111248,6 +128793,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -111450,6 +128997,15 @@ "schema": { "additionalProperties": false, "properties": { + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, "billing_details": { "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", "properties": { @@ -111558,6 +129114,23 @@ "exp_year": { "description": "Four-digit number representing the card's expiration year.", "type": "integer" + }, + "networks": { + "description": "Contains information about card networks used to process the payment.", + "properties": { + "preferred": { + "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" + ], + "type": "string" + } + }, + "title": "networks_update_api_param", + "type": "object" } }, "title": "update_api_param", @@ -111598,12 +129171,20 @@ "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { "account_holder_type": { - "description": "Bank account type.", + "description": "Bank account holder type.", "enum": [ "company", "individual" ], "type": "string" + }, + "account_type": { + "description": "Bank account type.", + "enum": [ + "checking", + "savings" + ], + "type": "string" } }, "title": "update_param", @@ -111788,6 +129369,7 @@ "operationId": "GetPayouts", "parameters": [ { + "description": "Only return payouts that are expected to arrive during the given date interval.", "explode": true, "in": "query", "name": "arrival_date", @@ -111824,6 +129406,7 @@ "style": "deepObject" }, { + "description": "Only return payouts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -112269,7 +129852,7 @@ }, "/v1/payouts/{payout}/cancel": { "post": { - "description": "

You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

", + "description": "

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

", "operationId": "PostPayoutsPayoutCancel", "parameters": [ { @@ -112336,7 +129919,7 @@ }, "/v1/payouts/{payout}/reverse": { "post": { - "description": "

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

\n\n

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.

", + "description": "

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

\n\n

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

", "operationId": "PostPayoutsPayoutReverse", "parameters": [ { @@ -112686,7 +130269,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" }, "metadata": { @@ -112706,6 +130289,11 @@ ], "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "type": "string" + }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, @@ -112721,6 +130309,7 @@ "type": "boolean" }, "id": { + "deprecated": true, "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "maxLength": 5000, "type": "string" @@ -113212,7 +130801,7 @@ "style": "form" }, { - "description": "Only return the price with these lookup_keys, if any exist.", + "description": "Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.", "explode": true, "in": "query", "name": "lookup_keys", @@ -113255,6 +130844,11 @@ ], "type": "string" }, + "meter": { + "description": "Filter by the price's meter.", + "maxLength": 5000, + "type": "string" + }, "usage_type": { "description": "Filter by the usage type for this price. Can be either `metered` or `licensed`.", "enum": [ @@ -113591,6 +131185,7 @@ "type": "boolean" }, "id": { + "deprecated": true, "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "maxLength": 5000, "type": "string" @@ -113653,9 +131248,14 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "type": "string" + }, "trial_period_days": { "description": "Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", "type": "integer" @@ -113766,7 +131366,7 @@ "type": "object" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`.", + "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`.", "type": "integer" }, "unit_amount_decimal": { @@ -114474,11 +132074,11 @@ "explode": true, "style": "deepObject" }, - "features": { + "images": { "explode": true, "style": "deepObject" }, - "images": { + "marketing_features": { "explode": true, "style": "deepObject" }, @@ -114619,7 +132219,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -114667,12 +132267,24 @@ }, "type": "array" }, - "features": { - "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "id": { + "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.", + "maxLength": 5000, + "type": "string" + }, + "images": { + "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "marketing_features": { + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "properties": { "name": { - "description": "The feature's name. Up to 80 characters long.", + "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } @@ -114685,18 +132297,6 @@ }, "type": "array" }, - "id": { - "description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.", - "maxLength": 5000, - "type": "string" - }, - "images": { - "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", - "items": { - "type": "string" - }, - "type": "array" - }, "metadata": { "additionalProperties": { "type": "string" @@ -114743,7 +132343,7 @@ "type": "boolean" }, "statement_descriptor": { - "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\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.", + "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.", "maxLength": 22, "type": "string" }, @@ -115036,7 +132636,557 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/product" + "$ref": "#/components/schemas/product" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

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

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

Retrieve a list of features for a product

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

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

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

Deletes the feature attachment to a product

", + "operationId": "DeleteProductsProductFeaturesId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleted_product_feature" } } }, @@ -115054,11 +133204,27 @@ } } }, - "post": { - "description": "

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

", - "operationId": "PostProductsId", + "get": { + "description": "

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

", + "operationId": "GetProductsProductFeaturesId", "parameters": [ { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "The ID of the product_feature.", "in": "path", "name": "id", "required": true, @@ -115067,243 +133233,26 @@ "type": "string" }, "style": "simple" + }, + { + "description": "The ID of the product.", + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { - "encoding": { - "description": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - }, - "features": { - "explode": true, - "style": "deepObject" - }, - "images": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - }, - "package_dimensions": { - "explode": true, - "style": "deepObject" - }, - "tax_code": { - "explode": true, - "style": "deepObject" - }, - "unit_label": { - "explode": true, - "style": "deepObject" - }, - "url": { - "explode": true, - "style": "deepObject" - } - }, + "encoding": {}, "schema": { "additionalProperties": false, - "properties": { - "active": { - "description": "Whether the product is available for purchase.", - "type": "boolean" - }, - "default_price": { - "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.", - "maxLength": 5000, - "type": "string" - }, - "description": { - "anyOf": [ - { - "maxLength": 40000, - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "features": { - "anyOf": [ - { - "items": { - "properties": { - "name": { - "description": "The feature's name. Up to 80 characters long.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "features", - "type": "object" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." - }, - "images": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer." - }, - "metadata": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." - }, - "name": { - "description": "The product's name, meant to be displayable to the customer.", - "maxLength": 5000, - "type": "string" - }, - "package_dimensions": { - "anyOf": [ - { - "properties": { - "height": { - "description": "Height, in inches. Maximum precision is 2 decimal places.", - "type": "number" - }, - "length": { - "description": "Length, in inches. Maximum precision is 2 decimal places.", - "type": "number" - }, - "weight": { - "description": "Weight, in ounces. Maximum precision is 2 decimal places.", - "type": "number" - }, - "width": { - "description": "Width, in inches. Maximum precision is 2 decimal places.", - "type": "number" - } - }, - "required": [ - "height", - "length", - "weight", - "width" - ], - "title": "package_dimensions_specs", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The dimensions of this product for shipping purposes." - }, - "shippable": { - "description": "Whether this product is shipped (i.e., physical goods).", - "type": "boolean" - }, - "statement_descriptor": { - "description": "An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.\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`.", - "maxLength": 22, - "type": "string" - }, - "tax_code": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID." - }, - "unit_label": { - "anyOf": [ - { - "maxLength": 12, - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`." - }, - "url": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A URL of a publicly-accessible webpage for this product." - } - }, + "properties": {}, "type": "object" } } @@ -115315,7 +133264,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/product" + "$ref": "#/components/schemas/product_feature" } } }, @@ -116128,6 +134077,28 @@ "enabled": { "description": "Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -116196,6 +134167,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -116280,6 +134256,28 @@ "days_until_due": { "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`.", "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "title": "quote_param", @@ -116289,6 +134287,41 @@ "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The discounts applied to this line item." + }, "price": { "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, @@ -116320,7 +134353,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -116712,6 +134745,28 @@ "enabled": { "description": "Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -116780,6 +134835,11 @@ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", "maxLength": 5000, "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" } }, "title": "discounts_data_param", @@ -116845,6 +134905,28 @@ "days_until_due": { "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`.", "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "title": "quote_param", @@ -116854,6 +134936,41 @@ "description": "A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.", "items": { "properties": { + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The discounts applied to this line item." + }, "id": { "description": "The ID of an existing line item on the quote.", "maxLength": 5000, @@ -116890,7 +135007,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -117583,7 +135700,7 @@ }, "/v1/quotes/{quote}/pdf": { "get": { - "description": "

Download the PDF for a finalized quote

", + "description": "

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

", "operationId": "GetQuotesQuotePdf", "parameters": [ { @@ -117647,7 +135764,12 @@ }, "description": "Error response." } - } + }, + "servers": [ + { + "url": "https://files.stripe.com/" + } + ] } }, "/v1/radar/early_fraud_warnings": { @@ -117908,6 +136030,7 @@ "operationId": "GetRadarValueListItems", "parameters": [ { + "description": "Only return items that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -118300,6 +136423,7 @@ "style": "form" }, { + "description": "Only return value lists that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -118758,7 +136882,7 @@ }, "/v1/refunds": { "get": { - "description": "

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

", + "description": "

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

", "operationId": "GetRefunds", "parameters": [ { @@ -118772,6 +136896,7 @@ "style": "form" }, { + "description": "Only return refunds that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -119286,6 +137411,7 @@ "operationId": "GetReportingReportRuns", "parameters": [ { + "description": "Only return Report Runs that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -120427,6 +138553,7 @@ "operationId": "GetReviews", "parameters": [ { + "description": "Only return reviews that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -121162,6 +139289,11 @@ "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.", "type": "boolean" }, + "confirmation_token": { + "description": "ID of the ConfirmationToken used to confirm this SetupIntent.\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.", + "maxLength": 5000, + "type": "string" + }, "customer": { "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.", "maxLength": 5000, @@ -121330,6 +139462,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -121622,6 +139769,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -121693,6 +139841,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -121729,6 +139889,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -121771,7 +139932,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -121817,6 +139978,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -121824,6 +139997,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -121839,6 +140013,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -121848,6 +140024,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -121994,6 +140172,25 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", + "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" + } + }, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { @@ -122085,6 +140282,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -122097,7 +140295,7 @@ "x-stripeBypassValidation": true }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -122205,6 +140403,12 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { @@ -122248,6 +140452,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -122268,6 +140491,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -122586,7 +140810,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "payment_method": { - "description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.", + "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.", "maxLength": 5000, "type": "string" }, @@ -122643,6 +140867,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -122935,6 +141174,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -123006,6 +141246,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -123042,6 +141294,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -123084,7 +141337,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -123130,6 +141383,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -123137,6 +141402,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -123152,6 +141418,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -123161,6 +141429,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -123307,6 +141577,25 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", + "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" + } + }, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { @@ -123398,6 +141687,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -123410,7 +141700,7 @@ "x-stripeBypassValidation": true }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -123518,6 +141808,12 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { @@ -123561,6 +141857,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -123581,6 +141896,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -123690,7 +142006,7 @@ }, "/v1/setup_intents/{intent}/cancel": { "post": { - "description": "

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

\n\n

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

", + "description": "

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

\n\n

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": [ { @@ -123805,6 +142121,11 @@ "schema": { "additionalProperties": false, "properties": { + "confirmation_token": { + "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.", + "maxLength": 5000, + "type": "string" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -123983,6 +142304,21 @@ "title": "param", "type": "object" }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "au_becs_debit": { "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", "properties": { @@ -124275,6 +142611,7 @@ "knab", "moneyou", "n26", + "nn", "rabobank", "regiobank", "revolut", @@ -124346,6 +142683,18 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -124382,6 +142731,7 @@ "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", + "velobank", "volkswagen_bank" ], "type": "string", @@ -124424,7 +142774,7 @@ "type": "string" } }, - "title": "radar_options", + "title": "radar_options_with_hidden_options", "type": "object" }, "revolut_pay": { @@ -124470,6 +142820,18 @@ "title": "param", "type": "object" }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "type": { "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", "enum": [ @@ -124477,6 +142839,7 @@ "affirm", "afterpay_clearpay", "alipay", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -124492,6 +142855,8 @@ "klarna", "konbini", "link", + "mobilepay", + "multibanco", "oxxo", "p24", "paynow", @@ -124501,6 +142866,8 @@ "revolut_pay", "sepa_debit", "sofort", + "swish", + "twint", "us_bank_account", "wechat_pay", "zip" @@ -124647,6 +143014,25 @@ "title": "setup_intent_payment_method_options_param", "type": "object" }, + "amazon_pay": { + "description": "If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.", + "properties": { + "mandate_options": { + "description": "Additional fields for Mandate creation", + "properties": {}, + "title": "payment_method_options_mandate_options_param", + "type": "object" + } + }, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "card": { "description": "Configuration for any card setup attempted on this SetupIntent.", "properties": { @@ -124738,6 +143124,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -124750,7 +143137,7 @@ "x-stripeBypassValidation": true }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", "automatic", @@ -124858,6 +143245,12 @@ "title": "setup_intent_param", "type": "object" }, + "card_present": { + "description": "If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.", + "properties": {}, + "title": "setup_intent_payment_method_options_param", + "type": "object" + }, "link": { "description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.", "properties": { @@ -124901,6 +143294,25 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "title": "linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -124921,6 +143333,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -125458,7 +143871,7 @@ "type": "string" }, "type": { - "description": "The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.", + "description": "The type of calculation to use on the shipping rate.", "enum": [ "fixed_amount" ], @@ -127204,6 +145617,10 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -127248,6 +145665,41 @@ ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -127309,7 +145761,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -127347,7 +145799,7 @@ "type": "object" }, "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", @@ -127449,7 +145901,7 @@ "type": "boolean" }, "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", @@ -127581,6 +146033,10 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -127625,6 +146081,41 @@ ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -127651,7 +146142,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "off_session": { - "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", + "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "payment_behavior": { @@ -127670,12 +146161,12 @@ "type": "string" }, "price": { - "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -127700,7 +146191,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -127738,7 +146229,7 @@ "type": "object" }, "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", @@ -128382,6 +146873,28 @@ "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -128454,9 +146967,49 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.", "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "title": "subscription_schedule_default_settings_param", @@ -128556,13 +147109,38 @@ "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": { "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -128583,7 +147161,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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.", "type": "integer" }, "unit_amount_decimal": { @@ -128640,6 +147218,28 @@ "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -128690,7 +147290,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -128736,6 +147336,41 @@ ], "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." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, "end_date": { "description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.", "format": "unix-time", @@ -128744,9 +147379,49 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "title": "invoice_settings", @@ -128780,6 +147455,41 @@ ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "metadata": { "additionalProperties": { "type": "string" @@ -128823,7 +147533,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -129114,6 +147824,28 @@ "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -129186,9 +147918,49 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.", "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "title": "subscription_schedule_default_settings_param", @@ -129283,13 +148055,38 @@ "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": { "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -129310,7 +148107,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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.", "type": "integer" }, "unit_amount_decimal": { @@ -129367,6 +148164,28 @@ "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -129417,7 +148236,7 @@ "type": "string" }, "coupon": { - "description": "The identifier of the coupon to apply to this phase of the subscription schedule.", + "description": "The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -129463,6 +148282,41 @@ ], "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." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, "end_date": { "anyOf": [ { @@ -129482,9 +148336,49 @@ "invoice_settings": { "description": "All invoices will be billed using the specified settings.", "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "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." + }, "days_until_due": { "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.", "type": "integer" + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "title": "invoice_settings", @@ -129518,6 +148412,41 @@ ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "metadata": { "additionalProperties": { "type": "string" @@ -129561,7 +148490,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -129940,6 +148869,7 @@ "style": "form" }, { + "description": "Only return subscriptions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -130244,6 +149174,10 @@ "explode": true, "style": "deepObject" }, + "application_fee_percent": { + "explode": true, + "style": "deepObject" + }, "automatic_tax": { "explode": true, "style": "deepObject" @@ -130260,10 +149194,18 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" }, + "invoice_settings": { + "explode": true, + "style": "deepObject" + }, "items": { "explode": true, "style": "deepObject" @@ -130304,13 +149246,38 @@ "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -130331,7 +149298,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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.", "type": "integer" }, "unit_amount_decimal": { @@ -130379,8 +149346,18 @@ "type": "array" }, "application_fee_percent": { - "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. 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).", - "type": "number" + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", @@ -130388,6 +149365,28 @@ "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -130468,7 +149467,7 @@ "type": "integer" }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "collection_method": { @@ -130480,7 +149479,7 @@ "type": "string" }, "coupon": { - "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -130530,6 +149529,41 @@ "maxLength": 500, "type": "string" }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -130538,6 +149572,53 @@ }, "type": "array" }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription." + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings_param", + "type": "object" + }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { @@ -130566,6 +149647,41 @@ ], "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "metadata": { "additionalProperties": { "type": "string" @@ -130609,7 +149725,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -130692,7 +149808,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "off_session": { - "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", + "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { @@ -130710,7 +149826,7 @@ "description": "The account on behalf of which to charge, for each of the subscription's invoices." }, "payment_behavior": { - "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.", + "description": "Only applies to subscriptions with `collection_method=charge_automatically`.\n\nUse `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.\n\n`pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.\n\nSubscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.", "enum": [ "allow_incomplete", "default_incomplete", @@ -130830,6 +149946,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -130842,10 +149959,11 @@ "x-stripeBypassValidation": true }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", - "automatic" + "automatic", + "challenge" ], "type": "string" } @@ -130925,6 +150043,22 @@ ], "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." + }, "us_bank_account": { "anyOf": [ { @@ -130932,6 +150066,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -130952,6 +150104,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -130998,6 +150151,7 @@ "ach_credit_transfer", "ach_debit", "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -131012,13 +150166,16 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", "promptpay", + "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", + "swish", "us_bank_account", "wechat_pay" ], @@ -131037,7 +150194,7 @@ "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)." }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" @@ -131083,12 +150240,12 @@ "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "promotion_code": { - "description": "The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", @@ -131412,11 +150569,11 @@ "type": "array" }, "invoice_now": { - "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.", + "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", "type": "boolean" }, "prorate": { - "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end.", + "description": "Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.", "type": "boolean" } }, @@ -131516,7 +150673,7 @@ } }, "post": { - "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 upcoming invoice endpoint.

\n\n

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

\n\n

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

\n\n\n\n

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

\n\n

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

\n\n

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

\n\n

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.

", + "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\n

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

\n\n

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

\n\n\n\n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how Stripe immediately attempts payment for subscription changes.

\n\n

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

\n\n

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

\n\n

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": [ { @@ -131538,6 +150695,10 @@ "explode": true, "style": "deepObject" }, + "application_fee_percent": { + "explode": true, + "style": "deepObject" + }, "automatic_tax": { "explode": true, "style": "deepObject" @@ -131566,10 +150727,18 @@ "explode": true, "style": "deepObject" }, + "discounts": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" }, + "invoice_settings": { + "explode": true, + "style": "deepObject" + }, "items": { "explode": true, "style": "deepObject" @@ -131614,13 +150783,38 @@ "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.", "items": { "properties": { + "discounts": { + "description": "The coupons to redeem into discounts for the item.", + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, "price": { - "description": "The ID of the price object.", + "description": "The ID of the price object. One of `price` or `price_data` is required.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -131641,7 +150835,7 @@ "type": "string" }, "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", + "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.", "type": "integer" }, "unit_amount_decimal": { @@ -131689,8 +150883,18 @@ "type": "array" }, "application_fee_percent": { - "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. 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).", - "type": "number" + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions)." }, "automatic_tax": { "description": "Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.", @@ -131698,6 +150902,28 @@ "enabled": { "description": "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.", "type": "boolean" + }, + "liability": { + "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.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" } }, "required": [ @@ -131757,7 +150983,7 @@ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period." }, "cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period.", + "description": "Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.", "type": "boolean" }, "cancellation_details": { @@ -131806,7 +151032,7 @@ "type": "string" }, "coupon": { - "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, @@ -131867,6 +151093,41 @@ ], "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer." + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -131875,6 +151136,53 @@ }, "type": "array" }, + "invoice_settings": { + "description": "All invoices will be billed using the specified settings.", + "properties": { + "account_tax_ids": { + "anyOf": [ + { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription." + }, + "issuer": { + "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.", + "properties": { + "account": { + "description": "The connected account being referenced when `type` is `account`.", + "type": "string" + }, + "type": { + "description": "Type of the account referenced in the request.", + "enum": [ + "account", + "self" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "param", + "type": "object" + } + }, + "title": "invoice_settings_param", + "type": "object" + }, "items": { "description": "A list of up to 20 subscription items, each with an attached price.", "items": { @@ -131911,6 +151219,41 @@ "description": "A flag that, if set to `true`, will delete the specified item.", "type": "boolean" }, + "discounts": { + "anyOf": [ + { + "items": { + "properties": { + "coupon": { + "description": "ID of the coupon to create a new discount for.", + "maxLength": 5000, + "type": "string" + }, + "discount": { + "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", + "maxLength": 5000, + "type": "string" + }, + "promotion_code": { + "description": "ID of the promotion code to create a new discount for.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "discounts_data_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The coupons to redeem into discounts for the subscription item." + }, "id": { "description": "Subscription item to update.", "maxLength": 5000, @@ -131939,12 +151282,12 @@ "type": "string" }, "price": { - "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", + "description": "The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", "maxLength": 5000, "type": "string" }, "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", + "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.", "properties": { "currency": { "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", @@ -131969,7 +151312,7 @@ "type": "string" }, "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).", + "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", "type": "integer" } }, @@ -132052,7 +151395,7 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, "off_session": { - "description": "Indicates if a customer is on or off-session while an invoice payment is attempted.", + "description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).", "type": "boolean" }, "on_behalf_of": { @@ -132101,7 +151444,7 @@ "type": "string" } ], - "description": "If specified, payment collection for this subscription will be paused." + "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment)." }, "payment_behavior": { "description": "Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.\n\nUse `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.\n\nUse `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).\n\nUse `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.", @@ -132224,6 +151567,7 @@ "diners", "discover", "eftpos_au", + "girocard", "interac", "jcb", "mastercard", @@ -132236,10 +151580,11 @@ "x-stripeBypassValidation": true }, "request_three_d_secure": { - "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", + "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.", "enum": [ "any", - "automatic" + "automatic", + "challenge" ], "type": "string" } @@ -132319,6 +151664,22 @@ ], "description": "This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent." }, + "sepa_debit": { + "anyOf": [ + { + "properties": {}, + "title": "invoice_payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent." + }, "us_bank_account": { "anyOf": [ { @@ -132326,6 +151687,24 @@ "financial_connections": { "description": "Additional fields for Financial Connections Session creation", "properties": { + "filters": { + "description": "Provide filters for the linked accounts that the customer can select for the payment method.", + "properties": { + "account_subcategories": { + "description": "The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.", + "items": { + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "invoice_linked_account_options_filters_param", + "type": "object" + }, "permissions": { "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": { @@ -132346,6 +151725,7 @@ "items": { "enum": [ "balances", + "ownership", "transactions" ], "type": "string", @@ -132392,6 +151772,7 @@ "ach_credit_transfer", "ach_debit", "acss_debit", + "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", @@ -132406,13 +151787,16 @@ "ideal", "konbini", "link", + "multibanco", "p24", "paynow", "paypal", "promptpay", + "revolut_pay", "sepa_credit_transfer", "sepa_debit", "sofort", + "swish", "us_bank_account", "wechat_pay" ], @@ -132431,7 +151815,7 @@ "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)." }, "save_default_payment_method": { - "description": "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.", + "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.", "enum": [ "off", "on_subscription" @@ -132477,12 +151861,12 @@ "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval." }, "promotion_code": { - "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.", + "description": "The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.", "maxLength": 5000, "type": "string" }, "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", @@ -132702,7 +152086,7 @@ "type": "array" }, "proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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`.", + "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.", "enum": [ "always_invoice", "create_prorations", @@ -132748,7 +152132,7 @@ }, "/v1/tax/calculations": { "post": { - "description": "

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

", + "description": "

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

", "operationId": "PostTaxCalculations", "requestBody": { "content": { @@ -132766,6 +152150,10 @@ "explode": true, "style": "deepObject" }, + "ship_from_details": { + "explode": true, + "style": "deepObject" + }, "shipping_cost": { "explode": true, "style": "deepObject" @@ -132893,7 +152281,7 @@ "items": { "properties": { "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", + "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -132901,6 +152289,7 @@ "au_abn", "au_arn", "bg_uic", + "bh_vat", "bo_tin", "br_cnpj", "br_cpf", @@ -132910,11 +152299,13 @@ "ca_pst_mb", "ca_pst_sk", "ca_qst", + "ch_uid", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", + "de_stn", "do_rcn", "ec_ruc", "eg_tin", @@ -132924,6 +152315,7 @@ "gb_vat", "ge_vat", "hk_br", + "hr_oib", "hu_tin", "id_npwp", "il_vat", @@ -132934,13 +152326,17 @@ "jp_trn", "ke_pin", "kr_brn", + "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", + "ng_tin", "no_vat", + "no_voec", "nz_gst", + "om_vat", "pe_ruc", "ph_tin", "ro_tin", @@ -133006,7 +152402,7 @@ "items": { "properties": { "amount": { - "description": "A positive integer in cents representing the line item's total price. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", + "description": "A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\nIf `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", "type": "integer" }, "product": { @@ -133044,11 +152440,111 @@ }, "type": "array" }, + "ship_from_details": { + "description": "Details about the address from which the goods are being shipped.", + "properties": { + "address": { + "description": "The address from which the goods are being shipped from.", + "properties": { + "city": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "City, district, suburb, town, or village." + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Address line 1 (e.g., street, PO Box, or company name)." + }, + "line2": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Address line 2 (e.g., apartment, suite, unit, or building)." + }, + "postal_code": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "ZIP or postal code." + }, + "state": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\"." + } + }, + "required": [ + "country" + ], + "title": "merchant_postal_address", + "type": "object" + } + }, + "required": [ + "address" + ], + "title": "ship_from_details", + "type": "object" + }, "shipping_cost": { "description": "Shipping cost details to be used for the calculation.", "properties": { "amount": { - "description": "A positive integer in cents representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", + "description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing the shipping charge. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.", "type": "integer" }, "shipping_rate": { @@ -133111,9 +152607,77 @@ } } }, + "/v1/tax/calculations/{calculation}": { + "get": { + "description": "

Retrieves a Tax Calculation object, if the calculation hasn’t expired.

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

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

", + "description": "

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

", "operationId": "GetTaxCalculationsCalculationLineItems", "parameters": [ { @@ -133584,6 +153148,23 @@ "title": "europe", "type": "object" }, + "bh": { + "description": "Options for the registration in BH.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, "ca": { "description": "Options for the registration in CA.", "properties": { @@ -133859,6 +153440,23 @@ "title": "europe", "type": "object" }, + "eg": { + "description": "Options for the registration in EG.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "es": { "description": "Options for the registration in ES.", "properties": { @@ -133990,6 +153588,23 @@ "title": "default", "type": "object" }, + "ge": { + "description": "Options for the registration in GE.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "gr": { "description": "Options for the registration in GR.", "properties": { @@ -134231,6 +153846,23 @@ "title": "default", "type": "object" }, + "ke": { + "description": "Options for the registration in KE.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "kr": { "description": "Options for the registration in KR.", "properties": { @@ -134248,6 +153880,23 @@ "title": "simplified", "type": "object" }, + "kz": { + "description": "Options for the registration in KZ.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "lt": { "description": "Options for the registration in LT.", "properties": { @@ -134362,34 +154011,51 @@ "title": "europe", "type": "object" }, - "mt": { - "description": "Options for the registration in MT.", + "mt": { + "description": "Options for the registration in MT.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "mx": { + "description": "Options for the registration in MX.", "properties": { - "standard": { - "description": "Options for the standard registration.", - "properties": { - "place_of_supply_scheme": { - "description": "Place of supply scheme used in an EU standard registration.", - "enum": [ - "small_seller", - "standard" - ], - "type": "string" - } - }, - "required": [ - "place_of_supply_scheme" - ], - "title": "standard", - "type": "object" - }, "type": { - "description": "Type of registration to be created in an EU country.", + "description": "Type of registration to be created in `country`.", "enum": [ - "ioss", - "oss_non_union", - "oss_union", - "standard" + "simplified" ], "type": "string" } @@ -134397,11 +154063,11 @@ "required": [ "type" ], - "title": "europe", + "title": "simplified", "type": "object" }, - "mx": { - "description": "Options for the registration in MX.", + "my": { + "description": "Options for the registration in MY.", "properties": { "type": { "description": "Type of registration to be created in `country`.", @@ -134417,8 +154083,8 @@ "title": "simplified", "type": "object" }, - "my": { - "description": "Options for the registration in MY.", + "ng": { + "description": "Options for the registration in NG.", "properties": { "type": { "description": "Type of registration to be created in `country`.", @@ -134506,6 +154172,23 @@ "title": "default", "type": "object" }, + "om": { + "description": "Options for the registration in OM.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, "pl": { "description": "Options for the registration in PL.", "properties": { @@ -134848,7 +154531,8 @@ "state_communications_tax", "state_sales_tax" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -135312,7 +154996,7 @@ }, "/v1/tax/transactions/create_from_calculation": { "post": { - "description": "

Creates a Tax Transaction from a calculation.

", + "description": "

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

", "operationId": "PostTaxTransactionsCreateFromCalculation", "requestBody": { "content": { @@ -135350,6 +155034,11 @@ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", "type": "object" }, + "posted_at": { + "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", + "type": "integer" + }, "reference": { "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.", "maxLength": 500, @@ -135427,7 +155116,7 @@ "type": "array" }, "flat_amount": { - "description": "A flat amount to reverse across the entire transaction, in negative integer cents. This value represents the total amount to refund from the transaction, including taxes.", + "description": "A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes.", "type": "integer" }, "line_items": { @@ -135435,11 +155124,11 @@ "items": { "properties": { "amount": { - "description": "The amount to reverse, in negative integer cents.", + "description": "The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" }, "amount_tax": { - "description": "The amount of tax to reverse, in negative integer cents.", + "description": "The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" }, "metadata": { @@ -135504,11 +155193,11 @@ "description": "The shipping cost to reverse.", "properties": { "amount": { - "description": "The amount to reverse, in negative integer cents.", + "description": "The amount to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" }, "amount_tax": { - "description": "The amount of tax to reverse, in negative integer cents.", + "description": "The amount of tax to reverse, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative.", "type": "integer" } }, @@ -135860,7 +155549,237 @@ "object", "url" ], - "title": "TaxProductResourceTaxCodeList", + "title": "TaxProductResourceTaxCodeList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax_codes/{id}": { + "get": { + "description": "

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

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

Returns a list of tax IDs.

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

Creates a new account or customer tax_id object.

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

Deletes an existing account or customer tax_id object.

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

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

", - "operationId": "GetTaxCodesId", + "description": "

Retrieves an account or customer tax_id object.

", + "operationId": "GetTaxIdsId", "parameters": [ { "description": "Specifies which fields in the response should be expanded.", @@ -135932,7 +156078,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/tax_code" + "$ref": "#/components/schemas/tax_id" } } }, @@ -136218,10 +156364,10 @@ "qst", "rst", "sales_tax", - "service_tax", "vat" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "required": [ @@ -136425,10 +156571,10 @@ "qst", "rst", "sales_tax", - "service_tax", "vat" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true } }, "type": "object" @@ -136615,6 +156761,14 @@ "explode": true, "style": "deepObject" }, + "reboot_window": { + "explode": true, + "style": "deepObject" + }, + "stripe_s700": { + "explode": true, + "style": "deepObject" + }, "tipping": { "explode": true, "style": "deepObject" @@ -136656,6 +156810,11 @@ }, "type": "array" }, + "name": { + "description": "Name of the configuration", + "maxLength": 100, + "type": "string" + }, "offline": { "anyOf": [ { @@ -136680,6 +156839,46 @@ ], "description": "Configurations for collecting transactions offline." }, + "reboot_window": { + "description": "Reboot time settings for readers that support customized reboot time configuration.", + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "reboot_window", + "type": "object" + }, + "stripe_s700": { + "description": "An object containing device type specific settings for Stripe S700 readers", + "properties": { + "splashscreen": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A File ID representing an image you would like displayed on the reader." + } + }, + "title": "stripe_s700", + "type": "object" + }, "tipping": { "anyOf": [ { @@ -137255,6 +157454,14 @@ "explode": true, "style": "deepObject" }, + "reboot_window": { + "explode": true, + "style": "deepObject" + }, + "stripe_s700": { + "explode": true, + "style": "deepObject" + }, "tipping": { "explode": true, "style": "deepObject" @@ -137306,6 +157513,11 @@ }, "type": "array" }, + "name": { + "description": "Name of the configuration", + "maxLength": 100, + "type": "string" + }, "offline": { "anyOf": [ { @@ -137330,6 +157542,66 @@ ], "description": "Configurations for collecting transactions offline." }, + "reboot_window": { + "anyOf": [ + { + "properties": { + "end_hour": { + "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.", + "type": "integer" + }, + "start_hour": { + "description": "Integer between 0 to 23 that represents the start hour of the reboot time window.", + "type": "integer" + } + }, + "required": [ + "end_hour", + "start_hour" + ], + "title": "reboot_window", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Reboot time settings for readers that support customized reboot time configuration." + }, + "stripe_s700": { + "anyOf": [ + { + "properties": { + "splashscreen": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "A File ID representing an image you would like displayed on the reader." + } + }, + "title": "stripe_s700", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "An object containing device type specific settings for Stripe S700 readers" + }, "tipping": { "anyOf": [ { @@ -137791,7 +158063,7 @@ "type": "array" }, "location": { - "description": "The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens).", + "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).", "maxLength": 5000, "type": "string" } @@ -138249,7 +158521,7 @@ "additionalProperties": false, "properties": { "address": { - "description": "The full address of the location.", + "description": "The full address of the location. If you're updating the `address` field, avoid changing the `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.", "properties": { "city": { "description": "City, district, suburb, town, or village.", @@ -138383,8 +158655,10 @@ "bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", + "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", + "stripe_s700", "verifone_P400" ], "type": "string", @@ -138994,6 +159268,10 @@ "process_config": { "description": "Configuration overrides", "properties": { + "enable_customer_cancellation": { + "description": "Enables cancel button on transaction screens.", + "type": "boolean" + }, "skip_tipping": { "description": "Override showing a tipping selection screen on this transaction.", "type": "boolean" @@ -139089,269 +159367,1113 @@ "maxLength": 5000, "type": "string" }, - "type": "array" - }, - "process_config": { - "description": "Configuration overrides", - "properties": {}, - "title": "process_setup_config", + "type": "array" + }, + "process_config": { + "description": "Configuration overrides", + "properties": { + "enable_customer_cancellation": { + "description": "Enables cancel button on transaction screens.", + "type": "boolean" + } + }, + "title": "process_setup_config", + "type": "object" + }, + "setup_intent": { + "description": "SetupIntent ID", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "customer_consent_collected", + "setup_intent" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/terminal.reader" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/terminal/readers/{reader}/refund_payment": { + "post": { + "description": "

Initiates a refund on a Reader

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

Sets reader display to show cart details.

", + "operationId": "PostTerminalReadersReaderSetReaderDisplay", + "parameters": [ + { + "in": "path", + "name": "reader", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "cart": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "cart": { + "description": "Cart", + "properties": { + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "type": "string" + }, + "line_items": { + "description": "Array of line items that were purchased.", + "items": { + "properties": { + "amount": { + "description": "The price of the item in cents.", + "type": "integer" + }, + "description": { + "description": "The description or name of the item.", + "maxLength": 5000, + "type": "string" + }, + "quantity": { + "description": "The quantity of the line item being purchased.", + "type": "integer" + } + }, + "required": [ + "amount", + "description", + "quantity" + ], + "title": "line_item", + "type": "object" + }, + "type": "array" + }, + "tax": { + "description": "The amount of tax in cents.", + "type": "integer" + }, + "total": { + "description": "Total balance of cart due in cents.", + "type": "integer" + } + }, + "required": [ + "currency", + "line_items", + "total" + ], + "title": "cart", + "type": "object" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Type", + "enum": [ + "cart" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/terminal.reader" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/test_helpers/confirmation_tokens": { + "post": { + "description": "

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

", + "operationId": "PostTestHelpersConfirmationTokens", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "payment_method_data": { + "explode": true, + "style": "deepObject" + }, + "shipping": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "payment_method": { + "description": "ID of an existing PaymentMethod.", + "maxLength": 5000, + "type": "string" + }, + "payment_method_data": { + "description": "If provided, this hash will be used to create a PaymentMethod.", + "properties": { + "acss_debit": { + "description": "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.", + "properties": { + "account_number": { + "description": "Customer's bank account number.", + "maxLength": 5000, + "type": "string" + }, + "institution_number": { + "description": "Institution number of the customer's bank.", + "maxLength": 5000, + "type": "string" + }, + "transit_number": { + "description": "Transit number of the customer's bank.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "account_number", + "institution_number", + "transit_number" + ], + "title": "payment_method_param", + "type": "object" + }, + "affirm": { + "description": "If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "afterpay_clearpay": { + "description": "If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "alipay": { + "description": "If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "allow_redisplay": { + "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.", + "enum": [ + "always", + "limited", + "unspecified" + ], + "type": "string" + }, + "amazon_pay": { + "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "au_becs_debit": { + "description": "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.", + "properties": { + "account_number": { + "description": "The account number for the bank account.", + "maxLength": 5000, + "type": "string" + }, + "bsb_number": { + "description": "Bank-State-Branch number of the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "account_number", + "bsb_number" + ], + "title": "param", + "type": "object" + }, + "bacs_debit": { + "description": "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.", + "properties": { + "account_number": { + "description": "Account number of the bank account that the funds will be debited from.", + "maxLength": 5000, + "type": "string" + }, + "sort_code": { + "description": "Sort code of the bank account. (e.g., `10-20-30`)", + "maxLength": 5000, + "type": "string" + } + }, + "title": "param", + "type": "object" + }, + "bancontact": { + "description": "If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "billing_details": { + "description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.", + "properties": { + "address": { + "anyOf": [ + { + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "billing_details_address", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Billing address." + }, + "email": { + "anyOf": [ + { + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Email address." + }, + "name": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Full name." + }, + "phone": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Billing phone number (including extension)." + } + }, + "title": "billing_details_inner_params", + "type": "object" + }, + "blik": { + "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "boleto": { + "description": "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.", + "properties": { + "tax_id": { + "description": "The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "tax_id" + ], + "title": "param", + "type": "object" + }, + "cashapp": { + "description": "If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "customer_balance": { + "description": "If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "eps": { + "description": "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.", + "properties": { + "bank": { + "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" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "param", + "type": "object" + }, + "fpx": { + "description": "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.", + "properties": { + "account_holder_type": { + "description": "Account holder type for FPX transaction", + "enum": [ + "company", + "individual" + ], + "maxLength": 5000, + "type": "string" + }, + "bank": { + "description": "The customer's bank.", + "enum": [ + "affin_bank", + "agrobank", + "alliance_bank", + "ambank", + "bank_islam", + "bank_muamalat", + "bank_of_china", + "bank_rakyat", + "bsn", + "cimb", + "deutsche_bank", + "hong_leong_bank", + "hsbc", + "kfh", + "maybank2e", + "maybank2u", + "ocbc", + "pb_enterprise", + "public_bank", + "rhb", + "standard_chartered", + "uob" + ], + "maxLength": 5000, + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "bank" + ], + "title": "param", + "type": "object" + }, + "giropay": { + "description": "If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "grabpay": { + "description": "If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "ideal": { + "description": "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.", + "properties": { + "bank": { + "description": "The customer's bank.", + "enum": [ + "abn_amro", + "asn_bank", + "bunq", + "handelsbanken", + "ing", + "knab", + "moneyou", + "n26", + "nn", + "rabobank", + "regiobank", + "revolut", + "sns_bank", + "triodos_bank", + "van_lanschot", + "yoursafe" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "param", + "type": "object" + }, + "interac_present": { + "description": "If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "klarna": { + "description": "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.", + "properties": { + "dob": { + "description": "Customer's date of birth", + "properties": { + "day": { + "description": "The day of birth, between 1 and 31.", + "type": "integer" + }, + "month": { + "description": "The month of birth, between 1 and 12.", + "type": "integer" + }, + "year": { + "description": "The four-digit year of birth.", + "type": "integer" + } + }, + "required": [ + "day", + "month", + "year" + ], + "title": "date_of_birth", + "type": "object" + } + }, + "title": "param", + "type": "object" + }, + "konbini": { + "description": "If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "link": { + "description": "If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", + "type": "object" + }, + "mobilepay": { + "description": "If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "multibanco": { + "description": "If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "oxxo": { + "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "p24": { + "description": "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.", + "properties": { + "bank": { + "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" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, + "paynow": { + "description": "If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "paypal": { + "description": "If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "pix": { + "description": "If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "promptpay": { + "description": "If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "radar_options": { + "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.", + "properties": { + "session": { + "description": "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "radar_options_with_hidden_options", + "type": "object" + }, + "revolut_pay": { + "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "sepa_debit": { + "description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.", + "properties": { + "iban": { + "description": "IBAN of the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "iban" + ], + "title": "param", + "type": "object" + }, + "sofort": { + "description": "If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.", + "properties": { + "country": { + "description": "Two-letter ISO code representing the country the bank account is located in.", + "enum": [ + "AT", + "BE", + "DE", + "ES", + "IT", + "NL" + ], + "type": "string" + } + }, + "required": [ + "country" + ], + "title": "param", + "type": "object" + }, + "swish": { + "description": "If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "twint": { + "description": "If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "type": { + "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.", + "enum": [ + "acss_debit", + "affirm", + "afterpay_clearpay", + "alipay", + "amazon_pay", + "au_becs_debit", + "bacs_debit", + "bancontact", + "blik", + "boleto", + "cashapp", + "customer_balance", + "eps", + "fpx", + "giropay", + "grabpay", + "ideal", + "klarna", + "konbini", + "link", + "mobilepay", + "multibanco", + "oxxo", + "p24", + "paynow", + "paypal", + "pix", + "promptpay", + "revolut_pay", + "sepa_debit", + "sofort", + "swish", + "twint", + "us_bank_account", + "wechat_pay", + "zip" + ], + "type": "string", + "x-stripeBypassValidation": true + }, + "us_bank_account": { + "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", + "properties": { + "account_holder_type": { + "description": "Account holder type: individual or company.", + "enum": [ + "company", + "individual" + ], + "type": "string" + }, + "account_number": { + "description": "Account number of the bank account.", + "maxLength": 5000, + "type": "string" + }, + "account_type": { + "description": "Account type: checkings or savings. Defaults to checking if omitted.", + "enum": [ + "checking", + "savings" + ], + "type": "string" + }, + "financial_connections_account": { + "description": "The ID of a Financial Connections Account to use as a payment method.", + "maxLength": 5000, + "type": "string" + }, + "routing_number": { + "description": "Routing number of the bank account.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "payment_method_param", + "type": "object" + }, + "wechat_pay": { + "description": "If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, + "zip": { + "description": "If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.", + "properties": {}, + "title": "param", + "type": "object" + } + }, + "required": [ + "type" + ], + "title": "payment_method_data_params", "type": "object" }, - "setup_intent": { - "description": "SetupIntent ID", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "customer_consent_collected", - "setup_intent" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/terminal.reader" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/terminal/readers/{reader}/refund_payment": { - "post": { - "description": "

Initiates a refund on a Reader

", - "operationId": "PostTerminalReadersReaderRefundPayment", - "parameters": [ - { - "in": "path", - "name": "reader", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "amount": { - "description": "A positive integer in __cents__ representing how much of this charge to refund.", - "type": "integer" - }, - "charge": { - "description": "ID of the Charge to refund.", - "maxLength": 5000, + "return_url": { + "description": "Return URL used to confirm the Intent.", "type": "string" }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", - "type": "object" - }, - "payment_intent": { - "description": "ID of the PaymentIntent to refund.", - "maxLength": 5000, + "setup_future_usage": { + "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://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.", + "enum": [ + "off_session", + "on_session" + ], "type": "string" }, - "refund_application_fee": { - "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.", - "type": "boolean" - }, - "reverse_transfer": { - "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.", - "type": "boolean" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/terminal.reader" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/terminal/readers/{reader}/set_reader_display": { - "post": { - "description": "

Sets reader display to show cart details.

", - "operationId": "PostTerminalReadersReaderSetReaderDisplay", - "parameters": [ - { - "in": "path", - "name": "reader", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "cart": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "cart": { - "description": "Cart", + "shipping": { + "description": "Shipping information for this ConfirmationToken.", "properties": { - "currency": { - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", - "type": "string" - }, - "line_items": { - "description": "Array of line items that were purchased.", - "items": { - "properties": { - "amount": { - "description": "The price of the item in cents.", - "type": "integer" - }, - "description": { - "description": "The description or name of the item.", - "maxLength": 5000, - "type": "string" - }, - "quantity": { - "description": "The quantity of the line item being purchased.", - "type": "integer" - } + "address": { + "description": "Shipping address", + "properties": { + "city": { + "description": "City, district, suburb, town, or village.", + "maxLength": 5000, + "type": "string" }, - "required": [ - "amount", - "description", - "quantity" - ], - "title": "line_item", - "type": "object" + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "line1": { + "description": "Address line 1 (e.g., street, PO Box, or company name).", + "maxLength": 5000, + "type": "string" + }, + "line2": { + "description": "Address line 2 (e.g., apartment, suite, unit, or building).", + "maxLength": 5000, + "type": "string" + }, + "postal_code": { + "description": "ZIP or postal code.", + "maxLength": 5000, + "type": "string" + }, + "state": { + "description": "State, county, province, or region.", + "maxLength": 5000, + "type": "string" + } }, - "type": "array" + "title": "optional_fields_address", + "type": "object" }, - "tax": { - "description": "The amount of tax in cents.", - "type": "integer" + "name": { + "description": "Recipient name.", + "maxLength": 5000, + "type": "string" }, - "total": { - "description": "Total balance of cart due in cents.", - "type": "integer" + "phone": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "Recipient phone (including extension)" } }, "required": [ - "currency", - "line_items", - "total" + "address", + "name" ], - "title": "cart", + "title": "recipient_shipping_with_optional_fields_address", "type": "object" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "type": { - "description": "Type", - "enum": [ - "cart" - ], - "type": "string" } }, - "required": [ - "type" - ], "type": "object" } } }, - "required": true + "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/terminal.reader" + "$ref": "#/components/schemas/confirmation_token" } } }, @@ -139470,6 +160592,14 @@ "explode": true, "style": "deepObject" }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + }, "merchant_data": { "explode": true, "style": "deepObject" @@ -139533,6 +160663,161 @@ }, "type": "array" }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "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", + "type": "string" + }, + "national_amount_decimal": { + "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_testmode_authorization_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "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": "string" + }, + "type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" @@ -140034,10 +161319,743 @@ } } }, - "/v1/test_helpers/issuing/authorizations/{authorization}/capture": { + "/v1/test_helpers/issuing/authorizations/{authorization}/capture": { + "post": { + "description": "

Capture a test-mode authorization.

", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "purchase_details": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "capture_amount": { + "description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "close_authorization": { + "description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "purchase_details": { + "description": "Additional purchase information that is optionally provided by the merchant.", + "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "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", + "type": "string" + }, + "national_amount_decimal": { + "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "flight": { + "description": "Information about the flight that was purchased with this transaction.", + "properties": { + "departure_at": { + "description": "The time that the flight departed.", + "format": "unix-time", + "type": "integer" + }, + "passenger_name": { + "description": "The name of the passenger.", + "maxLength": 5000, + "type": "string" + }, + "refundable": { + "description": "Whether the ticket is refundable.", + "type": "boolean" + }, + "segments": { + "description": "The legs of the trip.", + "items": { + "properties": { + "arrival_airport_code": { + "description": "The three-letter IATA airport code of the flight's destination.", + "maxLength": 3, + "type": "string" + }, + "carrier": { + "description": "The airline carrier code.", + "maxLength": 5000, + "type": "string" + }, + "departure_airport_code": { + "description": "The three-letter IATA airport code that the flight departed from.", + "maxLength": 3, + "type": "string" + }, + "flight_number": { + "description": "The flight number.", + "maxLength": 5000, + "type": "string" + }, + "service_class": { + "description": "The flight's service class.", + "maxLength": 5000, + "type": "string" + }, + "stopover_allowed": { + "description": "Whether a stopover is allowed on this flight.", + "type": "boolean" + } + }, + "title": "flight_segment_specs", + "type": "object" + }, + "type": "array" + }, + "travel_agency": { + "description": "The travel agency that issued the ticket.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "flight_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "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": "string" + }, + "type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + }, + "lodging": { + "description": "Information about lodging that was purchased with this transaction.", + "properties": { + "check_in_at": { + "description": "The time of checking into the lodging.", + "format": "unix-time", + "type": "integer" + }, + "nights": { + "description": "The number of nights stayed at the lodging.", + "type": "integer" + } + }, + "title": "lodging_specs", + "type": "object" + }, + "receipt": { + "description": "The line items in the purchase.", + "items": { + "properties": { + "description": { + "maxLength": 26, + "type": "string" + }, + "quantity": { + "format": "decimal", + "type": "string" + }, + "total": { + "type": "integer" + }, + "unit_cost": { + "type": "integer" + } + }, + "title": "receipt_specs", + "type": "object" + }, + "type": "array" + }, + "reference": { + "description": "A merchant-specific order number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "purchase_details_specs", + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { + "post": { + "description": "

Expire a test-mode Authorization.

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

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "final_amount": { + "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://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "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", + "type": "string" + }, + "national_amount_decimal": { + "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "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": "string" + }, + "type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + } + }, + "required": [ + "final_amount" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { + "post": { + "description": "

Increment a test-mode Authorization.

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

Capture a test-mode authorization.

", - "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture", + "description": "

Reverse a test-mode Authorization.

", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse", "parameters": [ { "in": "path", @@ -140057,23 +162075,11 @@ "expand": { "explode": true, "style": "deepObject" - }, - "purchase_details": { - "explode": true, - "style": "deepObject" } }, "schema": { "additionalProperties": false, "properties": { - "capture_amount": { - "description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", - "type": "integer" - }, - "close_authorization": { - "description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.", - "type": "boolean" - }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -140082,160 +162088,9 @@ }, "type": "array" }, - "purchase_details": { - "description": "Additional purchase information that is optionally provided by the merchant.", - "properties": { - "flight": { - "description": "Information about the flight that was purchased with this transaction.", - "properties": { - "departure_at": { - "description": "The time that the flight departed.", - "format": "unix-time", - "type": "integer" - }, - "passenger_name": { - "description": "The name of the passenger.", - "maxLength": 5000, - "type": "string" - }, - "refundable": { - "description": "Whether the ticket is refundable.", - "type": "boolean" - }, - "segments": { - "description": "The legs of the trip.", - "items": { - "properties": { - "arrival_airport_code": { - "description": "The three-letter IATA airport code of the flight's destination.", - "maxLength": 3, - "type": "string" - }, - "carrier": { - "description": "The airline carrier code.", - "maxLength": 5000, - "type": "string" - }, - "departure_airport_code": { - "description": "The three-letter IATA airport code that the flight departed from.", - "maxLength": 3, - "type": "string" - }, - "flight_number": { - "description": "The flight number.", - "maxLength": 5000, - "type": "string" - }, - "service_class": { - "description": "The flight's service class.", - "maxLength": 5000, - "type": "string" - }, - "stopover_allowed": { - "description": "Whether a stopover is allowed on this flight.", - "type": "boolean" - } - }, - "title": "flight_segment_specs", - "type": "object" - }, - "type": "array" - }, - "travel_agency": { - "description": "The travel agency that issued the ticket.", - "maxLength": 5000, - "type": "string" - } - }, - "title": "flight_specs", - "type": "object" - }, - "fuel": { - "description": "Information about fuel that was purchased with this transaction.", - "properties": { - "type": { - "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" - ], - "maxLength": 5000, - "type": "string" - }, - "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", - "enum": [ - "liter", - "us_gallon" - ], - "maxLength": 5000, - "type": "string" - }, - "unit_cost_decimal": { - "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", - "format": "decimal", - "type": "string" - }, - "volume_decimal": { - "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.", - "format": "decimal", - "type": "string" - } - }, - "title": "fuel_specs", - "type": "object" - }, - "lodging": { - "description": "Information about lodging that was purchased with this transaction.", - "properties": { - "check_in_at": { - "description": "The time of checking into the lodging.", - "format": "unix-time", - "type": "integer" - }, - "nights": { - "description": "The number of nights stayed at the lodging.", - "type": "integer" - } - }, - "title": "lodging_specs", - "type": "object" - }, - "receipt": { - "description": "The line items in the purchase.", - "items": { - "properties": { - "description": { - "maxLength": 26, - "type": "string" - }, - "quantity": { - "format": "decimal", - "type": "string" - }, - "total": { - "type": "integer" - }, - "unit_cost": { - "type": "integer" - } - }, - "title": "receipt_specs", - "type": "object" - }, - "type": "array" - }, - "reference": { - "description": "A merchant-specific order number.", - "maxLength": 5000, - "type": "string" - } - }, - "title": "purchase_details_specs", - "type": "object" + "reverse_amount": { + "description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" } }, "type": "object" @@ -140268,14 +162123,14 @@ } } }, - "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { + "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": { "post": { - "description": "

Expire a test-mode Authorization.

", - "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire", + "description": "

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

", + "operationId": "PostTestHelpersIssuingCardsCardShippingDeliver", "parameters": [ { "in": "path", - "name": "authorization", + "name": "card", "required": true, "schema": { "maxLength": 5000, @@ -140316,7 +162171,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/issuing.authorization" + "$ref": "#/components/schemas/issuing.card" } } }, @@ -140335,14 +162190,14 @@ } } }, - "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { + "/v1/test_helpers/issuing/cards/{card}/shipping/fail": { "post": { - "description": "

Increment a test-mode Authorization.

", - "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationIncrement", + "description": "

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

", + "operationId": "PostTestHelpersIssuingCardsCardShippingFail", "parameters": [ { "in": "path", - "name": "authorization", + "name": "card", "required": true, "schema": { "maxLength": 5000, @@ -140370,31 +162225,20 @@ "type": "string" }, "type": "array" - }, - "increment_amount": { - "description": "The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", - "type": "integer" - }, - "is_amount_controllable": { - "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", - "type": "boolean" } }, - "required": [ - "increment_amount" - ], "type": "object" } } }, - "required": true + "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/issuing.authorization" + "$ref": "#/components/schemas/issuing.card" } } }, @@ -140413,14 +162257,14 @@ } } }, - "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": { + "/v1/test_helpers/issuing/cards/{card}/shipping/return": { "post": { - "description": "

Reverse a test-mode Authorization.

", - "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse", + "description": "

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

", + "operationId": "PostTestHelpersIssuingCardsCardShippingReturn", "parameters": [ { "in": "path", - "name": "authorization", + "name": "card", "required": true, "schema": { "maxLength": 5000, @@ -140448,10 +162292,6 @@ "type": "string" }, "type": "array" - }, - "reverse_amount": { - "description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", - "type": "integer" } }, "type": "object" @@ -140465,7 +162305,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/issuing.authorization" + "$ref": "#/components/schemas/issuing.card" } } }, @@ -140484,10 +162324,10 @@ } } }, - "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": { + "/v1/test_helpers/issuing/cards/{card}/shipping/ship": { "post": { - "description": "

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

", - "operationId": "PostTestHelpersIssuingCardsCardShippingDeliver", + "description": "

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

", + "operationId": "PostTestHelpersIssuingCardsCardShippingShip", "parameters": [ { "in": "path", @@ -140551,14 +162391,14 @@ } } }, - "/v1/test_helpers/issuing/cards/{card}/shipping/fail": { + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": { "post": { - "description": "

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

", - "operationId": "PostTestHelpersIssuingCardsCardShippingFail", + "description": "

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

", + "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate", "parameters": [ { "in": "path", - "name": "card", + "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, @@ -140599,7 +162439,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/issuing.card" + "$ref": "#/components/schemas/issuing.personalization_design" } } }, @@ -140618,14 +162458,14 @@ } } }, - "/v1/test_helpers/issuing/cards/{card}/shipping/return": { + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": { "post": { - "description": "

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

", - "operationId": "PostTestHelpersIssuingCardsCardShippingReturn", + "description": "

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

", + "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate", "parameters": [ { "in": "path", - "name": "card", + "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, @@ -140666,7 +162506,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/issuing.card" + "$ref": "#/components/schemas/issuing.personalization_design" } } }, @@ -140685,14 +162525,14 @@ } } }, - "/v1/test_helpers/issuing/cards/{card}/shipping/ship": { + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": { "post": { - "description": "

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

", - "operationId": "PostTestHelpersIssuingCardsCardShippingShip", + "description": "

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

", + "operationId": "PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject", "parameters": [ { "in": "path", - "name": "card", + "name": "personalization_design", "required": true, "schema": { "maxLength": 5000, @@ -140708,6 +162548,10 @@ "expand": { "explode": true, "style": "deepObject" + }, + "rejection_reasons": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -140720,20 +162564,63 @@ "type": "string" }, "type": "array" + }, + "rejection_reasons": { + "description": "The reason(s) the personalization design was rejected.", + "properties": { + "card_logo": { + "description": "The reason(s) the card logo was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_binary_image", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "type": "array" + }, + "carrier_text": { + "description": "The reason(s) the carrier text was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "type": "array" + } + }, + "title": "rejection_reasons_param", + "type": "object" } }, + "required": [ + "rejection_reasons" + ], "type": "object" } } }, - "required": false + "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/issuing.card" + "$ref": "#/components/schemas/issuing.personalization_design" } } }, @@ -141148,6 +163035,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "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", + "type": "string" + }, + "national_amount_decimal": { + "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -141216,6 +163209,16 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "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": "string" + }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ @@ -141229,9 +163232,15 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "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" ], "maxLength": 5000, @@ -141241,11 +163250,6 @@ "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" - }, - "volume_decimal": { - "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.", - "format": "decimal", - "type": "string" } }, "title": "fuel_specs", @@ -141731,6 +163735,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "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" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "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", + "type": "string" + }, + "national_amount_decimal": { + "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -141799,6 +163909,16 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "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": "string" + }, "type": { "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", "enum": [ @@ -141812,9 +163932,15 @@ "type": "string" }, "unit": { - "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", + "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" ], "maxLength": 5000, @@ -141824,11 +163950,6 @@ "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", "format": "decimal", "type": "string" - }, - "volume_decimal": { - "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.", - "format": "decimal", - "type": "string" } }, "title": "fuel_specs", @@ -142513,28 +164634,192 @@ "type": "string" }, "type": "array" - }, - "frozen_time": { - "description": "The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.", - "format": "unix-time", - "type": "integer" + }, + "frozen_time": { + "description": "The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "frozen_time" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/test_helpers.test_clock" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": { + "post": { + "description": "

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

", + "operationId": "PostTestHelpersTreasuryInboundTransfersIdFail", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "failure_details": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "failure_details": { + "description": "Details about a failed InboundTransfer.", + "properties": { + "code": { + "description": "Reason for the failure.", + "enum": [ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "debit_not_authorized", + "incorrect_account_holder_address", + "incorrect_account_holder_name", + "incorrect_account_holder_tax_id", + "insufficient_funds", + "invalid_account_number", + "invalid_currency", + "no_account", + "other" + ], + "type": "string" + } + }, + "title": "failure_details_params", + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/treasury.inbound_transfer" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/test_helpers/treasury/inbound_transfers/{id}/return": { + "post": { + "description": "

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

", + "operationId": "PostTestHelpersTreasuryInboundTransfersIdReturn", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" } }, - "required": [ - "frozen_time" - ], "type": "object" } } }, - "required": true + "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/test_helpers.test_clock" + "$ref": "#/components/schemas/treasury.inbound_transfer" } } }, @@ -142553,10 +164838,10 @@ } } }, - "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": { + "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": { "post": { - "description": "

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

", - "operationId": "PostTestHelpersTreasuryInboundTransfersIdFail", + "description": "

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

", + "operationId": "PostTestHelpersTreasuryInboundTransfersIdSucceed", "parameters": [ { "in": "path", @@ -142576,10 +164861,6 @@ "expand": { "explode": true, "style": "deepObject" - }, - "failure_details": { - "explode": true, - "style": "deepObject" } }, "schema": { @@ -142592,32 +164873,6 @@ "type": "string" }, "type": "array" - }, - "failure_details": { - "description": "Details about a failed InboundTransfer.", - "properties": { - "code": { - "description": "Reason for the failure.", - "enum": [ - "account_closed", - "account_frozen", - "bank_account_restricted", - "bank_ownership_changed", - "debit_not_authorized", - "incorrect_account_holder_address", - "incorrect_account_holder_name", - "incorrect_account_holder_tax_id", - "insufficient_funds", - "invalid_account_number", - "invalid_currency", - "no_account", - "other" - ], - "type": "string" - } - }, - "title": "failure_details_params", - "type": "object" } }, "type": "object" @@ -142650,10 +164905,10 @@ } } }, - "/v1/test_helpers/treasury/inbound_transfers/{id}/return": { + "/v1/test_helpers/treasury/outbound_payments/{id}": { "post": { - "description": "

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

", - "operationId": "PostTestHelpersTreasuryInboundTransfersIdReturn", + "description": "

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

", + "operationId": "PostTestHelpersTreasuryOutboundPaymentsId", "parameters": [ { "in": "path", @@ -142673,6 +164928,10 @@ "expand": { "explode": true, "style": "deepObject" + }, + "tracking_details": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -142685,20 +164944,78 @@ "type": "string" }, "type": "array" + }, + "tracking_details": { + "description": "Details about network-specific tracking information.", + "properties": { + "ach": { + "description": "ACH network tracking details.", + "properties": { + "trace_id": { + "description": "ACH trace ID for funds sent over the `ach` network.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "trace_id" + ], + "title": "ach_tracking_details_params", + "type": "object" + }, + "type": { + "description": "The US bank account network used to send funds.", + "enum": [ + "ach", + "us_domestic_wire" + ], + "type": "string" + }, + "us_domestic_wire": { + "description": "US domestic wire network tracking details.", + "properties": { + "chips": { + "description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + }, + "imad": { + "description": "IMAD for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + }, + "omad": { + "description": "OMAD for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "us_domestic_wire_tracking_details_params", + "type": "object" + } + }, + "required": [ + "type" + ], + "title": "tracking_details_params", + "type": "object" } }, + "required": [ + "tracking_details" + ], "type": "object" } } }, - "required": false + "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/treasury.inbound_transfer" + "$ref": "#/components/schemas/treasury.outbound_payment" } } }, @@ -142717,10 +165034,10 @@ } } }, - "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": { + "/v1/test_helpers/treasury/outbound_payments/{id}/fail": { "post": { - "description": "

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

", - "operationId": "PostTestHelpersTreasuryInboundTransfersIdSucceed", + "description": "

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

", + "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdFail", "parameters": [ { "in": "path", @@ -142765,7 +165082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/treasury.inbound_transfer" + "$ref": "#/components/schemas/treasury.outbound_payment" } } }, @@ -142784,10 +165101,10 @@ } } }, - "/v1/test_helpers/treasury/outbound_payments/{id}/fail": { + "/v1/test_helpers/treasury/outbound_payments/{id}/post": { "post": { - "description": "

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

", - "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdFail", + "description": "

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

", + "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdPost", "parameters": [ { "in": "path", @@ -142851,10 +165168,10 @@ } } }, - "/v1/test_helpers/treasury/outbound_payments/{id}/post": { + "/v1/test_helpers/treasury/outbound_payments/{id}/return": { "post": { - "description": "

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

", - "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdPost", + "description": "

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

", + "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdReturn", "parameters": [ { "in": "path", @@ -142874,6 +165191,10 @@ "expand": { "explode": true, "style": "deepObject" + }, + "returned_details": { + "explode": true, + "style": "deepObject" } }, "schema": { @@ -142886,6 +165207,29 @@ "type": "string" }, "type": "array" + }, + "returned_details": { + "description": "Optional hash to set the return code.", + "properties": { + "code": { + "description": "The return code to be set on the OutboundPayment object.", + "enum": [ + "account_closed", + "account_frozen", + "bank_account_restricted", + "bank_ownership_changed", + "declined", + "incorrect_account_holder_name", + "invalid_account_number", + "invalid_currency", + "no_account", + "other" + ], + "type": "string" + } + }, + "title": "returned_details_params", + "type": "object" } }, "type": "object" @@ -142918,14 +165262,14 @@ } } }, - "/v1/test_helpers/treasury/outbound_payments/{id}/return": { + "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": { "post": { - "description": "

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

", - "operationId": "PostTestHelpersTreasuryOutboundPaymentsIdReturn", + "description": "

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

", + "operationId": "PostTestHelpersTreasuryOutboundTransfersOutboundTransfer", "parameters": [ { "in": "path", - "name": "id", + "name": "outbound_transfer", "required": true, "schema": { "maxLength": 5000, @@ -142942,7 +165286,7 @@ "explode": true, "style": "deepObject" }, - "returned_details": { + "tracking_details": { "explode": true, "style": "deepObject" } @@ -142958,42 +165302,77 @@ }, "type": "array" }, - "returned_details": { - "description": "Optional hash to set the the return code.", + "tracking_details": { + "description": "Details about network-specific tracking information.", "properties": { - "code": { - "description": "The return code to be set on the OutboundPayment object.", + "ach": { + "description": "ACH network tracking details.", + "properties": { + "trace_id": { + "description": "ACH trace ID for funds sent over the `ach` network.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "trace_id" + ], + "title": "ach_tracking_details_params", + "type": "object" + }, + "type": { + "description": "The US bank account network used to send funds.", "enum": [ - "account_closed", - "account_frozen", - "bank_account_restricted", - "bank_ownership_changed", - "declined", - "incorrect_account_holder_name", - "invalid_account_number", - "invalid_currency", - "no_account", - "other" + "ach", + "us_domestic_wire" ], "type": "string" + }, + "us_domestic_wire": { + "description": "US domestic wire network tracking details.", + "properties": { + "chips": { + "description": "CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + }, + "imad": { + "description": "IMAD for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + }, + "omad": { + "description": "OMAD for funds sent over the `us_domestic_wire` network.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "us_domestic_wire_tracking_details_params", + "type": "object" } }, - "title": "returned_details_params", + "required": [ + "type" + ], + "title": "tracking_details_params", "type": "object" } }, + "required": [ + "tracking_details" + ], "type": "object" } } }, - "required": false + "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/treasury.outbound_payment" + "$ref": "#/components/schemas/treasury.outbound_transfer" } } }, @@ -143325,7 +165704,7 @@ "type": "object" }, "network": { - "description": "The rails used for the object.", + "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" @@ -143454,7 +165833,7 @@ "type": "object" }, "network": { - "description": "The rails used for the object.", + "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach" ], @@ -143499,7 +165878,7 @@ }, "/v1/tokens": { "post": { - "description": "

Creates a single-use token that represents a bank account’s details.\nYou can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

", + "description": "

Creates a single-use token that represents a bank account’s details.\nYou can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

", "operationId": "PostTokens", "requestBody": { "content": { @@ -143588,7 +165967,7 @@ "type": "string" } }, - "title": "address_specs", + "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { @@ -143676,11 +166055,11 @@ "type": "object" }, "directors_provided": { - "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](https://stripe.com/docs/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.", + "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.", "type": "boolean" }, "executives_provided": { - "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](https://stripe.com/docs/api/persons) for accounts with a `relationship.executive` requirement.", + "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.", "type": "boolean" }, "export_license_id": { @@ -143709,7 +166088,7 @@ "type": "string" }, "owners_provided": { - "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](https://stripe.com/docs/api/persons) for accounts with a `relationship.owner` requirement.", + "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.", "type": "boolean" }, "ownership_declaration": { @@ -143748,7 +166127,7 @@ "type": "string" }, "structure": { - "description": "The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.", + "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", @@ -143766,6 +166145,7 @@ "public_company", "public_corporation", "public_partnership", + "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", @@ -143861,7 +166241,7 @@ "type": "object" }, "address_kana": { - "description": "The Kana variation of the the individual's primary address (Japan only).", + "description": "The Kana variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", @@ -143903,7 +166283,7 @@ "type": "object" }, "address_kanji": { - "description": "The Kanji variation of the the individual's primary address (Japan only).", + "description": "The Kanji variation of the individual's primary address (Japan only).", "properties": { "city": { "description": "City or ward.", @@ -143988,7 +166368,7 @@ "type": "string" }, "first_name_kana": { - "description": "The Kana variation of the the individual's first name (Japan only).", + "description": "The Kana variation of the individual's first name (Japan only).", "maxLength": 5000, "type": "string" }, @@ -144020,12 +166400,12 @@ "type": "string" }, "id_number": { - "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js](/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -144115,6 +166495,44 @@ "title": "address_specs", "type": "object" }, + "relationship": { + "description": "Describes the person’s relationship to the account.", + "properties": { + "director": { + "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.", + "type": "boolean" + }, + "executive": { + "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", + "type": "boolean" + }, + "owner": { + "description": "Whether the person is an owner of the account’s legal entity.", + "type": "boolean" + }, + "percent_ownership": { + "anyOf": [ + { + "type": "number" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "The percent owned by the person of the account's legal entity." + }, + "title": { + "description": "The person's title (e.g., CEO, Support Engineer).", + "maxLength": 5000, + "type": "string" + } + }, + "title": "individual_relationship_specs", + "type": "object" + }, "ssn_last_4": { "description": "The last four digits of the individual's Social Security Number (U.S. only).", "maxLength": 5000, @@ -144166,7 +166584,7 @@ "type": "object" }, "tos_shown_and_accepted": { - "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/docs/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", + "description": "Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.", "type": "boolean" } }, @@ -144177,7 +166595,7 @@ "description": "The bank account this token will represent.", "properties": { "account_holder_name": { - "description": "The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.", + "description": "The name of the person or business that owns the bank account. This field is required when attaching the bank account to a `Customer` object.", "maxLength": 5000, "type": "string" }, @@ -144215,8 +166633,13 @@ "description": "The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](https://stripe.com/docs/payouts)", "type": "string" }, + "payment_method": { + "description": "The ID of a Payment Method with a `type` of `us_bank_account`. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the `bank_account` hash. You must include the top-level `customer` parameter if the Payment Method is attached to a `Customer` object. If the Payment Method is not attached to a `Customer` object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with `attach_to_self=true`.", + "maxLength": 5000, + "type": "string" + }, "routing_number": { - "description": "The routing number, sort code, or other country-appropriateinstitution number for the bank account. For US bank accounts, this is required and should bethe ACH routing number, not the wire routing number. If you are providing an IBAN for`account_number`, this field is not required.", + "description": "The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.", "maxLength": 5000, "type": "string" } @@ -144288,6 +166711,22 @@ "maxLength": 5000, "type": "string" }, + "networks": { + "description": "Contains information about card networks used to process the payment.", + "properties": { + "preferred": { + "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" + ], + "type": "string" + } + }, + "title": "networks_param_specs", + "type": "object" + }, "number": { "description": "The card number, as a string without any separators.", "maxLength": 5000, @@ -144345,7 +166784,7 @@ "description": "Information for the person this token represents.", "properties": { "additional_tos_acceptances": { - "description": "Details on the legal guardian's acceptance of the required Stripe agreements.", + "description": "Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.", "properties": { "account": { "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.", @@ -144416,7 +166855,7 @@ "type": "string" } }, - "title": "address_specs", + "title": "legal_entity_and_kyc_address_specs", "type": "object" }, "address_kana": { @@ -144661,12 +167100,12 @@ "type": "string" }, "id_number": { - "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, "id_number_secondary": { - "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).", + "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).", "maxLength": 5000, "type": "string" }, @@ -145518,6 +167957,7 @@ "operationId": "GetTransfers", "parameters": [ { + "description": "Only return transfers that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -145720,7 +168160,7 @@ "type": "integer" }, "currency": { - "description": "3-letter [ISO code for currency](https://stripe.com/docs/payouts).", + "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).", "type": "string" }, "description": { @@ -145972,7 +168412,7 @@ "type": "integer" }, "description": { - "description": "An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value.", + "description": "An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.", "maxLength": 5000, "type": "string" }, @@ -146993,6 +169433,7 @@ "operationId": "GetTreasuryFinancialAccounts", "parameters": [ { + "description": "Only return FinancialAccounts that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -148460,6 +170901,43 @@ "description": "

Returns a list of OutboundPayments sent from the specified FinancialAccount.

", "operationId": "GetTreasuryOutboundPayments", "parameters": [ + { + "description": "Only return OutboundPayments that were created during the given date interval.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "anyOf": [ + { + "properties": { + "gt": { + "description": "Minimum value to filter by (exclusive)", + "type": "integer" + }, + "gte": { + "description": "Minimum value to filter by (inclusive)", + "type": "integer" + }, + "lt": { + "description": "Maximum value to filter by (exclusive)", + "type": "integer" + }, + "lte": { + "description": "Maximum value to filter by (inclusive)", + "type": "integer" + } + }, + "title": "range_query_specs", + "type": "object" + }, + { + "type": "integer" + } + ] + }, + "style": "deepObject" + }, { "description": "Only return OutboundPayments sent to this customer.", "in": "query", @@ -148846,7 +171324,7 @@ { "properties": { "network": { - "description": "The US bank account network that must be used for this OutboundPayment. If not set, we will default to the PaymentMethod's preferred network.", + "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" @@ -149284,7 +171762,7 @@ { "properties": { "network": { - "description": "Designate the OutboundTransfer as using a US bank account network configuration.", + "description": "Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.", "enum": [ "ach", "us_domestic_wire" @@ -149975,6 +172453,7 @@ "operationId": "GetTreasuryTransactionEntries", "parameters": [ { + "description": "Only return TransactionEntries that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -150277,6 +172756,7 @@ "operationId": "GetTreasuryTransactions", "parameters": [ { + "description": "Only return Transactions that were created during the given date interval.", "explode": true, "in": "query", "name": "created", @@ -150839,7 +173319,9 @@ "2022-08-01", "2022-11-15", "2023-08-16", - "2023-10-16" + "2023-10-16", + "2024-04-10", + "2024-06-20" ], "maxLength": 5000, "type": "string", @@ -150879,6 +173361,7 @@ "application_fee.refund.updated", "application_fee.refunded", "balance.available", + "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", @@ -150936,12 +173419,14 @@ "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", + "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "identity.verification_session.canceled", "identity.verification_session.created", @@ -150954,6 +173439,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -150962,6 +173448,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -150974,8 +173461,13 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", + "issuing_personalization_design.activated", + "issuing_personalization_design.deactivated", + "issuing_personalization_design.rejected", + "issuing_personalization_design.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", @@ -151084,12 +173576,14 @@ "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", + "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", + "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded", @@ -151355,6 +173849,7 @@ "application_fee.refund.updated", "application_fee.refunded", "balance.available", + "billing.alert.triggered", "billing_portal.configuration.created", "billing_portal.configuration.updated", "billing_portal.session.created", @@ -151412,12 +173907,14 @@ "customer.tax_id.updated", "customer.updated", "customer_cash_balance_transaction.created", + "entitlements.active_entitlement_summary.updated", "file.created", "financial_connections.account.created", "financial_connections.account.deactivated", "financial_connections.account.disconnected", "financial_connections.account.reactivated", "financial_connections.account.refreshed_balance", + "financial_connections.account.refreshed_ownership", "financial_connections.account.refreshed_transactions", "identity.verification_session.canceled", "identity.verification_session.created", @@ -151430,6 +173927,7 @@ "invoice.finalization_failed", "invoice.finalized", "invoice.marked_uncollectible", + "invoice.overdue", "invoice.paid", "invoice.payment_action_required", "invoice.payment_failed", @@ -151438,6 +173936,7 @@ "invoice.upcoming", "invoice.updated", "invoice.voided", + "invoice.will_be_due", "invoiceitem.created", "invoiceitem.deleted", "issuing_authorization.created", @@ -151450,8 +173949,13 @@ "issuing_dispute.closed", "issuing_dispute.created", "issuing_dispute.funds_reinstated", + "issuing_dispute.funds_rescinded", "issuing_dispute.submitted", "issuing_dispute.updated", + "issuing_personalization_design.activated", + "issuing_personalization_design.deactivated", + "issuing_personalization_design.rejected", + "issuing_personalization_design.updated", "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", @@ -151560,12 +174064,14 @@ "treasury.outbound_payment.failed", "treasury.outbound_payment.posted", "treasury.outbound_payment.returned", + "treasury.outbound_payment.tracking_details_updated", "treasury.outbound_transfer.canceled", "treasury.outbound_transfer.created", "treasury.outbound_transfer.expected_arrival_date_updated", "treasury.outbound_transfer.failed", "treasury.outbound_transfer.posted", "treasury.outbound_transfer.returned", + "treasury.outbound_transfer.tracking_details_updated", "treasury.received_credit.created", "treasury.received_credit.failed", "treasury.received_credit.succeeded",