From 96e5e109003ce599e9cadaaa62726c84acc13596 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 23:52:43 +0000 Subject: [PATCH] Update OpenAPI for 16014e560d26b8f426612bf3d2bb1de977795efd --- embedded/openapi/fixtures3.json | 49 +- embedded/openapi/spec3.json | 4357 +++++++++++++++++++++++++------ 2 files changed, 3580 insertions(+), 826 deletions(-) diff --git a/embedded/openapi/fixtures3.json b/embedded/openapi/fixtures3.json index dbe1b595..6d1d7f44 100644 --- a/embedded/openapi/fixtures3.json +++ b/embedded/openapi/fixtures3.json @@ -1170,7 +1170,9 @@ "object": "tax_rate", "percentage": 19, "state": null, - "tax_type": "vat" + "tax_type": "vat", + "flat_amount": null, + "rate_type": null } ], "type": "invoice_line_item", @@ -3021,6 +3023,9 @@ "object": "payment_method_domain", "paypal": { "status": "active" + }, + "amazon_pay": { + "status": "active" } }, "payment_source": { @@ -3538,24 +3543,7 @@ "scheduled_query_run": { "created": 1234567890, "data_load_time": 1234567890, - "file": { - "created": 1721948551, - "expires_at": null, - "filename": "path", - "id": "file_1Pgag7B7WZ01zgkWJbdoNCXR", - "links": { - "data": [], - "has_more": false, - "object": "list", - "url": "/v1/file_links?file=file_1Pgag7B7WZ01zgkWJbdoNCXR" - }, - "object": "file", - "purpose": "sigma_scheduled_query", - "size": 500, - "title": null, - "type": "csv", - "url": "https://sangeekp-15t6ai--upload-mydev.dev.stripe.me/v1/files/file_1Pgag7B7WZ01zgkWJbdoNCXR/contents" - }, + "file": null, "id": "sqr_1Pgc7AB7WZ01zgkWvpIic1Di", "livemode": false, "object": "scheduled_query_run", @@ -4085,7 +4073,9 @@ "country": "US", "percentage_decimal": "9.875", "state": "CA", - "tax_type": "sales_tax" + "tax_type": "sales_tax", + "flat_amount": null, + "rate_type": null }, "taxability_reason": "standard_rated", "taxable_amount": 1499 @@ -4097,7 +4087,9 @@ "country": "US", "percentage_decimal": "0.0", "state": "CA", - "tax_type": "sales_tax" + "tax_type": "sales_tax", + "flat_amount": null, + "rate_type": null }, "taxability_reason": "product_exempt", "taxable_amount": 0 @@ -4277,7 +4269,9 @@ "object": "tax_rate", "percentage": 19, "state": null, - "tax_type": "vat" + "tax_type": "vat", + "flat_amount": null, + "rate_type": null }, "terminal.configuration": { "bbpos_wisepos_e": { @@ -5091,17 +5085,6 @@ "test_clock": null, "updated": 234430277, "voided_at": null - }, - "margin": { - "active": true, - "created": 1028554472, - "id": "obj_123", - "livemode": true, - "metadata": null, - "name": null, - "object": "margin", - "percent_off": 1487902325, - "updated": 234430277 } } } \ No newline at end of file diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 723528e9..577ee5d6 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -29,7 +29,7 @@ "$ref": "#/components/schemas/account_capabilities" }, "charges_enabled": { - "description": "Whether the account can create live charges.", + "description": "Whether the account can process charges.", "type": "boolean" }, "company": { @@ -114,6 +114,15 @@ "future_requirements": { "$ref": "#/components/schemas/account_future_requirements" }, + "groups": { + "anyOf": [ + { + "$ref": "#/components/schemas/account_group_membership" + } + ], + "description": "The groups associated with the account.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -138,7 +147,7 @@ "type": "string" }, "payouts_enabled": { - "description": "Whether Stripe can send payouts to this account.", + "description": "Whether the funds in this account can be paid out.", "type": "boolean" }, "requirements": { @@ -180,6 +189,7 @@ "controller", "external_accounts", "future_requirements", + "groups", "individual", "requirements", "settings", @@ -404,6 +414,15 @@ ], "type": "string" }, + "alma_payments": { + "description": "The status of the Alma capability of the account, or whether the account can directly process Alma payments.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "amazon_pay_payments": { "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.", "enum": [ @@ -584,6 +603,15 @@ ], "type": "string" }, + "kakao_pay_payments": { + "description": "The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.", + "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": [ @@ -602,6 +630,15 @@ ], "type": "string" }, + "kr_card_payments": { + "description": "The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "legacy_payments": { "description": "The status of the legacy payments capability of the account.", "enum": [ @@ -647,6 +684,15 @@ ], "type": "string" }, + "naver_pay_payments": { + "description": "The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.", + "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": [ @@ -665,6 +711,15 @@ ], "type": "string" }, + "payco_payments": { + "description": "The status of the Payco capability of the account, or whether the account can directly process Payco payments.", + "enum": [ + "active", + "inactive", + "pending" + ], + "type": "string" + }, "paynow_payments": { "description": "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.", "enum": [ @@ -692,6 +747,15 @@ ], "type": "string" }, + "samsung_pay_payments": { + "description": "The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.", + "enum": [ + "active", + "inactive", + "pending" + ], + "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": [ @@ -1140,6 +1204,20 @@ "errors" ] }, + "account_group_membership": { + "description": "", + "properties": { + "payments_pricing": { + "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "AccountGroupMembership", + "type": "object", + "x-expandableFields": [] + }, "account_invoices_settings": { "description": "", "properties": { @@ -3294,10 +3372,10 @@ "x-resourceId": "billing.alert" }, "billing.credit_balance_summary": { - "description": "Indicates the credit balance for credits granted to a customer.", + "description": "Indicates the billing credit balance for billing credits granted to a customer.", "properties": { "balances": { - "description": "The credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.", + "description": "The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.", "items": { "$ref": "#/components/schemas/credit_balance" }, @@ -3368,7 +3446,7 @@ "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credit" } ], - "description": "Credit details for this balance transaction. Only present if type is `credit`.", + "description": "Credit details for this credit balance transaction. Only present if type is `credit`.", "nullable": true }, "credit_grant": { @@ -3381,7 +3459,7 @@ "$ref": "#/components/schemas/billing.credit_grant" } ], - "description": "The credit grant associated with this balance transaction.", + "description": "The credit grant associated with this credit balance transaction.", "x-expansionResources": { "oneOf": [ { @@ -3396,11 +3474,11 @@ "$ref": "#/components/schemas/billing_credit_grants_resource_balance_debit" } ], - "description": "Debit details for this balance transaction. Only present if type is `debit`.", + "description": "Debit details for this credit balance transaction. Only present if type is `debit`.", "nullable": true }, "effective_at": { - "description": "The effective time of this balance transaction.", + "description": "The effective time of this credit balance transaction.", "format": "unix-time", "type": "integer" }, @@ -3441,7 +3519,7 @@ } }, "type": { - "description": "The type of balance transaction (credit or debit).", + "description": "The type of credit balance transaction (credit or debit).", "enum": [ "credit", "debit" @@ -3469,7 +3547,7 @@ "x-resourceId": "billing.credit_balance_transaction" }, "billing.credit_grant": { - "description": "A credit grant is a resource that records a grant of some credit to a customer.", + "description": "A credit grant is an API resource that documents the allocation of some billing credits to a customer.\n\nRelated guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)\nend", "properties": { "amount": { "$ref": "#/components/schemas/billing_credit_grants_resource_amount" @@ -3478,7 +3556,7 @@ "$ref": "#/components/schemas/billing_credit_grants_resource_applicability_config" }, "category": { - "description": "The category of this credit grant.", + "description": "The category of this credit grant. This is for tracking purposes and will not be displayed to the customer.", "enum": [ "paid", "promotional" @@ -3503,7 +3581,7 @@ "$ref": "#/components/schemas/deleted_customer" } ], - "description": "Id of the customer to whom the credit was granted.", + "description": "ID of the customer to whom the billing credits are granted.", "x-expansionResources": { "oneOf": [ { @@ -3516,13 +3594,13 @@ } }, "effective_at": { - "description": "The time when the credit becomes effective i.e when it is eligible to be used.", + "description": "The time when the billing credits become effective i.e when they are eligible to be used.", "format": "unix-time", "nullable": true, "type": "integer" }, "expires_at": { - "description": "The time when the credit will expire. If not present, the credit will never expire.", + "description": "The time when the billing credits will expire. If not present, the billing credits will never expire.", "format": "unix-time", "nullable": true, "type": "integer" @@ -3545,7 +3623,7 @@ "type": "object" }, "name": { - "description": "A descriptive name shown in dashboard and on invoices.", + "description": "A descriptive name shown in dashboard.", "maxLength": 5000, "nullable": true, "type": "string" @@ -3612,7 +3690,7 @@ "x-resourceId": "billing.credit_grant" }, "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.", + "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.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)", "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -3914,7 +3992,7 @@ "nullable": true }, "type": { - "description": "The type of this amount. We currently only support `monetary` credits.", + "description": "The type of this amount. We currently only support `monetary` billing credits.", "enum": [ "monetary" ], @@ -3983,7 +4061,7 @@ "$ref": "#/components/schemas/invoice" } ], - "description": "The invoice to which the credits were applied.", + "description": "The invoice to which the billing credits were applied.", "x-expansionResources": { "oneOf": [ { @@ -3993,7 +4071,7 @@ } }, "invoice_line_item": { - "description": "The invoice line item to which the credits were applied.", + "description": "The invoice line item to which the billing credits were applied.", "maxLength": 5000, "type": "string" } @@ -4020,7 +4098,7 @@ "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_applied" } ], - "description": "Details of how the credits were applied to an invoice. Only present if `type` is `credits_applied`.", + "description": "Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.", "nullable": true }, "type": { @@ -4069,7 +4147,7 @@ "description": "", "properties": { "price_type": { - "description": "The price type to which credit grants can apply to. We currently only support `metered` price type.", + "description": "The price type to which credit grants can apply to. We currently only support `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.", "enum": [ "metered" ], @@ -7644,6 +7722,9 @@ ], "type": "string" }, + "alma": { + "$ref": "#/components/schemas/payment_method_alma" + }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_amazon_pay" }, @@ -7715,12 +7796,18 @@ "interac_present": { "$ref": "#/components/schemas/payment_method_interac_present" }, + "kakao_pay": { + "$ref": "#/components/schemas/payment_method_kakao_pay" + }, "klarna": { "$ref": "#/components/schemas/payment_method_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_konbini" }, + "kr_card": { + "$ref": "#/components/schemas/payment_method_kr_card" + }, "link": { "$ref": "#/components/schemas/payment_method_link" }, @@ -7730,12 +7817,18 @@ "multibanco": { "$ref": "#/components/schemas/payment_method_multibanco" }, + "naver_pay": { + "$ref": "#/components/schemas/payment_method_naver_pay" + }, "oxxo": { "$ref": "#/components/schemas/payment_method_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_p24" }, + "payco": { + "$ref": "#/components/schemas/payment_method_payco" + }, "paynow": { "$ref": "#/components/schemas/payment_method_paynow" }, @@ -7751,6 +7844,9 @@ "revolut_pay": { "$ref": "#/components/schemas/payment_method_revolut_pay" }, + "samsung_pay": { + "$ref": "#/components/schemas/payment_method_samsung_pay" + }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_sepa_debit" }, @@ -7770,6 +7866,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -7786,18 +7883,23 @@ "grabpay", "ideal", "interac_present", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -7830,6 +7932,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -7848,18 +7951,23 @@ "grabpay", "ideal", "interac_present", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -8022,8 +8130,12 @@ "connect_embedded_account_features_claim": { "description": "", "properties": { + "disable_stripe_user_authentication": { + "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` 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.", + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.", "type": "boolean" } }, @@ -8203,12 +8315,16 @@ "connect_embedded_payouts_features": { "description": "", "properties": { + "disable_stripe_user_authentication": { + "description": "Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.", + "type": "boolean" + }, "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.", + "description": "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.", "type": "boolean" }, "instant_payouts": { @@ -8713,6 +8829,7 @@ "type": "string" }, "pretax_credit_amounts": { + "description": "The pretax credit amounts (ex: discount, credit grants, etc) for all line items.", "items": { "$ref": "#/components/schemas/credit_notes_pretax_credit_amount" }, @@ -8894,6 +9011,7 @@ "type": "string" }, "pretax_credit_amounts": { + "description": "The pretax credit amounts (ex: discount, credit grants, etc) for this line item.", "items": { "$ref": "#/components/schemas/credit_notes_pretax_credit_amount" }, @@ -13681,6 +13799,15 @@ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", "type": "boolean" }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", + "nullable": true, + "type": "object" + }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ @@ -16054,6 +16181,7 @@ "type": "integer" }, "total_pretax_credit_amounts": { + "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, @@ -17283,14 +17411,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -17388,7 +17522,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`, `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`", + "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`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -17400,6 +17534,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -17435,6 +17570,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -17458,10 +17595,13 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -17578,25 +17718,6 @@ ] } }, - "margin": { - "anyOf": [ - { - "maxLength": 5000, - "type": "string" - }, - { - "$ref": "#/components/schemas/margin" - } - ], - "description": "The margin that was applied to get this pretax credit amount.", - "x-expansionResources": { - "oneOf": [ - { - "$ref": "#/components/schemas/margin" - } - ] - } - }, "type": { "description": "Type of the pretax credit amount referenced.", "enum": [ @@ -17615,8 +17736,7 @@ "type": "object", "x-expandableFields": [ "credit_balance_transaction", - "discount", - "margin" + "discount" ] }, "invoices_resource_shipping_cost": { @@ -17861,7 +17981,8 @@ "pending", "reversed" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "token": { "anyOf": [ @@ -24352,6 +24473,7 @@ "$ref": "#/components/schemas/invoice_line_item_period" }, "pretax_credit_amounts": { + "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.", "items": { "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount" }, @@ -24846,6 +24968,20 @@ "type": "object", "x-expandableFields": [] }, + "mandate_kakao_pay": { + "description": "", + "properties": {}, + "title": "mandate_kakao_pay", + "type": "object", + "x-expandableFields": [] + }, + "mandate_kr_card": { + "description": "", + "properties": {}, + "title": "mandate_kr_card", + "type": "object", + "x-expandableFields": [] + }, "mandate_link": { "description": "", "properties": {}, @@ -24881,6 +25017,12 @@ "cashapp": { "$ref": "#/components/schemas/mandate_cashapp" }, + "kakao_pay": { + "$ref": "#/components/schemas/mandate_kakao_pay" + }, + "kr_card": { + "$ref": "#/components/schemas/mandate_kr_card" + }, "link": { "$ref": "#/components/schemas/mandate_link" }, @@ -24914,6 +25056,8 @@ "bacs_debit", "card", "cashapp", + "kakao_pay", + "kr_card", "link", "paypal", "revolut_pay", @@ -25006,72 +25150,6 @@ "type": "object", "x-expandableFields": [] }, - "margin": { - "description": "A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who\nresell products and services and earn a discount (margin) for doing so.", - "properties": { - "active": { - "description": "Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.", - "type": "boolean" - }, - "created": { - "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", - "format": "unix-time", - "type": "integer" - }, - "id": { - "description": "Unique identifier for the object.", - "maxLength": 5000, - "type": "string" - }, - "livemode": { - "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", - "type": "boolean" - }, - "metadata": { - "additionalProperties": { - "maxLength": 500, - "type": "string" - }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", - "nullable": true, - "type": "object" - }, - "name": { - "description": "Name of the margin that's displayed on, for example, invoices.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value.", - "enum": [ - "margin" - ], - "type": "string" - }, - "percent_off": { - "description": "Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.", - "type": "number" - }, - "updated": { - "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", - "format": "unix-time", - "type": "integer" - } - }, - "required": [ - "active", - "created", - "id", - "livemode", - "object", - "percent_off", - "updated" - ], - "title": "Margin", - "type": "object", - "x-expandableFields": [] - }, "networks": { "description": "", "properties": { @@ -25665,6 +25743,29 @@ "type": "object", "x-expandableFields": [] }, + "payment_flows_private_payment_methods_kakao_pay_payment_method_options": { + "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", + "off_session" + ], + "type": "string" + } + }, + "title": "PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "payment_flows_private_payment_methods_klarna_dob": { "description": "", "properties": { @@ -25688,6 +25789,51 @@ "type": "object", "x-expandableFields": [] }, + "payment_flows_private_payment_methods_naver_pay_payment_method_options": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + } + }, + "title": "PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, + "payment_flows_private_payment_methods_payco_payment_method_options": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + } + }, + "title": "PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, + "payment_flows_private_payment_methods_samsung_pay_payment_method_options": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + } + }, + "title": "PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions", + "type": "object", + "x-expandableFields": [] + }, "payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters": { "description": "", "properties": { @@ -26985,6 +27131,16 @@ } ] }, + "alma": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_options_alma" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "amazon_pay": { "anyOf": [ { @@ -27145,6 +27301,16 @@ } ] }, + "kakao_pay": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "klarna": { "anyOf": [ { @@ -27165,6 +27331,16 @@ } ] }, + "kr_card": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_options_kr_card" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "link": { "anyOf": [ { @@ -27195,6 +27371,16 @@ } ] }, + "naver_pay": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "oxxo": { "anyOf": [ { @@ -27215,6 +27401,16 @@ } ] }, + "payco": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "paynow": { "anyOf": [ { @@ -27265,6 +27461,16 @@ } ] }, + "samsung_pay": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options" + }, + { + "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client" + } + ] + }, "sepa_debit": { "anyOf": [ { @@ -27343,6 +27549,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -27359,18 +27566,23 @@ "grabpay", "ideal", "interac_present", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -28095,6 +28307,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "au_becs_debit", "bacs_debit", "bancontact", @@ -29266,6 +29479,9 @@ ], "type": "string" }, + "alma": { + "$ref": "#/components/schemas/payment_method_alma" + }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_amazon_pay" }, @@ -29347,12 +29563,18 @@ "interac_present": { "$ref": "#/components/schemas/payment_method_interac_present" }, + "kakao_pay": { + "$ref": "#/components/schemas/payment_method_kakao_pay" + }, "klarna": { "$ref": "#/components/schemas/payment_method_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_konbini" }, + "kr_card": { + "$ref": "#/components/schemas/payment_method_kr_card" + }, "link": { "$ref": "#/components/schemas/payment_method_link" }, @@ -29375,6 +29597,9 @@ "multibanco": { "$ref": "#/components/schemas/payment_method_multibanco" }, + "naver_pay": { + "$ref": "#/components/schemas/payment_method_naver_pay" + }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": [ @@ -29388,6 +29613,9 @@ "p24": { "$ref": "#/components/schemas/payment_method_p24" }, + "payco": { + "$ref": "#/components/schemas/payment_method_payco" + }, "paynow": { "$ref": "#/components/schemas/payment_method_paynow" }, @@ -29406,6 +29634,9 @@ "revolut_pay": { "$ref": "#/components/schemas/payment_method_revolut_pay" }, + "samsung_pay": { + "$ref": "#/components/schemas/payment_method_samsung_pay" + }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_sepa_debit" }, @@ -29425,6 +29656,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -29441,18 +29673,23 @@ "grabpay", "ideal", "interac_present", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -29489,6 +29726,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -29507,19 +29745,24 @@ "grabpay", "ideal", "interac_present", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "radar_options", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -29582,6 +29825,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_alma": { + "description": "", + "properties": {}, + "title": "payment_method_alma", + "type": "object", + "x-expandableFields": [] + }, "payment_method_amazon_pay": { "description": "", "properties": {}, @@ -30287,6 +30537,9 @@ "alipay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, + "alma": { + "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" + }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties" }, @@ -30448,6 +30701,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "apple_pay", "au_becs_debit", @@ -30515,6 +30769,9 @@ "alipay": { "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details" }, + "alma": { + "$ref": "#/components/schemas/payment_method_details_alma" + }, "amazon_pay": { "$ref": "#/components/schemas/payment_method_details_amazon_pay" }, @@ -30563,12 +30820,18 @@ "interac_present": { "$ref": "#/components/schemas/payment_method_details_interac_present" }, + "kakao_pay": { + "$ref": "#/components/schemas/payment_method_details_kakao_pay" + }, "klarna": { "$ref": "#/components/schemas/payment_method_details_klarna" }, "konbini": { "$ref": "#/components/schemas/payment_method_details_konbini" }, + "kr_card": { + "$ref": "#/components/schemas/payment_method_details_kr_card" + }, "link": { "$ref": "#/components/schemas/payment_method_details_link" }, @@ -30578,12 +30841,18 @@ "multibanco": { "$ref": "#/components/schemas/payment_method_details_multibanco" }, + "naver_pay": { + "$ref": "#/components/schemas/payment_method_details_naver_pay" + }, "oxxo": { "$ref": "#/components/schemas/payment_method_details_oxxo" }, "p24": { "$ref": "#/components/schemas/payment_method_details_p24" }, + "payco": { + "$ref": "#/components/schemas/payment_method_details_payco" + }, "paynow": { "$ref": "#/components/schemas/payment_method_details_paynow" }, @@ -30599,6 +30868,9 @@ "revolut_pay": { "$ref": "#/components/schemas/payment_method_details_revolut_pay" }, + "samsung_pay": { + "$ref": "#/components/schemas/payment_method_details_samsung_pay" + }, "sepa_debit": { "$ref": "#/components/schemas/payment_method_details_sepa_debit" }, @@ -30644,6 +30916,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -30660,18 +30933,23 @@ "grabpay", "ideal", "interac_present", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "stripe_account", @@ -30839,6 +31117,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_alma": { + "description": "", + "properties": {}, + "title": "payment_method_details_alma", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_amazon_pay": { "description": "", "properties": {}, @@ -32164,6 +32449,20 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_kakao_pay": { + "description": "", + "properties": { + "buyer_id": { + "description": "A unique identifier for the buyer as determined by the local payment processor.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "payment_method_details_kakao_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_klarna": { "description": "", "properties": { @@ -32233,6 +32532,55 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_kr_card": { + "description": "", + "properties": { + "brand": { + "description": "The local credit or debit card brand.", + "enum": [ + "bc", + "citi", + "hana", + "hyundai", + "jeju", + "jeonbuk", + "kakaobank", + "kbank", + "kdbbank", + "kookmin", + "kwangju", + "lotte", + "mg", + "nh", + "post", + "samsung", + "savingsbank", + "shinhan", + "shinhyup", + "suhyup", + "tossbank", + "woori" + ], + "nullable": true, + "type": "string" + }, + "buyer_id": { + "description": "A unique identifier for the buyer as determined by the local payment processor.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "last4": { + "description": "The last four digits of the card. This may not be present for American Express cards.", + "maxLength": 4, + "nullable": true, + "type": "string" + } + }, + "title": "payment_method_details_kr_card", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_link": { "description": "", "properties": { @@ -32286,6 +32634,20 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_naver_pay": { + "description": "", + "properties": { + "buyer_id": { + "description": "A unique identifier for the buyer as determined by the local payment processor.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "payment_method_details_naver_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_oxxo": { "description": "", "properties": { @@ -32353,6 +32715,20 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_payco": { + "description": "", + "properties": { + "buyer_id": { + "description": "A unique identifier for the buyer as determined by the local payment processor.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "payment_method_details_payco", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_paynow": { "description": "", "properties": { @@ -32445,6 +32821,20 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_details_samsung_pay": { + "description": "", + "properties": { + "buyer_id": { + "description": "A unique identifier for the buyer as determined by the local payment processor.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "payment_method_details_samsung_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_details_sepa_debit": { "description": "", "properties": { @@ -32744,6 +33134,9 @@ "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 guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", "properties": { + "amazon_pay": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, "apple_pay": { "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" }, @@ -32788,6 +33181,7 @@ } }, "required": [ + "amazon_pay", "apple_pay", "created", "domain_name", @@ -32802,6 +33196,7 @@ "title": "PaymentMethodDomainResourcePaymentMethodDomain", "type": "object", "x-expandableFields": [ + "amazon_pay", "apple_pay", "google_pay", "link", @@ -33100,6 +33495,13 @@ "networks" ] }, + "payment_method_kakao_pay": { + "description": "", + "properties": {}, + "title": "payment_method_kakao_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_klarna": { "description": "", "properties": { @@ -33126,6 +33528,49 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_kr_card": { + "description": "", + "properties": { + "brand": { + "description": "The local credit or debit card brand.", + "enum": [ + "bc", + "citi", + "hana", + "hyundai", + "jeju", + "jeonbuk", + "kakaobank", + "kbank", + "kdbbank", + "kookmin", + "kwangju", + "lotte", + "mg", + "nh", + "post", + "samsung", + "savingsbank", + "shinhan", + "shinhyup", + "suhyup", + "tossbank", + "woori" + ], + "nullable": true, + "type": "string" + }, + "last4": { + "description": "The last four digits of the card. This may not be present for American Express cards.", + "maxLength": 4, + "nullable": true, + "type": "string" + } + }, + "title": "payment_method_kr_card", + "type": "object", + "x-expandableFields": [] + }, "payment_method_link": { "description": "", "properties": { @@ -33154,6 +33599,26 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_naver_pay": { + "description": "", + "properties": { + "funding": { + "description": "Whether to fund this transaction with Naver Pay points or a card.", + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "required": [ + "funding" + ], + "title": "payment_method_naver_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_affirm": { "description": "", "properties": { @@ -33226,6 +33691,21 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_options_alma": { + "description": "", + "properties": { + "capture_method": { + "description": "Controls when the funds will be captured from the customer's account.", + "enum": [ + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_alma", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_amazon_pay": { "description": "", "properties": { @@ -33706,6 +34186,29 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_options_kr_card": { + "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", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_kr_card", + "type": "object", + "x-expandableFields": [] + }, "payment_method_options_multibanco": { "description": "", "properties": { @@ -34028,6 +34531,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_payco": { + "description": "", + "properties": {}, + "title": "payment_method_payco", + "type": "object", + "x-expandableFields": [] + }, "payment_method_paynow": { "description": "", "properties": {}, @@ -34076,6 +34586,13 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_samsung_pay": { + "description": "", + "properties": {}, + "title": "payment_method_samsung_pay", + "type": "object", + "x-expandableFields": [] + }, "payment_method_sepa_debit": { "description": "", "properties": { @@ -35323,7 +35840,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`, `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`", + "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`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -35335,6 +35852,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -35370,6 +35888,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -35393,10 +35913,13 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -35930,7 +36453,7 @@ "nullable": true }, "gender": { - "description": "The person's gender (International regulations require either \"male\" or \"female\").", + "description": "The person's gender.", "nullable": true, "type": "string" }, @@ -36955,6 +37478,45 @@ "type": "object", "x-expandableFields": [] }, + "portal_resource_schedule_update_at_period_end": { + "description": "", + "properties": { + "conditions": { + "description": "List of conditions. When any condition is true, an update will be scheduled at the end of the current period.", + "items": { + "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end_condition" + }, + "type": "array" + } + }, + "required": [ + "conditions" + ], + "title": "PortalResourceScheduleUpdateAtPeriodEnd", + "type": "object", + "x-expandableFields": [ + "conditions" + ] + }, + "portal_resource_schedule_update_at_period_end_condition": { + "description": "", + "properties": { + "type": { + "description": "The type of condition.", + "enum": [ + "decreasing_item_amount", + "shortening_interval" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "PortalResourceScheduleUpdateAtPeriodEndCondition", + "type": "object", + "x-expandableFields": [] + }, "portal_subscription_cancel": { "description": "", "properties": { @@ -37063,6 +37625,9 @@ "none" ], "type": "string" + }, + "schedule_at_period_end": { + "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end" } }, "required": [ @@ -37073,7 +37638,8 @@ "title": "PortalSubscriptionUpdate", "type": "object", "x-expandableFields": [ - "products" + "products", + "schedule_at_period_end" ] }, "portal_subscription_update_product": { @@ -39146,6 +39712,9 @@ "alipay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, + "alma": { + "$ref": "#/components/schemas/destination_details_unimplemented" + }, "amazon_pay": { "$ref": "#/components/schemas/destination_details_unimplemented" }, @@ -39242,6 +39811,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_bank_transfer", "blik", @@ -40134,9 +40704,15 @@ "ideal": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_ideal" }, + "kakao_pay": { + "$ref": "#/components/schemas/setup_attempt_payment_method_details_kakao_pay" + }, "klarna": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_klarna" }, + "kr_card": { + "$ref": "#/components/schemas/setup_attempt_payment_method_details_kr_card" + }, "link": { "$ref": "#/components/schemas/setup_attempt_payment_method_details_link" }, @@ -40177,7 +40753,9 @@ "card_present", "cashapp", "ideal", + "kakao_pay", "klarna", + "kr_card", "link", "paypal", "revolut_pay", @@ -40610,6 +41188,13 @@ "generated_sepa_debit_mandate" ] }, + "setup_attempt_payment_method_details_kakao_pay": { + "description": "", + "properties": {}, + "title": "setup_attempt_payment_method_details_kakao_pay", + "type": "object", + "x-expandableFields": [] + }, "setup_attempt_payment_method_details_klarna": { "description": "", "properties": {}, @@ -40617,6 +41202,13 @@ "type": "object", "x-expandableFields": [] }, + "setup_attempt_payment_method_details_kr_card": { + "description": "", + "properties": {}, + "title": "setup_attempt_payment_method_details_kr_card", + "type": "object", + "x-expandableFields": [] + }, "setup_attempt_payment_method_details_link": { "description": "", "properties": {}, @@ -45068,14 +45660,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -46065,7 +46663,7 @@ "nullable": true }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_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`", + "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`, `by_tin`, `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`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -46077,6 +46675,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -46112,6 +46711,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -46135,10 +46736,13 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -46231,6 +46835,9 @@ "bh": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" }, + "by": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "ca": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada" }, @@ -46243,6 +46850,9 @@ "co": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, + "cr": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "cy": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -46255,6 +46865,9 @@ "dk": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, + "ec": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "ee": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -46318,6 +46931,12 @@ "lv": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, + "ma": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "md": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "mt": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, @@ -46351,6 +46970,12 @@ "ro": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" }, + "rs": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "ru": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "sa": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, @@ -46372,9 +46997,15 @@ "tr": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, + "tz": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "us": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states" }, + "uz": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, "vn": { "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" }, @@ -46391,14 +47022,17 @@ "be", "bg", "bh", + "by", "ca", "ch", "cl", "co", + "cr", "cy", "cz", "de", "dk", + "ec", "ee", "eg", "es", @@ -46420,6 +47054,8 @@ "lt", "lu", "lv", + "ma", + "md", "mt", "mx", "my", @@ -46431,6 +47067,8 @@ "pl", "pt", "ro", + "rs", + "ru", "sa", "se", "sg", @@ -46438,7 +47076,9 @@ "sk", "th", "tr", + "tz", "us", + "uz", "vn", "za" ] @@ -46588,6 +47228,7 @@ "local_amusement_tax", "local_lease_tax", "state_communications_tax", + "state_retail_delivery_fee", "state_sales_tax" ], "type": "string", @@ -46739,7 +47380,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`, `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`", + "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`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`", "enum": [ "ad_nrt", "ae_trn", @@ -46751,6 +47392,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -46786,6 +47428,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -46809,10 +47453,13 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -46965,6 +47612,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -47155,11 +47803,29 @@ "nullable": true, "type": "string" }, + "flat_amount": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_rate_flat_amount" + } + ], + "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", + "nullable": true + }, "percentage_decimal": { "description": "The tax rate percentage as a string. For example, 8.5% is represented as `\"8.5\"`.", "maxLength": 5000, "type": "string" }, + "rate_type": { + "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.", + "enum": [ + "flat_amount", + "percentage" + ], + "nullable": true, + "type": "string" + }, "state": { "description": "State, county, province, or region.", "maxLength": 5000, @@ -47178,6 +47844,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -47192,7 +47859,9 @@ ], "title": "TaxProductResourceTaxRateDetails", "type": "object", - "x-expandableFields": [] + "x-expandableFields": [ + "flat_amount" + ] }, "tax_product_resource_tax_settings_defaults": { "description": "", @@ -47379,6 +48048,15 @@ "nullable": true, "type": "number" }, + "flat_amount": { + "anyOf": [ + { + "$ref": "#/components/schemas/tax_rate_flat_amount" + } + ], + "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -47431,6 +48109,15 @@ "description": "Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.", "type": "number" }, + "rate_type": { + "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.", + "enum": [ + "flat_amount", + "percentage" + ], + "nullable": true, + "type": "string" + }, "state": { "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", "maxLength": 5000, @@ -47449,6 +48136,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -47470,9 +48158,32 @@ ], "title": "TaxRate", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "flat_amount" + ], "x-resourceId": "tax_rate" }, + "tax_rate_flat_amount": { + "description": "The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.", + "properties": { + "amount": { + "description": "Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).", + "type": "integer" + }, + "currency": { + "description": "Three-letter ISO currency code, in lowercase.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "amount", + "currency" + ], + "title": "TaxRateFlatAmount", + "type": "object", + "x-expandableFields": [] + }, "terminal.configuration": { "description": "A Configurations object represents how features should be configured for terminal readers.", "properties": { @@ -47870,6 +48581,9 @@ "nzd": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, + "pln": { + "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" + }, "sek": { "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config" }, @@ -47894,6 +48608,7 @@ "myr", "nok", "nzd", + "pln", "sek", "sgd", "usd" @@ -49665,7 +50380,7 @@ "type": "array" }, "status": { - "description": "The enum specifying what state the account is in.", + "description": "Status of this FinancialAccount.", "enum": [ "closed", "open" @@ -49860,7 +50575,8 @@ "processing", "succeeded" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "status_transitions": { "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions" @@ -52106,7 +52822,7 @@ "x-resourceId": "usage_record" }, "usage_record_summary": { - "description": "", + "description": "A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.", "properties": { "id": { "description": "Unique identifier for the object.", @@ -52350,7 +53066,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve account" } }, "/v1/account_links": { @@ -52464,7 +53181,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an account link" } }, "/v1/account_sessions": { @@ -52501,6 +53219,9 @@ }, "features": { "properties": { + "disable_stripe_user_authentication": { + "type": "boolean" + }, "external_account_collection": { "type": "boolean" } @@ -52522,6 +53243,9 @@ }, "features": { "properties": { + "disable_stripe_user_authentication": { + "type": "boolean" + }, "external_account_collection": { "type": "boolean" } @@ -52543,6 +53267,9 @@ }, "features": { "properties": { + "disable_stripe_user_authentication": { + "type": "boolean" + }, "edit_payout_schedule": { "type": "boolean" }, @@ -52590,6 +53317,9 @@ }, "features": { "properties": { + "disable_stripe_user_authentication": { + "type": "boolean" + }, "external_account_collection": { "type": "boolean" } @@ -52671,6 +53401,9 @@ }, "features": { "properties": { + "disable_stripe_user_authentication": { + "type": "boolean" + }, "edit_payout_schedule": { "type": "boolean" }, @@ -52789,7 +53522,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an Account Session" } }, "/v1/accounts": { @@ -52946,7 +53680,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all connected accounts" }, "post": { "description": "

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

\n\n

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

", @@ -52983,6 +53718,10 @@ "explode": true, "style": "deepObject" }, + "groups": { + "explode": true, + "style": "deepObject" + }, "individual": { "explode": true, "style": "deepObject" @@ -53243,6 +53982,15 @@ "title": "capability_param", "type": "object" }, + "alma_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "amazon_pay_payments": { "properties": { "requested": { @@ -53423,6 +54171,15 @@ "title": "capability_param", "type": "object" }, + "kakao_pay_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "klarna_payments": { "properties": { "requested": { @@ -53441,6 +54198,15 @@ "title": "capability_param", "type": "object" }, + "kr_card_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "legacy_payments": { "properties": { "requested": { @@ -53486,6 +54252,15 @@ "title": "capability_param", "type": "object" }, + "naver_pay_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "oxxo_payments": { "properties": { "requested": { @@ -53504,6 +54279,15 @@ "title": "capability_param", "type": "object" }, + "payco_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "paynow_payments": { "properties": { "requested": { @@ -53531,6 +54315,15 @@ "title": "capability_param", "type": "object" }, + "samsung_pay_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "sepa_bank_transfer_payments": { "properties": { "requested": { @@ -54043,6 +54836,27 @@ "type": "string", "x-stripeBypassValidation": true }, + "groups": { + "description": "A hash of account group type to tokens. These are account groups this account should be added to", + "properties": { + "payments_pricing": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "account_groups_specs", + "type": "object" + }, "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": { @@ -54724,7 +55538,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete an account" }, "get": { "description": "

Retrieves the details of an account.

", @@ -54790,7 +55605,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve account" }, "post": { "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.

", @@ -54831,6 +55647,10 @@ "explode": true, "style": "deepObject" }, + "groups": { + "explode": true, + "style": "deepObject" + }, "individual": { "explode": true, "style": "deepObject" @@ -55009,6 +55829,15 @@ "title": "capability_param", "type": "object" }, + "alma_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "amazon_pay_payments": { "properties": { "requested": { @@ -55189,6 +56018,15 @@ "title": "capability_param", "type": "object" }, + "kakao_pay_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "klarna_payments": { "properties": { "requested": { @@ -55207,6 +56045,15 @@ "title": "capability_param", "type": "object" }, + "kr_card_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "legacy_payments": { "properties": { "requested": { @@ -55252,6 +56099,15 @@ "title": "capability_param", "type": "object" }, + "naver_pay_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "oxxo_payments": { "properties": { "requested": { @@ -55270,6 +56126,15 @@ "title": "capability_param", "type": "object" }, + "payco_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "paynow_payments": { "properties": { "requested": { @@ -55297,6 +56162,15 @@ "title": "capability_param", "type": "object" }, + "samsung_pay_payments": { + "properties": { + "requested": { + "type": "boolean" + } + }, + "title": "capability_param", + "type": "object" + }, "sepa_bank_transfer_payments": { "properties": { "requested": { @@ -55750,6 +56624,27 @@ "type": "string", "x-stripeBypassValidation": true }, + "groups": { + "description": "A hash of account group type to tokens. These are account groups this account should be added to", + "properties": { + "payments_pricing": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "account_groups_specs", + "type": "object" + }, "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": { @@ -56392,7 +57287,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an account" } }, "/v1/accounts/{account}/bank_accounts": { @@ -56566,7 +57462,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an external account" } }, "/v1/accounts/{account}/bank_accounts/{id}": { @@ -56628,7 +57525,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete an external account" }, "get": { "description": "

Retrieve a specified external account for a given account.

", @@ -56703,7 +57601,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an external account" }, "post": { "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.

", @@ -57000,7 +57899,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all account capabilities" } }, "/v1/accounts/{account}/capabilities/{capability}": { @@ -57077,7 +57977,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an Account Capability" }, "post": { "description": "

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

", @@ -57155,7 +58056,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an Account Capability" } }, "/v1/accounts/{account}/external_accounts": { @@ -57314,7 +58216,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all external accounts" }, "post": { "description": "

Create an external account for a given account.

", @@ -57486,7 +58389,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an external account" } }, "/v1/accounts/{account}/external_accounts/{id}": { @@ -57548,7 +58452,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete an external account" }, "get": { "description": "

Retrieve a specified external account for a given account.

", @@ -57623,7 +58528,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an external account" }, "post": { "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.

", @@ -57884,7 +58790,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a login link" } }, "/v1/accounts/{account}/people": { @@ -58048,7 +58955,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all persons" }, "post": { "description": "

Creates a new person.

", @@ -58615,7 +59523,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a person" } }, "/v1/accounts/{account}/people/{person}": { @@ -58678,7 +59587,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a person" }, "get": { "description": "

Retrieves an existing person.

", @@ -58754,7 +59664,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a person" }, "post": { "description": "

Updates an existing person.

", @@ -59331,7 +60242,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a person" } }, "/v1/accounts/{account}/persons": { @@ -59495,7 +60407,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all persons" }, "post": { "description": "

Creates a new person.

", @@ -60062,7 +60975,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a person" } }, "/v1/accounts/{account}/persons/{person}": { @@ -60125,7 +61039,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a person" }, "get": { "description": "

Retrieves an existing person.

", @@ -60201,7 +61116,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a person" }, "post": { "description": "

Updates an existing person.

", @@ -60778,7 +61694,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a person" } }, "/v1/accounts/{account}/reject": { @@ -60853,7 +61770,8 @@ }, "description": "Error response." } - } + }, + "summary": "Reject an account" } }, "/v1/apple_pay/domains": { @@ -61337,7 +62255,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all application fees" } }, "/v1/application_fees/{fee}/refunds/{id}": { @@ -61415,7 +62334,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an application fee refund" }, "post": { "description": "

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

\n\n

This request only accepts metadata as an argument.

", @@ -61511,7 +62431,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an application fee refund" } }, "/v1/application_fees/{id}": { @@ -61579,7 +62500,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an application fee" } }, "/v1/application_fees/{id}/refund": { @@ -61789,7 +62711,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all application fee refunds" }, "post": { "description": "

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

\n\n

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

\n\n

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

", @@ -61869,7 +62792,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an application fee refund" } }, "/v1/apps/secrets": { @@ -62023,7 +62947,8 @@ }, "description": "Error response." } - } + }, + "summary": "List secrets" }, "post": { "description": "

Create or replace a secret in the secret store.

", @@ -62121,7 +63046,8 @@ }, "description": "Error response." } - } + }, + "summary": "Set a Secret" } }, "/v1/apps/secrets/delete": { @@ -62210,7 +63136,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a Secret" } }, "/v1/apps/secrets/find": { @@ -62307,7 +63234,8 @@ }, "description": "Error response." } - } + }, + "summary": "Find a Secret" } }, "/v1/balance": { @@ -62365,7 +63293,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve balance" } }, "/v1/balance/history": { @@ -62567,7 +63496,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all balance transactions" } }, "/v1/balance/history/{id}": { @@ -62635,7 +63565,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a balance transaction" } }, "/v1/balance_transactions": { @@ -62837,7 +63768,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all balance transactions" } }, "/v1/balance_transactions/{id}": { @@ -62905,7 +63837,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a balance transaction" } }, "/v1/billing/alerts": { @@ -63056,7 +63989,8 @@ }, "description": "Error response." } - } + }, + "summary": "List billing alerts" }, "post": { "description": "

Creates a billing alert

", @@ -63177,7 +64111,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a billing alert" } }, "/v1/billing/alerts/{id}": { @@ -63245,7 +64180,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a billing alert" } }, "/v1/billing/alerts/{id}/activate": { @@ -63312,7 +64248,8 @@ }, "description": "Error response." } - } + }, + "summary": "Activate a billing alert" } }, "/v1/billing/alerts/{id}/archive": { @@ -63379,7 +64316,8 @@ }, "description": "Error response." } - } + }, + "summary": "Archive a billing alert" } }, "/v1/billing/alerts/{id}/deactivate": { @@ -63446,7 +64384,8 @@ }, "description": "Error response." } - } + }, + "summary": "Deactivate a billing alert" } }, "/v1/billing/credit_balance_summary": { @@ -63558,7 +64497,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve the credit balance summary for a customer" } }, "/v1/billing/credit_balance_transactions": { @@ -63706,7 +64646,8 @@ }, "description": "Error response." } - } + }, + "summary": "List credit balance transactions" } }, "/v1/billing/credit_balance_transactions/{id}": { @@ -63775,7 +64716,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a credit balance transaction" } }, "/v1/billing/credit_grants": { @@ -63912,7 +64854,8 @@ }, "description": "Error response." } - } + }, + "summary": "List credit grants" }, "post": { "description": "

Creates a credit grant

", @@ -64007,12 +64950,12 @@ "type": "string" }, "customer": { - "description": "Id of the customer to whom the credit should be granted.", + "description": "ID of the customer to whom the billing credits should be granted.", "maxLength": 5000, "type": "string" }, "effective_at": { - "description": "The time when the credit becomes effective i.e when it is eligible to be used. Defaults to the current timestamp if not specified.", + "description": "The time when the billing credits become effective i.e when they are eligible to be used. Defaults to the current timestamp if not specified.", "format": "unix-time", "type": "integer" }, @@ -64025,7 +64968,7 @@ "type": "array" }, "expires_at": { - "description": "The time when the credit will expire. If not specified, the credit will never expire.", + "description": "The time when the billing credits will expire. If not specified, the billing credits will never expire.", "format": "unix-time", "type": "integer" }, @@ -64037,8 +64980,8 @@ "type": "object" }, "name": { - "description": "A descriptive name shown in dashboard and on invoices.", - "maxLength": 250, + "description": "A descriptive name shown in dashboard.", + "maxLength": 100, "type": "string" } }, @@ -64075,7 +65018,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a credit grant" } }, "/v1/billing/credit_grants/{id}": { @@ -64144,7 +65088,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a credit grant" }, "post": { "description": "

Updates a credit grant

", @@ -64203,7 +65148,7 @@ "type": "string" } ], - "description": "The time when the credit created by this credit grant will expire. If set to empty, the credit will never expire." + "description": "The time when the billing credits created by this credit grant will expire. If set to empty, the billing credits will never expire." }, "metadata": { "additionalProperties": { @@ -64240,7 +65185,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a credit grant" } }, "/v1/billing/credit_grants/{id}/expire": { @@ -64308,7 +65254,8 @@ }, "description": "Error response." } - } + }, + "summary": "Expire a credit grant" } }, "/v1/billing/credit_grants/{id}/void": { @@ -64376,7 +65323,8 @@ }, "description": "Error response." } - } + }, + "summary": "Void a credit grant" } }, "/v1/billing/meter_event_adjustments": { @@ -64462,7 +65410,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a billing meter event adjustment" } }, "/v1/billing/meter_events": { @@ -64547,7 +65496,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a billing meter event" } }, "/v1/billing/meters": { @@ -64687,7 +65637,8 @@ }, "description": "Error response." } - } + }, + "summary": "List billing meters" }, "post": { "description": "

Creates a billing meter

", @@ -64827,7 +65778,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a billing meter" } }, "/v1/billing/meters/{id}": { @@ -64896,7 +65848,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a billing meter" }, "post": { "description": "

Updates a billing meter

", @@ -64967,7 +65920,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a billing meter" } }, "/v1/billing/meters/{id}/deactivate": { @@ -65035,7 +65989,8 @@ }, "description": "Error response." } - } + }, + "summary": "Deactivate a billing meter" } }, "/v1/billing/meters/{id}/event_summaries": { @@ -65219,7 +66174,8 @@ }, "description": "Error response." } - } + }, + "summary": "List billing meter event summaries" } }, "/v1/billing/meters/{id}/reactivate": { @@ -65287,7 +66243,8 @@ }, "description": "Error response." } - } + }, + "summary": "Reactivate a billing meter" } }, "/v1/billing_portal/configurations": { @@ -65433,7 +66390,8 @@ }, "description": "Error response." } - } + }, + "summary": "List portal configurations" }, "post": { "description": "

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

", @@ -65715,6 +66673,31 @@ "none" ], "type": "string" + }, + "schedule_at_period_end": { + "properties": { + "conditions": { + "items": { + "properties": { + "type": { + "enum": [ + "decreasing_item_amount", + "shortening_interval" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "schedule_update_at_period_end_condition_param", + "type": "object" + }, + "type": "array" + } + }, + "title": "schedule_update_at_period_end_creating_param", + "type": "object" } }, "required": [ @@ -65749,7 +66732,6 @@ } }, "required": [ - "business_profile", "features" ], "type": "object" @@ -65779,7 +66761,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a portal configuration" } }, "/v1/billing_portal/configurations/{configuration}": { @@ -65847,7 +66830,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a portal configuration" }, "post": { "description": "

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

", @@ -66158,6 +67142,41 @@ "none" ], "type": "string" + }, + "schedule_at_period_end": { + "properties": { + "conditions": { + "anyOf": [ + { + "items": { + "properties": { + "type": { + "enum": [ + "decreasing_item_amount", + "shortening_interval" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "schedule_update_at_period_end_condition_param", + "type": "object" + }, + "type": "array" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + } + }, + "title": "schedule_update_at_period_end_updating_param", + "type": "object" } }, "title": "subscription_update_updating_param", @@ -66225,7 +67244,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a portal configuration" } }, "/v1/billing_portal/sessions": { @@ -66525,7 +67545,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a portal session" } }, "/v1/charges": { @@ -66715,7 +67736,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all charges" }, "post": { "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.

", @@ -67183,7 +68205,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search charges" } }, "/v1/charges/{charge}": { @@ -67251,7 +68274,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a charge" }, "post": { "description": "

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

", @@ -67440,7 +68464,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a charge" } }, "/v1/charges/{charge}/capture": { @@ -67551,7 +68576,8 @@ }, "description": "Error response." } - } + }, + "summary": "Capture a payment" } }, "/v1/charges/{charge}/dispute": { @@ -68006,7 +69032,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a refund" } }, "/v1/charges/{charge}/refunds": { @@ -68139,7 +69166,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all refunds" }, "post": { "description": "

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

\n\n

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

\n\n

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

\n\n

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

", @@ -68272,7 +69300,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create customer balance refund" } }, "/v1/charges/{charge}/refunds/{refund}": { @@ -68678,7 +69707,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Checkout Sessions" }, "post": { "description": "

Creates a Session object.

", @@ -70345,6 +71375,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -70359,18 +71390,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -71039,7 +72075,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Session" } }, "/v1/checkout/sessions/{session}": { @@ -71107,7 +72144,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Session" }, "post": { "description": "

Updates a Session object.

", @@ -71193,7 +72231,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a Session" } }, "/v1/checkout/sessions/{session}/expire": { @@ -71260,7 +72299,8 @@ }, "description": "Error response." } - } + }, + "summary": "Expire a Session" } }, "/v1/checkout/sessions/{session}/line_items": { @@ -71396,7 +72436,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Checkout Session's line items" } }, "/v1/climate/orders": { @@ -71522,7 +72563,8 @@ }, "description": "Error response." } - } + }, + "summary": "List orders" }, "post": { "description": "

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

", @@ -71626,7 +72668,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an order" } }, "/v1/climate/orders/{order}": { @@ -71695,7 +72738,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an order" }, "post": { "description": "

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

", @@ -71810,7 +72854,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an order" } }, "/v1/climate/orders/{order}/cancel": { @@ -71878,7 +72923,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel an order" } }, "/v1/climate/products": { @@ -72004,7 +73050,8 @@ }, "description": "Error response." } - } + }, + "summary": "List products" } }, "/v1/climate/products/{product}": { @@ -72072,7 +73119,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a product" } }, "/v1/climate/suppliers": { @@ -72198,7 +73246,8 @@ }, "description": "Error response." } - } + }, + "summary": "List suppliers" } }, "/v1/climate/suppliers/{supplier}": { @@ -72266,7 +73315,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a supplier" } }, "/v1/confirmation_tokens/{confirmation_token}": { @@ -72334,7 +73384,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a ConfirmationToken" } }, "/v1/country_specs": { @@ -72460,7 +73511,8 @@ }, "description": "Error response." } - } + }, + "summary": "List Country Specs" } }, "/v1/country_specs/{country}": { @@ -72528,7 +73580,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Country Spec" } }, "/v1/coupons": { @@ -72687,7 +73740,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all coupons" }, "post": { "description": "

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

\n\n

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

", @@ -72844,7 +73898,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a coupon" } }, "/v1/coupons/{coupon}": { @@ -72897,7 +73952,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a coupon" }, "get": { "description": "

Retrieves the coupon with the given ID.

", @@ -72963,7 +74019,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a coupon" }, "post": { "description": "

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

", @@ -73074,7 +74131,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a coupon" } }, "/v1/credit_notes": { @@ -73254,7 +74312,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all credit notes" }, "post": { "description": "

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

\n\n\n\n

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

\n\n

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

", @@ -73485,7 +74544,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a credit note" } }, "/v1/credit_notes/preview": { @@ -73787,7 +74847,8 @@ }, "description": "Error response." } - } + }, + "summary": "Preview a credit note" } }, "/v1/credit_notes/preview/lines": { @@ -74157,7 +75218,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a credit note preview's line items" } }, "/v1/credit_notes/{credit_note}/lines": { @@ -74293,7 +75355,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a credit note's line items" } }, "/v1/credit_notes/{id}": { @@ -74361,7 +75424,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a credit note" }, "post": { "description": "

Updates an existing credit note.

", @@ -74442,7 +75506,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a credit note" } }, "/v1/credit_notes/{id}/void": { @@ -74509,7 +75574,8 @@ }, "description": "Error response." } - } + }, + "summary": "Void a credit note" } }, "/v1/customer_sessions": { @@ -74671,7 +75737,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Customer Session" } }, "/v1/customers": { @@ -74852,7 +75919,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all customers" }, "post": { "description": "

Creates a new customer object.

", @@ -74930,7 +75998,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, { @@ -75147,7 +76215,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, "name": { @@ -75204,7 +76272,7 @@ "type": "string" } }, - "title": "tax_param", + "title": "shared_tax_create_param", "type": "object" }, "tax_exempt": { @@ -75233,6 +76301,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -75268,6 +76337,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -75291,9 +76362,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -75348,7 +76422,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a customer" } }, "/v1/customers/search": { @@ -75480,7 +76555,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search customers" } }, "/v1/customers/{customer}": { @@ -75533,7 +76609,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a customer" }, "get": { "description": "

Retrieves a Customer object.

", @@ -75606,7 +76683,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a customer" }, "post": { "description": "

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

\n\n

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

", @@ -75700,7 +76778,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, { @@ -76062,7 +77140,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, "name": { @@ -76113,13 +77191,14 @@ }, "validate_location": { "enum": [ + "auto", "deferred", "immediately" ], "type": "string" } }, - "title": "tax_param", + "title": "shared_tax_update_param", "type": "object" }, "tax_exempt": { @@ -76160,7 +77239,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a customer" } }, "/v1/customers/{customer}/balance_transactions": { @@ -76296,7 +77376,8 @@ }, "description": "Error response." } - } + }, + "summary": "List customer balance transactions" }, "post": { "description": "

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

", @@ -76399,7 +77480,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a customer balance transaction" } }, "/v1/customers/{customer}/balance_transactions/{transaction}": { @@ -76476,7 +77558,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a customer balance transaction" }, "post": { "description": "

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

", @@ -76577,7 +77660,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a customer credit balance transaction" } }, "/v1/customers/{customer}/bank_accounts": { @@ -76712,7 +77796,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all bank accounts" }, "post": { "description": "

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

\n\n

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

", @@ -76936,7 +78021,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a card" } }, "/v1/customers/{customer}/bank_accounts/{id}": { @@ -77019,7 +78105,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a customer source" }, "get": { "deprecated": true, @@ -77096,7 +78183,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a bank account" }, "post": { "description": "

Update a specified source for a given customer.

", @@ -77400,7 +78488,8 @@ }, "description": "Error response." } - } + }, + "summary": "Verify a bank account" } }, "/v1/customers/{customer}/cards": { @@ -77534,7 +78623,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all cards" }, "post": { "description": "

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

\n\n

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

", @@ -77758,7 +78848,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a card" } }, "/v1/customers/{customer}/cards/{id}": { @@ -77841,7 +78932,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a customer source" }, "get": { "deprecated": true, @@ -77918,7 +79010,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a card" }, "post": { "description": "

Update a specified source for a given customer.

", @@ -78202,7 +79295,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a cash balance" }, "post": { "description": "

Changes the settings on a customer’s cash balance.

", @@ -78286,7 +79380,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a cash balance's settings" } }, "/v1/customers/{customer}/cash_balance_transactions": { @@ -78422,7 +79517,8 @@ }, "description": "Error response." } - } + }, + "summary": "List cash balance transactions" } }, "/v1/customers/{customer}/cash_balance_transactions/{transaction}": { @@ -78499,7 +79595,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a cash balance transaction" } }, "/v1/customers/{customer}/discount": { @@ -78552,7 +79649,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a customer discount" }, "get": { "description": "", @@ -78752,7 +79850,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create or retrieve funding instructions for a customer cash balance" } }, "/v1/customers/{customer}/payment_methods": { @@ -78841,6 +79940,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -78855,18 +79955,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -78950,7 +80055,8 @@ }, "description": "Error response." } - } + }, + "summary": "List a Customer's PaymentMethods" } }, "/v1/customers/{customer}/payment_methods/{payment_method}": { @@ -79028,7 +80134,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Customer's PaymentMethod" } }, "/v1/customers/{customer}/sources": { @@ -79409,7 +80516,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a card" } }, "/v1/customers/{customer}/sources/{id}": { @@ -79492,7 +80600,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a customer source" }, "get": { "description": "

Retrieve a specified source for a given customer.

", @@ -79872,7 +80981,8 @@ }, "description": "Error response." } - } + }, + "summary": "Verify a bank account" } }, "/v1/customers/{customer}/subscriptions": { @@ -80008,7 +81118,8 @@ }, "description": "Error response." } - } + }, + "summary": "List active subscriptions" }, "post": { "description": "

Creates a new subscription on an existing customer.

", @@ -80879,14 +81990,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -81058,7 +82175,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a subscription" } }, "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { @@ -81143,7 +82261,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a subscription" }, "get": { "description": "

Retrieves the subscription with the given ID.

", @@ -81219,7 +82338,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a subscription" }, "post": { "description": "

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

", @@ -82218,14 +83338,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -82408,7 +83534,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a subscription on a customer" } }, "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { @@ -82471,7 +83598,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a customer discount" }, "get": { "description": "", @@ -82683,7 +83811,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Customer tax IDs" }, "post": { "description": "

Creates a new tax_id object for a customer.

", @@ -82721,7 +83850,7 @@ "type": "array" }, "type": { - "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_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`", + "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`, `by_tin`, `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`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -82733,6 +83862,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -82768,6 +83898,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -82791,9 +83923,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -82838,7 +83973,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Customer tax ID" } }, "/v1/customers/{customer}/tax_ids/{id}": { @@ -82900,7 +84036,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a Customer tax ID" }, "get": { "description": "

Retrieves the tax_id object with the given identifier.

", @@ -82975,7 +84112,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Customer tax ID" } }, "/v1/disputes": { @@ -83156,7 +84294,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all disputes" } }, "/v1/disputes/{dispute}": { @@ -83224,7 +84363,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a dispute" }, "post": { "description": "

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

\n\n

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

", @@ -83424,7 +84564,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a dispute" } }, "/v1/disputes/{dispute}/close": { @@ -83491,7 +84632,8 @@ }, "description": "Error response." } - } + }, + "summary": "Close a dispute" } }, "/v1/entitlements/active_entitlements": { @@ -83627,7 +84769,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all active entitlements" } }, "/v1/entitlements/active_entitlements/{id}": { @@ -83696,7 +84839,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an active entitlement" } }, "/v1/entitlements/features": { @@ -83843,7 +84987,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all features" }, "post": { "description": "

Creates a feature

", @@ -83921,7 +85066,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a feature" } }, "/v1/entitlements/features/{id}": { @@ -83990,7 +85136,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a feature" }, "post": { "description": "

Update a feature’s metadata or permanently deactivate it.

", @@ -84085,7 +85232,8 @@ }, "description": "Error response." } - } + }, + "summary": "Updates a feature" } }, "/v1/ephemeral_keys": { @@ -84160,7 +85308,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an ephemeral key" } }, "/v1/ephemeral_keys/{key}": { @@ -84227,7 +85376,8 @@ }, "description": "Error response." } - } + }, + "summary": "Immediately invalidate an ephemeral key" } }, "/v1/events": { @@ -84422,7 +85572,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all events" } }, "/v1/events/{id}": { @@ -84490,7 +85641,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an event" } }, "/v1/exchange_rates": { @@ -84616,7 +85768,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all exchange rates" } }, "/v1/exchange_rates/{rate_id}": { @@ -84684,7 +85837,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an exchange rate" } }, "/v1/file_links": { @@ -84863,7 +86017,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all file links" }, "post": { "description": "

Creates a new file link object.

", @@ -84950,7 +86105,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a file link" } }, "/v1/file_links/{link}": { @@ -85017,7 +86173,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a file link" }, "post": { "description": "

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

", @@ -85128,7 +86285,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a file link" } }, "/v1/files": { @@ -85317,7 +86475,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all files" }, "post": { "description": "

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

\n\n

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

", @@ -85439,7 +86598,8 @@ { "url": "https://files.stripe.com/" } - ] + ], + "summary": "Create a file" } }, "/v1/files/{file}": { @@ -85507,7 +86667,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a file" } }, "/v1/financial_connections/accounts": { @@ -85667,7 +86828,8 @@ }, "description": "Error response." } - } + }, + "summary": "List Accounts" } }, "/v1/financial_connections/accounts/{account}": { @@ -85735,7 +86897,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an Account" } }, "/v1/financial_connections/accounts/{account}/disconnect": { @@ -85802,7 +86965,8 @@ }, "description": "Error response." } - } + }, + "summary": "Disconnect an Account" } }, "/v1/financial_connections/accounts/{account}/owners": { @@ -85949,7 +87113,8 @@ }, "description": "Error response." } - } + }, + "summary": "List Account Owners" } }, "/v1/financial_connections/accounts/{account}/refresh": { @@ -86036,7 +87201,8 @@ }, "description": "Error response." } - } + }, + "summary": "Refresh Account data" } }, "/v1/financial_connections/accounts/{account}/subscribe": { @@ -86121,7 +87287,8 @@ }, "description": "Error response." } - } + }, + "summary": "Subscribe to data refreshes for an Account" } }, "/v1/financial_connections/accounts/{account}/unsubscribe": { @@ -86206,7 +87373,8 @@ }, "description": "Error response." } - } + }, + "summary": "Unsubscribe from data refreshes for an Account" } }, "/v1/financial_connections/sessions": { @@ -86366,7 +87534,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Session" } }, "/v1/financial_connections/sessions/{session}": { @@ -86434,7 +87603,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Session" } }, "/v1/financial_connections/transactions": { @@ -86626,7 +87796,8 @@ }, "description": "Error response." } - } + }, + "summary": "List Transactions" } }, "/v1/financial_connections/transactions/{transaction}": { @@ -86694,7 +87865,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Transaction" } }, "/v1/forwarding/requests": { @@ -86845,7 +88017,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all ForwardingRequests" }, "post": { "description": "

Creates a ForwardingRequest object.

", @@ -86858,6 +88031,10 @@ "explode": true, "style": "deepObject" }, + "metadata": { + "explode": true, + "style": "deepObject" + }, "replacements": { "explode": true, "style": "deepObject" @@ -86878,6 +88055,13 @@ }, "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_method": { "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.", "maxLength": 5000, @@ -86966,7 +88150,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a ForwardingRequest" } }, "/v1/forwarding/requests/{id}": { @@ -87034,7 +88219,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a ForwardingRequest" } }, "/v1/identity/verification_reports": { @@ -87230,7 +88416,8 @@ }, "description": "Error response." } - } + }, + "summary": "List VerificationReports" } }, "/v1/identity/verification_reports/{report}": { @@ -87298,7 +88485,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a VerificationReport" } }, "/v1/identity/verification_sessions": { @@ -87494,7 +88682,8 @@ }, "description": "Error response." } - } + }, + "summary": "List VerificationSessions" }, "post": { "description": "

Creates a VerificationSession object.

\n\n

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

\n\n

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

\n\n

Related guide: Verify your users’ identity documents

", @@ -87650,7 +88839,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a VerificationSession" } }, "/v1/identity/verification_sessions/{session}": { @@ -87718,7 +88908,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a VerificationSession" }, "post": { "description": "

Updates a VerificationSession object.

\n\n

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

", @@ -87867,7 +89058,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a VerificationSession" } }, "/v1/identity/verification_sessions/{session}/cancel": { @@ -87934,7 +89126,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a VerificationSession" } }, "/v1/identity/verification_sessions/{session}/redact": { @@ -88001,7 +89194,8 @@ }, "description": "Error response." } - } + }, + "summary": "Redact a VerificationSession" } }, "/v1/invoice_rendering_templates": { @@ -88140,7 +89334,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all invoice rendering templates" } }, "/v1/invoice_rendering_templates/{template}": { @@ -88217,7 +89412,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an invoice rendering template" } }, "/v1/invoice_rendering_templates/{template}/archive": { @@ -88284,7 +89480,8 @@ }, "description": "Error response." } - } + }, + "summary": "Archive an invoice rendering template" } }, "/v1/invoice_rendering_templates/{template}/unarchive": { @@ -88351,7 +89548,8 @@ }, "description": "Error response." } - } + }, + "summary": "Unarchive an invoice rendering template" } }, "/v1/invoiceitems": { @@ -88542,7 +89740,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all invoice items" }, "post": { "description": "

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

", @@ -88804,7 +90003,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an invoice item" } }, "/v1/invoiceitems/{invoiceitem}": { @@ -88857,7 +90057,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete an invoice item" }, "get": { "description": "

Retrieves the invoice item with the given ID.

", @@ -88923,7 +90124,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an invoice item" }, "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.

", @@ -89185,7 +90387,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an invoice item" } }, "/v1/invoices": { @@ -89430,7 +90633,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all invoices" }, "post": { "description": "

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

", @@ -90075,14 +91279,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -90412,7 +91622,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an invoice" } }, "/v1/invoices/create_preview": { @@ -90583,7 +91794,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, "name": { @@ -90653,6 +91864,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -90688,6 +91900,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -90711,9 +91925,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -91833,7 +93050,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a preview invoice" } }, "/v1/invoices/search": { @@ -91965,7 +93183,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search invoices" } }, "/v1/invoices/upcoming": { @@ -92123,7 +93342,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, "name": { @@ -92193,6 +93412,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -92228,6 +93448,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -92251,9 +93473,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -93788,7 +95013,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an upcoming invoice" } }, "/v1/invoices/upcoming/lines": { @@ -93946,7 +95172,7 @@ "type": "string" } }, - "title": "optional_fields_address", + "title": "optional_fields_customer_address", "type": "object" }, "name": { @@ -94016,6 +95242,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -94051,6 +95278,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -94074,9 +95303,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -95679,7 +96911,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an upcoming invoice's line items" } }, "/v1/invoices/{invoice}": { @@ -95732,7 +96965,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a draft invoice" }, "get": { "description": "

Retrieves the invoice with the given ID.

", @@ -95798,7 +97032,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an invoice" }, "post": { "description": "

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

\n\n

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

", @@ -96486,14 +97721,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -96839,7 +98080,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an invoice" } }, "/v1/invoices/{invoice}/add_lines": { @@ -97076,7 +98318,7 @@ "type": "string" }, "display_name": { - "maxLength": 50, + "maxLength": 100, "type": "string" }, "inclusive": { @@ -97104,6 +98346,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -97196,7 +98439,8 @@ }, "description": "Error response." } - } + }, + "summary": "Bulk add invoice line items" } }, "/v1/invoices/{invoice}/finalize": { @@ -97267,7 +98511,8 @@ }, "description": "Error response." } - } + }, + "summary": "Finalize an invoice" } }, "/v1/invoices/{invoice}/lines": { @@ -97403,7 +98648,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an invoice's line items" } }, "/v1/invoices/{invoice}/lines/{line_item_id}": { @@ -97652,7 +98898,7 @@ "type": "string" }, "display_name": { - "maxLength": 50, + "maxLength": 100, "type": "string" }, "inclusive": { @@ -97680,6 +98926,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -97765,7 +99012,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an invoice's line item" } }, "/v1/invoices/{invoice}/mark_uncollectible": { @@ -97832,7 +99080,8 @@ }, "description": "Error response." } - } + }, + "summary": "Mark an invoice as uncollectible" } }, "/v1/invoices/{invoice}/pay": { @@ -97940,7 +99189,8 @@ }, "description": "Error response." } - } + }, + "summary": "Pay an invoice" } }, "/v1/invoices/{invoice}/remove_lines": { @@ -98060,7 +99310,8 @@ }, "description": "Error response." } - } + }, + "summary": "Bulk remove invoice line items" } }, "/v1/invoices/{invoice}/send": { @@ -98127,7 +99378,8 @@ }, "description": "Error response." } - } + }, + "summary": "Send an invoice for manual payment" } }, "/v1/invoices/{invoice}/update_lines": { @@ -98364,7 +99616,7 @@ "type": "string" }, "display_name": { - "maxLength": 50, + "maxLength": 100, "type": "string" }, "inclusive": { @@ -98392,6 +99644,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -98487,7 +99740,8 @@ }, "description": "Error response." } - } + }, + "summary": "Bulk update invoice line items" } }, "/v1/invoices/{invoice}/void": { @@ -98554,7 +99808,8 @@ }, "description": "Error response." } - } + }, + "summary": "Void an invoice" } }, "/v1/issuing/authorizations": { @@ -98675,7 +99930,8 @@ "pending", "reversed" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "style": "form" } @@ -98750,7 +100006,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all authorizations" } }, "/v1/issuing/authorizations/{authorization}": { @@ -98818,7 +100075,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an authorization" }, "post": { "description": "

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

", @@ -98904,7 +100162,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update an authorization" } }, "/v1/issuing/authorizations/{authorization}/approve": { @@ -98997,7 +100256,8 @@ }, "description": "Error response." } - } + }, + "summary": "Approve an authorization" } }, "/v1/issuing/authorizations/{authorization}/decline": { @@ -99086,7 +100346,8 @@ }, "description": "Error response." } - } + }, + "summary": "Decline an authorization" } }, "/v1/issuing/cardholders": { @@ -99295,7 +100556,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all cardholders" }, "post": { "description": "

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

", @@ -100532,7 +101794,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a cardholder" } }, "/v1/issuing/cardholders/{cardholder}": { @@ -100600,7 +101863,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a cardholder" }, "post": { "description": "

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

", @@ -101832,7 +103096,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a cardholder" } }, "/v1/issuing/cards": { @@ -102073,7 +103338,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all cards" }, "post": { "description": "

Creates an Issuing Card object.

", @@ -102182,7 +103448,7 @@ "type": "string" } ], - "description": "The second line to print on the card." + "description": "The second line to print on the card. Max length: 24 characters." }, "shipping": { "description": "The address where the card will be shipped.", @@ -103292,7 +104558,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a card" } }, "/v1/issuing/cards/{card}": { @@ -103360,7 +104627,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a card" }, "post": { "description": "

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

", @@ -104552,7 +105820,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a card" } }, "/v1/issuing/disputes": { @@ -104739,7 +106008,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all disputes" }, "post": { "description": "

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

", @@ -105491,7 +106761,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a dispute" } }, "/v1/issuing/disputes/{dispute}": { @@ -105559,7 +106830,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a dispute" }, "post": { "description": "

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

", @@ -106310,7 +107582,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a dispute" } }, "/v1/issuing/disputes/{dispute}/submit": { @@ -106398,7 +107671,8 @@ }, "description": "Error response." } - } + }, + "summary": "Submit a dispute" } }, "/v1/issuing/personalization_designs": { @@ -106575,7 +107849,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all personalization designs" }, "post": { "description": "

Creates a personalization design object.

", @@ -106749,7 +108024,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a personalization design" } }, "/v1/issuing/personalization_designs/{personalization_design}": { @@ -106817,7 +108093,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a personalization design" }, "post": { "description": "

Updates a card personalization object.

", @@ -107052,7 +108329,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a personalization design" } }, "/v1/issuing/physical_bundles": { @@ -107207,7 +108485,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all physical bundles" } }, "/v1/issuing/physical_bundles/{physical_bundle}": { @@ -107275,7 +108554,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a physical bundle" } }, "/v1/issuing/settlements/{settlement}": { @@ -107343,7 +108623,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a settlement" }, "post": { "description": "

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

", @@ -107419,7 +108700,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a settlement" } }, "/v1/issuing/tokens": { @@ -107604,7 +108886,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all issuing tokens for card" } }, "/v1/issuing/tokens/{token}": { @@ -107672,7 +108955,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an issuing token" }, "post": { "description": "

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

", @@ -107749,7 +109033,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a token status" } }, "/v1/issuing/transactions": { @@ -107945,7 +109230,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all transactions" } }, "/v1/issuing/transactions/{transaction}": { @@ -108013,7 +109299,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a transaction" }, "post": { "description": "

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

", @@ -108099,7 +109386,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a transaction" } }, "/v1/link_account_sessions": { @@ -108259,7 +109547,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Session" } }, "/v1/link_account_sessions/{session}": { @@ -108327,7 +109616,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Session" } }, "/v1/linked_accounts": { @@ -108487,7 +109777,8 @@ }, "description": "Error response." } - } + }, + "summary": "List Accounts" } }, "/v1/linked_accounts/{account}": { @@ -108555,7 +109846,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an Account" } }, "/v1/linked_accounts/{account}/disconnect": { @@ -108622,7 +109914,8 @@ }, "description": "Error response." } - } + }, + "summary": "Disconnect an Account" } }, "/v1/linked_accounts/{account}/owners": { @@ -108769,7 +110062,8 @@ }, "description": "Error response." } - } + }, + "summary": "List Account Owners" } }, "/v1/linked_accounts/{account}/refresh": { @@ -108856,7 +110150,8 @@ }, "description": "Error response." } - } + }, + "summary": "Refresh Account data" } }, "/v1/mandates/{mandate}": { @@ -108923,7 +110218,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Mandate" } }, "/v1/payment_intents": { @@ -109093,7 +110389,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all PaymentIntents" }, "post": { "description": "

Creates a PaymentIntent object.

\n\n

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

\n\n

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

", @@ -109384,6 +110681,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -109662,6 +110964,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -109693,6 +111000,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -109714,6 +111026,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -109757,6 +111083,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -109792,6 +111123,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -109841,6 +111177,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -109854,18 +111191,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -110092,6 +111434,29 @@ } ] }, + "alma": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "amazon_pay": { "anyOf": [ { @@ -110861,6 +112226,37 @@ } ] }, + "kakao_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "klarna": { "anyOf": [ { @@ -111020,6 +112416,37 @@ } ] }, + "kr_card": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "link": { "anyOf": [ { @@ -111102,6 +112529,29 @@ } ] }, + "naver_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "oxxo": { "anyOf": [ { @@ -111152,6 +112602,29 @@ } ] }, + "payco": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "paynow": { "anyOf": [ { @@ -111322,6 +112795,29 @@ } ] }, + "samsung_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "sepa_debit": { "anyOf": [ { @@ -111794,7 +113290,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a PaymentIntent" } }, "/v1/payment_intents/search": { @@ -111926,7 +113423,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search PaymentIntents" } }, "/v1/payment_intents/{intent}": { @@ -112005,7 +113503,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a PaymentIntent" }, "post": { "description": "

Updates properties on a PaymentIntent object without confirming.

\n\n

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

", @@ -112191,6 +113690,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -112469,6 +113973,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -112500,6 +114009,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -112521,6 +114035,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -112564,6 +114092,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -112599,6 +114132,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -112648,6 +114186,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -112661,18 +114200,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -112899,6 +114443,29 @@ } ] }, + "alma": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "amazon_pay": { "anyOf": [ { @@ -113668,6 +115235,37 @@ } ] }, + "kakao_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "klarna": { "anyOf": [ { @@ -113827,6 +115425,37 @@ } ] }, + "kr_card": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "link": { "anyOf": [ { @@ -113909,6 +115538,29 @@ } ] }, + "naver_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "oxxo": { "anyOf": [ { @@ -113959,6 +115611,29 @@ } ] }, + "payco": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "paynow": { "anyOf": [ { @@ -114129,6 +115804,29 @@ } ] }, + "samsung_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "sepa_debit": { "anyOf": [ { @@ -114593,7 +116291,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a PaymentIntent" } }, "/v1/payment_intents/{intent}/apply_customer_balance": { @@ -114625,7 +116324,7 @@ "additionalProperties": false, "properties": { "amount": { - "description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency).\n\nThe maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.", + "description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.", "type": "integer" }, "currency": { @@ -114668,7 +116367,8 @@ }, "description": "Error response." } - } + }, + "summary": "Reconcile a customer_balance PaymentIntent" } }, "/v1/payment_intents/{intent}/cancel": { @@ -114747,7 +116447,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a PaymentIntent" } }, "/v1/payment_intents/{intent}/capture": { @@ -114871,7 +116572,8 @@ }, "description": "Error response." } - } + }, + "summary": "Capture a PaymentIntent" } }, "/v1/payment_intents/{intent}/confirm": { @@ -115142,6 +116844,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -115420,6 +117127,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -115451,6 +117163,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -115472,6 +117189,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -115515,6 +117246,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -115550,6 +117286,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -115599,6 +117340,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -115612,18 +117354,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -115850,6 +117597,29 @@ } ] }, + "alma": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "amazon_pay": { "anyOf": [ { @@ -116558,13 +118328,37 @@ } ] }, - "grabpay": { + "grabpay": { + "anyOf": [ + { + "properties": { + "setup_future_usage": { + "enum": [ + "none" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, + "ideal": { "anyOf": [ { "properties": { "setup_future_usage": { "enum": [ - "none" + "", + "none", + "off_session" ], "type": "string" } @@ -116580,19 +118374,10 @@ } ] }, - "ideal": { + "interac_present": { "anyOf": [ { - "properties": { - "setup_future_usage": { - "enum": [ - "", - "none", - "off_session" - ], - "type": "string" - } - }, + "properties": {}, "title": "payment_method_options_param", "type": "object" }, @@ -116604,10 +118389,26 @@ } ] }, - "interac_present": { + "kakao_pay": { "anyOf": [ { - "properties": {}, + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, "title": "payment_method_options_param", "type": "object" }, @@ -116778,6 +118579,37 @@ } ] }, + "kr_card": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + }, + "setup_future_usage": { + "enum": [ + "", + "none", + "off_session" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "link": { "anyOf": [ { @@ -116860,6 +118692,29 @@ } ] }, + "naver_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "oxxo": { "anyOf": [ { @@ -116910,6 +118765,29 @@ } ] }, + "payco": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "paynow": { "anyOf": [ { @@ -117080,6 +118958,29 @@ } ] }, + "samsung_pay": { + "anyOf": [ + { + "properties": { + "capture_method": { + "enum": [ + "", + "manual" + ], + "type": "string" + } + }, + "title": "payment_method_options_param", + "type": "object" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ] + }, "sepa_debit": { "anyOf": [ { @@ -117539,7 +119440,8 @@ }, "description": "Error response." } - } + }, + "summary": "Confirm a PaymentIntent" } }, "/v1/payment_intents/{intent}/increment_authorization": { @@ -117652,7 +119554,8 @@ }, "description": "Error response." } - } + }, + "summary": "Increment an authorization" } }, "/v1/payment_intents/{intent}/verify_microdeposits": { @@ -117740,7 +119643,8 @@ }, "description": "Error response." } - } + }, + "summary": "Verify microdeposits on a PaymentIntent" } }, "/v1/payment_links": { @@ -117876,7 +119780,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all payment links" }, "post": { "description": "

Creates a payment link.

", @@ -118561,6 +120466,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "au_becs_debit", "bacs_debit", "bancontact", @@ -119050,7 +120956,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a payment link" } }, "/v1/payment_links/{payment_link}": { @@ -119118,7 +121025,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve payment link" }, "post": { "description": "

Updates a payment link.

", @@ -119809,6 +121717,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "au_becs_debit", "bacs_debit", "bancontact", @@ -120283,7 +122192,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a payment link" } }, "/v1/payment_links/{payment_link}/line_items": { @@ -120419,7 +122329,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a payment link's line items" } }, "/v1/payment_method_configurations": { @@ -120567,7 +122478,8 @@ }, "description": "Error response." } - } + }, + "summary": "List payment method configurations" }, "post": { "description": "

Creates a payment method configuration

", @@ -120592,6 +122504,10 @@ "explode": true, "style": "deepObject" }, + "alma": { + "explode": true, + "style": "deepObject" + }, "amazon_pay": { "explode": true, "style": "deepObject" @@ -120832,6 +122748,27 @@ "title": "payment_method_param", "type": "object" }, + "alma": { + "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.", + "properties": { + "display_preference": { + "properties": { + "preference": { + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", "properties": { @@ -121565,7 +123502,7 @@ "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.", + "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-direct-debit) for more details.", "properties": { "display_preference": { "properties": { @@ -121655,7 +123592,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a payment method configuration" } }, "/v1/payment_method_configurations/{configuration}": { @@ -121723,7 +123661,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve payment method configuration" }, "post": { "description": "

Update payment method configuration

", @@ -121760,6 +123699,10 @@ "explode": true, "style": "deepObject" }, + "alma": { + "explode": true, + "style": "deepObject" + }, "amazon_pay": { "explode": true, "style": "deepObject" @@ -122004,6 +123947,27 @@ "title": "payment_method_param", "type": "object" }, + "alma": { + "description": "Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments.", + "properties": { + "display_preference": { + "properties": { + "preference": { + "enum": [ + "none", + "off", + "on" + ], + "type": "string" + } + }, + "title": "display_preference_param", + "type": "object" + } + }, + "title": "payment_method_param", + "type": "object" + }, "amazon_pay": { "description": "Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.", "properties": { @@ -122732,7 +124696,7 @@ "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.", + "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-direct-debit) for more details.", "properties": { "display_preference": { "properties": { @@ -122822,7 +124786,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update payment method configuration" } }, "/v1/payment_method_domains": { @@ -122969,7 +124934,8 @@ }, "description": "Error response." } - } + }, + "summary": "List payment method domains" }, "post": { "description": "

Creates a payment method domain.

", @@ -123034,7 +125000,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a payment method domain" } }, "/v1/payment_method_domains/{payment_method_domain}": { @@ -123102,7 +125069,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a payment method domain" }, "post": { "description": "

Updates an existing payment method domain.

", @@ -123171,7 +125139,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a payment method domain" } }, "/v1/payment_method_domains/{payment_method_domain}/validate": { @@ -123238,7 +125207,8 @@ }, "description": "Error response." } - } + }, + "summary": "Validate an existing payment method domain" } }, "/v1/payment_methods": { @@ -123313,6 +125283,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -123327,18 +125298,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -123423,7 +125399,8 @@ }, "description": "Error response." } - } + }, + "summary": "List PaymentMethods" }, "post": { "description": "

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

\n\n

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

", @@ -123448,6 +125425,10 @@ "explode": true, "style": "deepObject" }, + "alma": { + "explode": true, + "style": "deepObject" + }, "amazon_pay": { "explode": true, "style": "deepObject" @@ -123516,6 +125497,10 @@ "explode": true, "style": "deepObject" }, + "kakao_pay": { + "explode": true, + "style": "deepObject" + }, "klarna": { "explode": true, "style": "deepObject" @@ -123524,6 +125509,10 @@ "explode": true, "style": "deepObject" }, + "kr_card": { + "explode": true, + "style": "deepObject" + }, "link": { "explode": true, "style": "deepObject" @@ -123540,6 +125529,10 @@ "explode": true, "style": "deepObject" }, + "naver_pay": { + "explode": true, + "style": "deepObject" + }, "oxxo": { "explode": true, "style": "deepObject" @@ -123548,6 +125541,10 @@ "explode": true, "style": "deepObject" }, + "payco": { + "explode": true, + "style": "deepObject" + }, "paynow": { "explode": true, "style": "deepObject" @@ -123572,6 +125569,10 @@ "explode": true, "style": "deepObject" }, + "samsung_pay": { + "explode": true, + "style": "deepObject" + }, "sepa_debit": { "explode": true, "style": "deepObject" @@ -123655,6 +125656,12 @@ ], "type": "string" }, + "alma": { + "description": "If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "description": "If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.", "properties": {}, @@ -124019,6 +126026,12 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "description": "If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay 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": { @@ -124052,6 +126065,12 @@ "title": "param", "type": "object" }, + "kr_card": { + "description": "If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card 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": {}, @@ -124077,6 +126096,21 @@ "title": "param", "type": "object" }, + "naver_pay": { + "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "description": "If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.", "properties": {}, @@ -124122,6 +126156,12 @@ "title": "param", "type": "object" }, + "payco": { + "description": "If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.", + "properties": {}, + "title": "param", + "type": "object" + }, "payment_method": { "description": "The PaymentMethod to share.", "maxLength": 5000, @@ -124168,6 +126208,12 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "description": "If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay 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": { @@ -124222,6 +126268,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -124236,18 +126283,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -124332,7 +126384,8 @@ }, "description": "Error response." } - } + }, + "summary": "Shares a PaymentMethod" } }, "/v1/payment_methods/{payment_method}": { @@ -124400,7 +126453,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a PaymentMethod" }, "post": { "description": "

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

", @@ -124441,6 +126495,10 @@ "explode": true, "style": "deepObject" }, + "naver_pay": { + "explode": true, + "style": "deepObject" + }, "us_bank_account": { "explode": true, "style": "deepObject" @@ -124605,6 +126663,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`." }, + "naver_pay": { + "description": "If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.", + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "us_bank_account": { "description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.", "properties": { @@ -124654,7 +126727,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a PaymentMethod" } }, "/v1/payment_methods/{payment_method}/attach": { @@ -124729,7 +126803,8 @@ }, "description": "Error response." } - } + }, + "summary": "Attach a PaymentMethod to a Customer" } }, "/v1/payment_methods/{payment_method}/detach": { @@ -124796,7 +126871,8 @@ }, "description": "Error response." } - } + }, + "summary": "Detach a PaymentMethod from a Customer" } }, "/v1/payouts": { @@ -125009,7 +127085,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all payouts" }, "post": { "description": "

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

\n\n

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

\n\n

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

", @@ -125121,7 +127198,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a payout" } }, "/v1/payouts/{payout}": { @@ -125189,7 +127267,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a payout" }, "post": { "description": "

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

", @@ -125275,7 +127354,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a payout" } }, "/v1/payouts/{payout}/cancel": { @@ -125342,7 +127422,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a payout" } }, "/v1/payouts/{payout}/reverse": { @@ -125420,7 +127501,8 @@ }, "description": "Error response." } - } + }, + "summary": "Reverse a payout" } }, "/v1/plans": { @@ -125601,7 +127683,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all plans" }, "post": { "description": "

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

", @@ -125886,7 +127969,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a plan" } }, "/v1/plans/{plan}": { @@ -125939,7 +128023,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a plan" }, "get": { "description": "

Retrieves the plan with the given ID.

", @@ -126005,7 +128090,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a plan" }, "post": { "description": "

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

", @@ -126109,7 +128195,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a plan" } }, "/v1/prices": { @@ -126363,7 +128450,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all prices" }, "post": { "description": "

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

", @@ -126767,7 +128855,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a price" } }, "/v1/prices/search": { @@ -126899,7 +128988,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search prices" } }, "/v1/prices/{price}": { @@ -126967,7 +129057,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a price" }, "post": { "description": "

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

", @@ -127180,7 +129271,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a price" } }, "/v1/products": { @@ -127386,7 +129478,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all products" }, "post": { "description": "

Creates a new product object.

", @@ -127715,7 +129808,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a product" } }, "/v1/products/search": { @@ -127847,7 +129941,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search products" } }, "/v1/products/{id}": { @@ -127900,7 +129995,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a product" }, "get": { "description": "

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

", @@ -127966,7 +130062,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a product" }, "post": { "description": "

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

", @@ -128240,7 +130337,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a product" } }, "/v1/products/{product}/features": { @@ -128375,7 +130473,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all features attached to a product" }, "post": { "description": "

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

", @@ -128448,7 +130547,8 @@ }, "description": "Error response." } - } + }, + "summary": "Attach a feature to a product" } }, "/v1/products/{product}/features/{id}": { @@ -128511,7 +130611,8 @@ }, "description": "Error response." } - } + }, + "summary": "Remove a feature from a product" }, "get": { "description": "

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

", @@ -128589,7 +130690,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a product_feature" } }, "/v1/promotion_codes": { @@ -128791,7 +130893,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all promotion codes" }, "post": { "description": "

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

", @@ -128918,7 +131021,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a promotion code" } }, "/v1/promotion_codes/{promotion_code}": { @@ -128986,7 +131090,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a promotion code" }, "post": { "description": "

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

", @@ -129099,7 +131204,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a promotion code" } }, "/v1/quotes": { @@ -129264,7 +131370,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all quotes" }, "post": { "description": "

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

", @@ -129820,7 +131927,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a quote" } }, "/v1/quotes/{quote}": { @@ -129888,7 +131996,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a quote" }, "post": { "description": "

A quote models prices and services for a customer.

", @@ -130444,7 +132553,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a quote" } }, "/v1/quotes/{quote}/accept": { @@ -130511,7 +132621,8 @@ }, "description": "Error response." } - } + }, + "summary": "Accept a quote" } }, "/v1/quotes/{quote}/cancel": { @@ -130578,7 +132689,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a quote" } }, "/v1/quotes/{quote}/computed_upfront_line_items": { @@ -130714,7 +132826,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a quote's upfront line items" } }, "/v1/quotes/{quote}/finalize": { @@ -130786,7 +132899,8 @@ }, "description": "Error response." } - } + }, + "summary": "Finalize a quote" } }, "/v1/quotes/{quote}/line_items": { @@ -130922,7 +133036,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a quote's line items" } }, "/v1/quotes/{quote}/pdf": { @@ -130996,7 +133111,8 @@ { "url": "https://files.stripe.com/" } - ] + ], + "summary": "Download quote PDF" } }, "/v1/radar/early_fraud_warnings": { @@ -131176,7 +133292,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all early fraud warnings" } }, "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { @@ -131244,7 +133361,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an early fraud warning" } }, "/v1/radar/value_list_items": { @@ -131425,7 +133543,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all value list items" }, "post": { "description": "

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

", @@ -131492,7 +133611,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a value list item" } }, "/v1/radar/value_list_items/{item}": { @@ -131545,7 +133665,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a value list item" }, "get": { "description": "

Retrieves a ValueListItem object.

", @@ -131611,7 +133732,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a value list item" } }, "/v1/radar/value_lists": { @@ -131792,7 +133914,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all value lists" }, "post": { "description": "

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

", @@ -131887,7 +134010,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a value list" } }, "/v1/radar/value_lists/{value_list}": { @@ -131940,7 +134064,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a value list" }, "get": { "description": "

Retrieves a ValueList object.

", @@ -132006,7 +134131,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a value list" }, "post": { "description": "

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

", @@ -132092,7 +134218,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a value list" } }, "/v1/refunds": { @@ -132270,7 +134397,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all refunds" }, "post": { "description": "

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

\n\n

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

\n\n

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

\n\n

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

", @@ -132395,7 +134523,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create customer balance refund" } }, "/v1/refunds/{refund}": { @@ -132462,7 +134591,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a refund" }, "post": { "description": "

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

\n\n

This request only accepts metadata as an argument.

", @@ -132547,7 +134677,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a refund" } }, "/v1/refunds/{refund}/cancel": { @@ -132613,7 +134744,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a refund" } }, "/v1/reporting/report_runs": { @@ -132772,7 +134904,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Report Runs" }, "post": { "description": "

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

", @@ -133515,7 +135648,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Report Run" } }, "/v1/reporting/report_runs/{report_run}": { @@ -133583,7 +135717,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Report Run" } }, "/v1/reporting/report_types": { @@ -133676,7 +135811,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Report Types" } }, "/v1/reporting/report_types/{report_type}": { @@ -133743,7 +135879,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Report Type" } }, "/v1/reviews": { @@ -133901,7 +136038,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all open reviews" } }, "/v1/reviews/{review}": { @@ -133969,7 +136107,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a review" } }, "/v1/reviews/{review}/approve": { @@ -134036,7 +136175,8 @@ }, "description": "Error response." } - } + }, + "summary": "Approve a review" } }, "/v1/setup_attempts": { @@ -134206,7 +136346,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all SetupAttempts" } }, "/v1/setup_intents": { @@ -134397,7 +136538,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all SetupIntents" }, "post": { "description": "

Creates a SetupIntent object.

\n\n

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

", @@ -134641,6 +136783,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -134919,6 +137066,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -134950,6 +137102,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -134971,6 +137128,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -135014,6 +137185,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -135049,6 +137225,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -135098,6 +137279,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -135111,18 +137293,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -135656,7 +137843,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a SetupIntent" } }, "/v1/setup_intents/{intent}": { @@ -135735,7 +137923,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a SetupIntent" }, "post": { "description": "

Updates a SetupIntent object.

", @@ -135893,6 +138082,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -136171,6 +138365,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -136202,6 +138401,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -136223,6 +138427,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -136266,6 +138484,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -136301,6 +138524,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -136350,6 +138578,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -136363,18 +138592,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -136875,7 +139109,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a SetupIntent" } }, "/v1/setup_intents/{intent}/cancel": { @@ -136952,7 +139187,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a SetupIntent" } }, "/v1/setup_intents/{intent}/confirm": { @@ -137169,6 +139405,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -137447,6 +139688,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -137478,6 +139724,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -137499,6 +139750,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -137542,6 +139807,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -137577,6 +139847,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -137626,6 +139901,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -137639,18 +139915,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -138151,7 +140432,8 @@ }, "description": "Error response." } - } + }, + "summary": "Confirm a SetupIntent" } }, "/v1/setup_intents/{intent}/verify_microdeposits": { @@ -138239,7 +140521,8 @@ }, "description": "Error response." } - } + }, + "summary": "Verify microdeposits on a SetupIntent" } }, "/v1/shipping_rates": { @@ -138418,7 +140701,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all shipping rates" }, "post": { "description": "

Creates a new shipping rate object.

", @@ -138611,7 +140895,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a shipping rate" } }, "/v1/shipping_rates/{shipping_rate_token}": { @@ -138679,7 +140964,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a shipping rate" }, "post": { "description": "

Updates an existing shipping rate object.

", @@ -138809,7 +141095,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a shipping rate" } }, "/v1/sigma/scheduled_query_runs": { @@ -138935,7 +141222,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all scheduled query runs" } }, "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { @@ -139003,7 +141291,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a scheduled query run" } }, "/v1/sources": { @@ -139428,7 +141717,8 @@ }, "description": "Error response." } - } + }, + "summary": "Shares a source" } }, "/v1/sources/{source}": { @@ -139507,7 +141797,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a source" }, "post": { "description": "

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

\n\n

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

", @@ -139868,7 +142159,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a source" } }, "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { @@ -139946,7 +142238,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Source MandateNotification" } }, "/v1/sources/{source}/source_transactions": { @@ -140159,7 +142452,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a source transaction" } }, "/v1/sources/{source}/verify": { @@ -140376,7 +142670,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all subscription items" }, "post": { "description": "

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

", @@ -140625,7 +142920,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a subscription item" } }, "/v1/subscription_items/{item}": { @@ -140697,7 +142993,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a subscription item" }, "get": { "description": "

Retrieves the subscription item with the given ID.

", @@ -140763,7 +143060,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a subscription item" }, "post": { "description": "

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

", @@ -141030,7 +143328,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a subscription item" } }, "/v1/subscription_items/{subscription_item}/usage_record_summaries": { @@ -141164,7 +143463,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all subscription item period summaries" } }, "/v1/subscription_items/{subscription_item}/usage_records": { @@ -141265,7 +143565,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a usage record" } }, "/v1/subscription_schedules": { @@ -141544,7 +143845,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all schedules" }, "post": { "description": "

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

", @@ -142323,7 +144625,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a schedule" } }, "/v1/subscription_schedules/{schedule}": { @@ -142391,7 +144694,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a schedule" }, "post": { "description": "

Updates an existing subscription schedule.

", @@ -143195,7 +145499,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a schedule" } }, "/v1/subscription_schedules/{schedule}/cancel": { @@ -143270,7 +145575,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a schedule" } }, "/v1/subscription_schedules/{schedule}/release": { @@ -143341,7 +145647,8 @@ }, "description": "Error response." } - } + }, + "summary": "Release a schedule" } }, "/v1/subscriptions": { @@ -143655,7 +145962,8 @@ }, "description": "Error response." } - } + }, + "summary": "List subscriptions" }, "post": { "description": "

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

\n\n

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

\n\n

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

", @@ -144571,14 +146879,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -144753,7 +147067,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a subscription" } }, "/v1/subscriptions/search": { @@ -144885,7 +147200,8 @@ }, "description": "Error response." } - } + }, + "summary": "Search subscriptions" } }, "/v1/subscriptions/{subscription_exposed_id}": { @@ -144964,7 +147280,7 @@ "type": "array" }, "invoice_now": { - "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.", + "description": "Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.", "type": "boolean" }, "prorate": { @@ -144999,7 +147315,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a subscription" }, "get": { "description": "

Retrieves the subscription with the given ID.

", @@ -145065,7 +147382,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a subscription" }, "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 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.

", @@ -146091,14 +148409,20 @@ "giropay", "grabpay", "ideal", + "jp_credit_transfer", + "kakao_pay", "konbini", + "kr_card", "link", "multibanco", + "naver_pay", "p24", + "payco", "paynow", "paypal", "promptpay", "revolut_pay", + "sepa_credit_transfer", "sepa_debit", "sofort", "swish", @@ -146281,7 +148605,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a subscription" } }, "/v1/subscriptions/{subscription_exposed_id}/discount": { @@ -146334,7 +148659,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a subscription discount" } }, "/v1/subscriptions/{subscription}/resume": { @@ -146366,12 +148692,11 @@ "additionalProperties": false, "properties": { "billing_cycle_anchor": { - "description": "Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). Setting the value to `unchanged` advances the subscription's billing cycle anchor to the period that surrounds the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", + "description": "The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", "enum": [ "now", "unchanged" ], - "maxLength": 5000, "type": "string" }, "expand": { @@ -146424,7 +148749,8 @@ }, "description": "Error response." } - } + }, + "summary": "Resume a subscription" } }, "/v1/tax/calculations": { @@ -146579,6 +148905,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -146614,6 +148941,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -146637,9 +148966,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -146871,7 +149203,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Tax Calculation" } }, "/v1/tax/calculations/{calculation}": { @@ -146939,7 +149272,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Tax Calculation" } }, "/v1/tax/calculations/{calculation}/line_items": { @@ -147076,7 +149410,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a calculation's line items" } }, "/v1/tax/registrations": { @@ -147218,7 +149553,8 @@ }, "description": "Error response." } - } + }, + "summary": "List registrations" }, "post": { "description": "

Creates a new Tax Registration object.

", @@ -147414,6 +149750,21 @@ "title": "default", "type": "object" }, + "by": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "ca": { "properties": { "province_standard": { @@ -147489,6 +149840,21 @@ "title": "simplified", "type": "object" }, + "cr": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "cy": { "properties": { "standard": { @@ -147625,6 +149991,21 @@ "title": "europe", "type": "object" }, + "ec": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "ee": { "properties": { "standard": { @@ -148168,6 +150549,36 @@ "title": "europe", "type": "object" }, + "ma": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "md": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "mt": { "properties": { "standard": { @@ -148281,52 +150692,120 @@ "title": "europe", "type": "object" }, - "no": { - "properties": { - "type": { - "enum": [ - "standard" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "default", - "type": "object" - }, - "nz": { - "properties": { - "type": { - "enum": [ - "standard" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "default", - "type": "object" - }, - "om": { - "properties": { - "type": { - "enum": [ - "standard" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "default", - "type": "object" - }, - "pl": { + "no": { + "properties": { + "type": { + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "nz": { + "properties": { + "type": { + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "om": { + "properties": { + "type": { + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "pl": { + "properties": { + "standard": { + "properties": { + "place_of_supply_scheme": { + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "pt": { + "properties": { + "standard": { + "properties": { + "place_of_supply_scheme": { + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "ro": { "properties": { "standard": { "properties": { @@ -148360,29 +150839,10 @@ "title": "europe", "type": "object" }, - "pt": { + "rs": { "properties": { - "standard": { - "properties": { - "place_of_supply_scheme": { - "enum": [ - "small_seller", - "standard" - ], - "type": "string" - } - }, - "required": [ - "place_of_supply_scheme" - ], - "title": "standard", - "type": "object" - }, "type": { "enum": [ - "ioss", - "oss_non_union", - "oss_union", "standard" ], "type": "string" @@ -148391,33 +150851,14 @@ "required": [ "type" ], - "title": "europe", + "title": "default", "type": "object" }, - "ro": { + "ru": { "properties": { - "standard": { - "properties": { - "place_of_supply_scheme": { - "enum": [ - "small_seller", - "standard" - ], - "type": "string" - } - }, - "required": [ - "place_of_supply_scheme" - ], - "title": "standard", - "type": "object" - }, "type": { "enum": [ - "ioss", - "oss_non_union", - "oss_union", - "standard" + "simplified" ], "type": "string" } @@ -148425,7 +150866,7 @@ "required": [ "type" ], - "title": "europe", + "title": "simplified", "type": "object" }, "sa": { @@ -148590,6 +151031,21 @@ "title": "simplified", "type": "object" }, + "tz": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "us": { "properties": { "local_amusement_tax": { @@ -148660,6 +151116,7 @@ "local_amusement_tax", "local_lease_tax", "state_communications_tax", + "state_retail_delivery_fee", "state_sales_tax" ], "type": "string", @@ -148673,6 +151130,21 @@ "title": "united_states", "type": "object" }, + "uz": { + "properties": { + "type": { + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, "vn": { "properties": { "type": { @@ -148753,7 +151225,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a registration" } }, "/v1/tax/registrations/{id}": { @@ -148821,7 +151294,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a registration" }, "post": { "description": "

Updates an existing Tax Registration object.

\n\n

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

", @@ -148932,7 +151406,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a registration" } }, "/v1/tax/settings": { @@ -148990,7 +151465,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve settings" }, "post": { "description": "

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

", @@ -149109,7 +151585,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update settings" } }, "/v1/tax/transactions/create_from_calculation": { @@ -149194,7 +151671,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a transaction from a calculation" } }, "/v1/tax/transactions/create_reversal": { @@ -149351,7 +151829,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a reversal transaction" } }, "/v1/tax/transactions/{transaction}": { @@ -149419,7 +151898,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a transaction" } }, "/v1/tax/transactions/{transaction}/line_items": { @@ -149556,7 +152036,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a transaction's line items" } }, "/v1/tax_codes": { @@ -149679,7 +152160,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all tax codes" } }, "/v1/tax_codes/{id}": { @@ -149747,7 +152229,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a tax code" } }, "/v1/tax_ids": { @@ -149906,7 +152389,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all tax IDs" }, "post": { "description": "

Creates a new account or customer tax_id object.

", @@ -149962,7 +152446,7 @@ "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`", + "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`, `by_tin`, `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`, `ma_vat`, `md_vat`, `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`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`", "enum": [ "ad_nrt", "ae_trn", @@ -149974,6 +152458,7 @@ "bo_tin", "br_cnpj", "br_cpf", + "by_tin", "ca_bn", "ca_gst_hst", "ca_pst_bc", @@ -150009,6 +152494,8 @@ "kr_brn", "kz_bin", "li_uid", + "ma_vat", + "md_vat", "mx_rfc", "my_frp", "my_itn", @@ -150032,9 +152519,12 @@ "th_vat", "tr_tin", "tw_vat", + "tz_vat", "ua_vat", "us_ein", "uy_ruc", + "uz_tin", + "uz_vat", "ve_rif", "vn_tin", "za_vat" @@ -150079,7 +152569,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a tax ID" } }, "/v1/tax_ids/{id}": { @@ -150132,7 +152623,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a tax ID" }, "get": { "description": "

Retrieves an account or customer tax_id object.

", @@ -150198,7 +152690,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a tax ID" } }, "/v1/tax_rates": { @@ -150377,7 +152870,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all tax rates" }, "post": { "description": "

Creates a new tax rate.

", @@ -150462,6 +152956,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -150502,7 +152997,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a tax rate" } }, "/v1/tax_rates/{tax_rate}": { @@ -150570,7 +153066,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a tax rate" }, "post": { "description": "

Updates an existing tax rate.

", @@ -150669,6 +153166,7 @@ "lease_tax", "pst", "qst", + "retail_delivery_fee", "rst", "sales_tax", "vat" @@ -150704,7 +153202,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a tax rate" } }, "/v1/terminal/configurations": { @@ -150840,7 +153339,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Configurations" }, "post": { "description": "

Creates a new Configuration object.

", @@ -151209,6 +153709,27 @@ "title": "currency_specific_config", "type": "object" }, + "pln": { + "properties": { + "fixed_amounts": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "percentages": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "smart_tip_threshold": { + "type": "integer" + } + }, + "title": "currency_specific_config", + "type": "object" + }, "sek": { "properties": { "fixed_amounts": { @@ -151333,7 +153854,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Configuration" } }, "/v1/terminal/configurations/{configuration}": { @@ -151386,7 +153908,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a Configuration" }, "get": { "description": "

Retrieves a Configuration object.

", @@ -151459,7 +153982,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Configuration" }, "post": { "description": "

Updates a new Configuration object.

", @@ -151870,6 +154394,27 @@ "title": "currency_specific_config", "type": "object" }, + "pln": { + "properties": { + "fixed_amounts": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "percentages": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "smart_tip_threshold": { + "type": "integer" + } + }, + "title": "currency_specific_config", + "type": "object" + }, "sek": { "properties": { "fixed_amounts": { @@ -152011,7 +154556,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a Configuration" } }, "/v1/terminal/connection_tokens": { @@ -152071,7 +154617,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Connection Token" } }, "/v1/terminal/locations": { @@ -152197,7 +154744,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Locations" }, "post": { "description": "

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

", @@ -152323,7 +154871,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Location" } }, "/v1/terminal/locations/{location}": { @@ -152376,7 +154925,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a Location" }, "get": { "description": "

Retrieves a Location object.

", @@ -152449,7 +154999,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Location" }, "post": { "description": "

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

", @@ -152601,7 +155152,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a Location" } }, "/v1/terminal/readers": { @@ -152784,7 +155336,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Readers" }, "post": { "description": "

Creates a new Reader object.

", @@ -152876,7 +155429,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a Reader" } }, "/v1/terminal/readers/{reader}": { @@ -152929,7 +155483,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a Reader" }, "get": { "description": "

Retrieves a Reader object.

", @@ -153002,7 +155557,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Reader" }, "post": { "description": "

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

", @@ -153114,7 +155670,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a Reader" } }, "/v1/terminal/readers/{reader}/cancel_action": { @@ -153181,7 +155738,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel the current reader action" } }, "/v1/terminal/readers/{reader}/process_payment_intent": { @@ -153290,7 +155848,8 @@ }, "description": "Error response." } - } + }, + "summary": "Hand-off a PaymentIntent to a Reader" } }, "/v1/terminal/readers/{reader}/process_setup_intent": { @@ -153389,7 +155948,8 @@ }, "description": "Error response." } - } + }, + "summary": "Hand-off a SetupIntent to a Reader" } }, "/v1/terminal/readers/{reader}/refund_payment": { @@ -153503,7 +156063,8 @@ }, "description": "Error response." } - } + }, + "summary": "Refund a Charge or a PaymentIntent in-person" } }, "/v1/terminal/readers/{reader}/set_reader_display": { @@ -153629,7 +156190,8 @@ }, "description": "Error response." } - } + }, + "summary": "Set reader display" } }, "/v1/test_helpers/confirmation_tokens": { @@ -153718,6 +156280,11 @@ ], "type": "string" }, + "alma": { + "properties": {}, + "title": "param", + "type": "object" + }, "amazon_pay": { "properties": {}, "title": "param", @@ -153996,6 +156563,11 @@ "title": "param", "type": "object" }, + "kakao_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "klarna": { "properties": { "dob": { @@ -154027,6 +156599,11 @@ "title": "param", "type": "object" }, + "kr_card": { + "properties": {}, + "title": "param", + "type": "object" + }, "link": { "properties": {}, "title": "param", @@ -154048,6 +156625,20 @@ "title": "param", "type": "object" }, + "naver_pay": { + "properties": { + "funding": { + "enum": [ + "card", + "points" + ], + "type": "string", + "x-stripeBypassValidation": true + } + }, + "title": "param", + "type": "object" + }, "oxxo": { "properties": {}, "title": "param", @@ -154091,6 +156682,11 @@ "title": "param", "type": "object" }, + "payco": { + "properties": {}, + "title": "param", + "type": "object" + }, "paynow": { "properties": {}, "title": "param", @@ -154126,6 +156722,11 @@ "title": "param", "type": "object" }, + "samsung_pay": { + "properties": {}, + "title": "param", + "type": "object" + }, "sepa_debit": { "properties": { "iban": { @@ -154175,6 +156776,7 @@ "affirm", "afterpay_clearpay", "alipay", + "alma", "amazon_pay", "au_becs_debit", "bacs_debit", @@ -154188,18 +156790,23 @@ "giropay", "grabpay", "ideal", + "kakao_pay", "klarna", "konbini", + "kr_card", "link", "mobilepay", "multibanco", + "naver_pay", "oxxo", "p24", + "payco", "paynow", "paypal", "pix", "promptpay", "revolut_pay", + "samsung_pay", "sepa_debit", "sofort", "swish", @@ -154359,7 +156966,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a test Confirmation Token" } }, "/v1/test_helpers/customers/{customer}/fund_cash_balance": { @@ -154443,7 +157051,8 @@ }, "description": "Error response." } - } + }, + "summary": "Fund a test mode cash balance" } }, "/v1/test_helpers/issuing/authorizations": { @@ -155144,7 +157753,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/capture": { @@ -155455,7 +158065,8 @@ }, "description": "Error response." } - } + }, + "summary": "Capture a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/expire": { @@ -155522,7 +158133,8 @@ }, "description": "Error response." } - } + }, + "summary": "Expire a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { @@ -155738,7 +158350,8 @@ }, "description": "Error response." } - } + }, + "summary": "Finalize a test-mode authorization's amount" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { @@ -155816,7 +158429,8 @@ }, "description": "Error response." } - } + }, + "summary": "Increment a test-mode authorization" } }, "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": { @@ -155887,7 +158501,8 @@ }, "description": "Error response." } - } + }, + "summary": "Reverse a test-mode authorization" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": { @@ -155954,7 +158569,8 @@ }, "description": "Error response." } - } + }, + "summary": "Deliver a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/fail": { @@ -156021,7 +158637,8 @@ }, "description": "Error response." } - } + }, + "summary": "Fail a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/return": { @@ -156088,7 +158705,8 @@ }, "description": "Error response." } - } + }, + "summary": "Return a testmode card" } }, "/v1/test_helpers/issuing/cards/{card}/shipping/ship": { @@ -156155,7 +158773,76 @@ }, "description": "Error response." } - } + }, + "summary": "Ship a testmode card" + } + }, + "/v1/test_helpers/issuing/cards/{card}/shipping/submit": { + "post": { + "description": "

Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.

", + "operationId": "PostTestHelpersIssuingCardsCardShippingSubmit", + "parameters": [ + { + "in": "path", + "name": "card", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.card" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + }, + "summary": "Submit a testmode card" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": { @@ -156222,7 +158909,8 @@ }, "description": "Error response." } - } + }, + "summary": "Activate a testmode personalization design" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": { @@ -156289,7 +158977,8 @@ }, "description": "Error response." } - } + }, + "summary": "Deactivate a testmode personalization design" } }, "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": { @@ -156401,7 +159090,8 @@ }, "description": "Error response." } - } + }, + "summary": "Reject a testmode personalization design" } }, "/v1/test_helpers/issuing/settlements": { @@ -156496,7 +159186,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a test-mode settleemnt" } }, "/v1/test_helpers/issuing/transactions/create_force_capture": { @@ -157147,7 +159838,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a test-mode force capture" } }, "/v1/test_helpers/issuing/transactions/create_unlinked_refund": { @@ -157798,7 +160490,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a test-mode unlinked refund" } }, "/v1/test_helpers/issuing/transactions/{transaction}/refund": { @@ -157869,7 +160562,8 @@ }, "description": "Error response." } - } + }, + "summary": "Refund a test-mode transaction" } }, "/v1/test_helpers/refunds/{refund}/expire": { @@ -157935,7 +160629,8 @@ }, "description": "Error response." } - } + }, + "summary": "Expire a pending refund." } }, "/v1/test_helpers/terminal/readers/{reader}/present_payment_method": { @@ -158045,7 +160740,8 @@ }, "description": "Error response." } - } + }, + "summary": "Simulate presenting a payment method" } }, "/v1/test_helpers/test_clocks": { @@ -158171,7 +160867,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all test clocks" }, "post": { "description": "

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

", @@ -158237,7 +160934,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a test clock" } }, "/v1/test_helpers/test_clocks/{test_clock}": { @@ -158290,7 +160988,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a test clock" }, "get": { "description": "

Retrieves a test clock.

", @@ -158356,7 +161055,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a test clock" } }, "/v1/test_helpers/test_clocks/{test_clock}/advance": { @@ -158431,7 +161131,8 @@ }, "description": "Error response." } - } + }, + "summary": "Advance a test clock" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/fail": { @@ -158527,7 +161228,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Fail an InboundTransfer" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/return": { @@ -158594,7 +161296,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Return an InboundTransfer" } }, "/v1/test_helpers/treasury/inbound_transfers/{id}/succeed": { @@ -158661,7 +161364,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Succeed an InboundTransfer" } }, "/v1/test_helpers/treasury/outbound_payments/{id}": { @@ -158783,7 +161487,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Update an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/fail": { @@ -158850,7 +161555,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Fail an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/post": { @@ -158917,7 +161623,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Post an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_payments/{id}/return": { @@ -159010,7 +161717,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Return an OutboundPayment" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}": { @@ -159132,7 +161840,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Update an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail": { @@ -159199,7 +161908,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Fail an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post": { @@ -159266,7 +161976,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Post an OutboundTransfer" } }, "/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return": { @@ -159359,7 +162070,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Return an OutboundTransfer" } }, "/v1/test_helpers/treasury/received_credits": { @@ -159483,7 +162195,8 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Create a ReceivedCredit" } }, "/v1/test_helpers/treasury/received_debits": { @@ -159606,12 +162319,13 @@ }, "description": "Error response." } - } + }, + "summary": "Test mode: Create a ReceivedDebit" } }, "/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 connected account where controller.requirement_collection is application, which includes Custom accounts.

", + "description": "

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

", "operationId": "PostTokens", "requestBody": { "content": { @@ -160847,7 +163561,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a CVC update token" } }, "/v1/tokens/{token}": { @@ -160915,7 +163630,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a token" } }, "/v1/topups": { @@ -161124,7 +163840,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all top-ups" }, "post": { "description": "

Top up the balance of an account

", @@ -161229,7 +163946,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a top-up" } }, "/v1/topups/{topup}": { @@ -161297,7 +164015,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a top-up" }, "post": { "description": "

Updates the metadata of a top-up. Other top-up details are not editable by design.

", @@ -161388,7 +164107,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a top-up" } }, "/v1/topups/{topup}/cancel": { @@ -161455,7 +164175,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel a top-up" } }, "/v1/transfers": { @@ -161637,7 +164358,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all transfers" }, "post": { "description": "

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

", @@ -161741,7 +164463,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a transfer" } }, "/v1/transfers/{id}/reversals": { @@ -161877,7 +164600,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all reversals" }, "post": { "description": "

When you create a new reversal, you must specify a transfer to create it on.

\n\n

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

\n\n

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

", @@ -161976,7 +164700,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a transfer reversal" } }, "/v1/transfers/{transfer}": { @@ -162044,7 +164769,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a transfer" }, "post": { "description": "

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

\n\n

This request accepts only metadata as an argument.

", @@ -162135,7 +164861,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a transfer" } }, "/v1/transfers/{transfer}/reversals/{id}": { @@ -162213,7 +164940,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a reversal" }, "post": { "description": "

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

\n\n

This request only accepts metadata and description as arguments.

", @@ -162309,7 +165037,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a reversal" } }, "/v1/treasury/credit_reversals": { @@ -162471,7 +165200,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all CreditReversals" }, "post": { "description": "

Reverses a ReceivedCredit and creates a CreditReversal object.

", @@ -162543,7 +165273,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a CreditReversal" } }, "/v1/treasury/credit_reversals/{credit_reversal}": { @@ -162611,7 +165342,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a CreditReversal" } }, "/v1/treasury/debit_reversals": { @@ -162787,7 +165519,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all DebitReversals" }, "post": { "description": "

Reverses a ReceivedDebit and creates a DebitReversal object.

", @@ -162859,7 +165592,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a DebitReversal" } }, "/v1/treasury/debit_reversals/{debit_reversal}": { @@ -162927,7 +165661,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a DebitReversal" } }, "/v1/treasury/financial_accounts": { @@ -163086,7 +165821,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all FinancialAccounts" }, "post": { "description": "

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

", @@ -163333,7 +166069,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}": { @@ -163401,7 +166138,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a FinancialAccount" }, "post": { "description": "

Updates the details of a FinancialAccount.

", @@ -163645,7 +166383,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a FinancialAccount" } }, "/v1/treasury/financial_accounts/{financial_account}/features": { @@ -163713,7 +166452,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve FinancialAccount Features" }, "post": { "description": "

Updates the Features associated with a FinancialAccount.

", @@ -163945,7 +166685,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update FinancialAccount Features" } }, "/v1/treasury/inbound_transfers": { @@ -164022,7 +166763,8 @@ "processing", "succeeded" ], - "type": "string" + "type": "string", + "x-stripeBypassValidation": true }, "style": "form" } @@ -164097,7 +166839,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all InboundTransfers" }, "post": { "description": "

Creates an InboundTransfer.

", @@ -164194,7 +166937,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an InboundTransfer" } }, "/v1/treasury/inbound_transfers/{id}": { @@ -164262,7 +167006,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an InboundTransfer" } }, "/v1/treasury/inbound_transfers/{inbound_transfer}/cancel": { @@ -164329,7 +167074,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel an InboundTransfer" } }, "/v1/treasury/outbound_payments": { @@ -164527,7 +167273,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all OutboundPayments" }, "post": { "description": "

Creates an OutboundPayment.

", @@ -164831,7 +167578,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an OutboundPayment" } }, "/v1/treasury/outbound_payments/{id}": { @@ -164899,7 +167647,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an OutboundPayment" } }, "/v1/treasury/outbound_payments/{id}/cancel": { @@ -164966,7 +167715,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel an OutboundPayment" } }, "/v1/treasury/outbound_transfers": { @@ -165119,7 +167869,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all OutboundTransfers" }, "post": { "description": "

Creates an OutboundTransfer.

", @@ -165249,7 +168000,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create an OutboundTransfer" } }, "/v1/treasury/outbound_transfers/{outbound_transfer}": { @@ -165317,7 +168069,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve an OutboundTransfer" } }, "/v1/treasury/outbound_transfers/{outbound_transfer}/cancel": { @@ -165384,7 +168137,8 @@ }, "description": "Error response." } - } + }, + "summary": "Cancel an OutboundTransfer" } }, "/v1/treasury/received_credits": { @@ -165562,7 +168316,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all ReceivedCredits" } }, "/v1/treasury/received_credits/{id}": { @@ -165630,7 +168385,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a ReceivedCredit" } }, "/v1/treasury/received_debits": { @@ -165781,7 +168537,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all ReceivedDebits" } }, "/v1/treasury/received_debits/{id}": { @@ -165849,7 +168606,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a ReceivedDebit" } }, "/v1/treasury/transaction_entries": { @@ -166076,7 +168834,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all TransactionEntries" } }, "/v1/treasury/transaction_entries/{id}": { @@ -166144,7 +168903,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a TransactionEntry" } }, "/v1/treasury/transactions": { @@ -166382,7 +169142,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all Transactions" } }, "/v1/treasury/transactions/{id}": { @@ -166450,7 +169211,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a Transaction" } }, "/v1/webhook_endpoints": { @@ -166576,7 +169338,8 @@ }, "description": "Error response." } - } + }, + "summary": "List all webhook endpoints" }, "post": { "description": "

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

", @@ -166860,6 +169623,7 @@ "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", + "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", @@ -166903,6 +169667,7 @@ "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", + "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", @@ -167044,7 +169809,8 @@ }, "description": "Error response." } - } + }, + "summary": "Create a webhook endpoint" } }, "/v1/webhook_endpoints/{webhook_endpoint}": { @@ -167097,7 +169863,8 @@ }, "description": "Error response." } - } + }, + "summary": "Delete a webhook endpoint" }, "get": { "description": "

Retrieves the webhook endpoint with the given ID.

", @@ -167163,7 +169930,8 @@ }, "description": "Error response." } - } + }, + "summary": "Retrieve a webhook endpoint" }, "post": { "description": "

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

", @@ -167348,6 +170116,7 @@ "issuing_token.created", "issuing_token.updated", "issuing_transaction.created", + "issuing_transaction.purchase_details_receipt_updated", "issuing_transaction.updated", "mandate.updated", "payment_intent.amount_capturable_updated", @@ -167391,6 +170160,7 @@ "radar.early_fraud_warning.created", "radar.early_fraud_warning.updated", "refund.created", + "refund.failed", "refund.updated", "reporting.report_run.failed", "reporting.report_run.succeeded", @@ -167528,7 +170298,8 @@ }, "description": "Error response." } - } + }, + "summary": "Update a webhook endpoint" } } },