From dd2bf9b727d10f4c972c59a86fa3584c86cc03a8 Mon Sep 17 00:00:00 2001 From: ballerina-bot Date: Fri, 16 May 2025 07:34:59 +0000 Subject: [PATCH 1/2] [AUTOMATED] Update OpenAPI spec --- docs/spec/openapi.json | 279118 ++++++++++++++++---------------------- 1 file changed, 119034 insertions(+), 160084 deletions(-) diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 6074057..e855396 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -1,160150 +1,119100 @@ { - "paths": { - "/account": { - "get": { - "description": "

Retrieves the details of an account.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccount", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - } - }, - "/account_links": { - "post": { - "description": "

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

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

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

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

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

With Connect<\/a>, you can create Stripe accounts for your users.\nTo do this, you’ll first need to register your platform<\/a>.<\/p>\n\n

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

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

Retrieves the details of an account.

", + "operationId" : "GetAccount", + "parameters" : [ { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Account" + } + } } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/account_links" : { + "post" : { + "description" : "

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

", + "operationId" : "PostAccountLinks", + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/AccountLinksBody" + }, + "encoding" : { + "collection_options" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + } + } + } + }, + "required" : true }, - "/accounts/{account}": { - "get": { - "description": "

Retrieves the details of an account.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccountsAccount", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - }, - "post": { - "description": "

Updates a connected account<\/a> by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.<\/p>\n\n

For accounts where controller.requirement_collection<\/a>\nis application<\/code>, which includes Custom accounts, you can update any information on the account.<\/p>\n\n

For accounts where controller.requirement_collection<\/a>\nis stripe<\/code>, which includes Standard and Express accounts, you can update all information until you create\nan Account Link<\/a> or Account Session<\/a> to start Connect onboarding,\nafter which some properties can no longer be updated.<\/p>\n\n

To update your own account, use the Dashboard<\/a>. Refer to our\nConnect<\/a> documentation to learn more about updating accounts.<\/p>", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "business_profile": { - "explode": true, - "style": "deepObject" - }, - "capabilities": { - "explode": true, - "style": "deepObject" - }, - "company": { - "explode": true, - "style": "deepObject" - }, - "documents": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - }, - "individual": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - }, - "settings": { - "explode": true, - "style": "deepObject" - }, - "tos_acceptance": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "account_token": { - "description": "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.", - "maxLength": 5000, - "type": "string" - }, - "business_profile": { - "description": "Business information about the account.", - "properties": { - "annual_revenue": { - "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" - }, - "fiscal_year_end": { - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "amount", - "currency", - "fiscal_year_end" - ], - "title": "annual_revenue_specs", - "type": "object" - }, - "estimated_worker_count": { - "type": "integer" - }, - "mcc": { - "maxLength": 4, - "type": "string" - }, - "monthly_estimated_revenue": { - "properties": { - "amount": { - "type": "integer" - }, - "currency": { - "type": "string" - } - }, - "required": [ - "amount", - "currency" - ], - "title": "monthly_estimated_revenue_specs", - "type": "object" - }, - "name": { - "maxLength": 5000, - "type": "string" - }, - "product_description": { - "maxLength": 40000, - "type": "string" - }, - "support_address": { - "properties": { - "city": { - "maxLength": 100, - "type": "string" - }, - "country": { - "maxLength": 5000, - "type": "string" - }, - "line1": { - "maxLength": 200, - "type": "string" - }, - "line2": { - "maxLength": 200, - "type": "string" - }, - "postal_code": { - "maxLength": 5000, - "type": "string" - }, - "state": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "address_specs", - "type": "object" - }, - "support_email": { - "type": "string" - }, - "support_phone": { - "maxLength": 5000, - "type": "string" - }, - "support_url": { - "anyOf": [ - { - "type": "string" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ] - }, - "url": { - "type": "string" - } - }, - "title": "business_profile_specs", - "type": "object" - }, - "business_type": { - "description": "The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", - "enum": [ - "company", - "government_entity", - "individual", - "non_profit" - ], - "type": "string", - "x-stripeBypassValidation": true - }, - "capabilities": { - "description": "Each key of the dictionary represents a capability, and each capability\nmaps to its settings (for example, whether it has been requested or not). Each\ncapability is inactive until you have provided its specific\nrequirements and Stripe has verified them. An account might have some\nof its requested capabilities be active and some be inactive.\n\nRequired when [account.controller.stripe_dashboard.type](\/api\/accounts\/create#create_account-controller-dashboard-type)\nis `none`, which includes Custom accounts.", - "properties": { - "acss_debit_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "affirm_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "afterpay_clearpay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "amazon_pay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "au_becs_debit_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "bacs_debit_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "bancontact_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "bank_transfer_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "blik_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "boleto_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "card_issuing": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "card_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "cartes_bancaires_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "cashapp_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "eps_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "fpx_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "gb_bank_transfer_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "giropay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "grabpay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "ideal_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "india_international_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "jcb_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "jp_bank_transfer_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "klarna_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "konbini_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "legacy_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "link_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "mobilepay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "multibanco_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "mx_bank_transfer_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "oxxo_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "p24_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "paynow_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "promptpay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "revolut_pay_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "sepa_bank_transfer_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "sepa_debit_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "sofort_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "swish_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "tax_reporting_us_1099_k": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "tax_reporting_us_1099_misc": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "transfers": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "treasury": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "twint_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "us_bank_account_ach_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "us_bank_transfer_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - }, - "zip_payments": { - "properties": { - "requested": { - "type": "boolean" - } - }, - "title": "capability_param", - "type": "object" - } - }, - "title": "capabilities_param", - "type": "object" - }, - "company": { - "description": "Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.", - "properties": { - "address": { - "properties": { - "city": { - "maxLength": 100, - "type": "string" - }, - "country": { - "maxLength": 5000, - "type": "string" - }, - "line1": { - "maxLength": 200, - "type": "string" - }, - "line2": { - "maxLength": 200, - "type": "string" - }, - "postal_code": { - "maxLength": 5000, - "type": "string" - }, - "state": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "legal_entity_and_kyc_address_specs", - "type": "object" - }, - "address_kana": { - "properties": { - "city": { - "maxLength": 5000, - "type": "string" - }, - "country": { - "maxLength": 5000, - "type": "string" - }, - "line1": { - "maxLength": 5000, - "type": "string" - }, - "line2": { - "maxLength": 5000, - "type": "string" - }, - "postal_code": { - "maxLength": 5000, - "type": "string" - }, - "state": { - "maxLength": 5000, - "type": "string" - }, - "town": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "japan_address_kana_specs", - "type": "object" - }, - "address_kanji": { - "properties": { - "city": { - "maxLength": 5000, - "type": "string" - }, - "country": { - "maxLength": 5000, - "type": "string" - }, - "line1": { - "maxLength": 5000, - "type": "string" - }, - "line2": { - "maxLength": 5000, - "type": "string" - }, - "postal_code": { - "maxLength": 5000, - "type": "string" - }, - "state": { - "maxLength": 5000, - "type": "string" - }, - "town": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "japan_address_kanji_specs", - "type": "object" - }, - "directors_provided": { - "type": "boolean" - }, - "executives_provided": { - "type": "boolean" - }, - "export_license_id": { - "maxLength": 5000, - "type": "string" - }, - "export_purpose_code": { - "maxLength": 5000, - "type": "string" - }, - "name": { - "maxLength": 100, - "type": "string" - }, - "name_kana": { - "maxLength": 100, - "type": "string" - }, - "name_kanji": { - "maxLength": 100, - "type": "string" - }, - "owners_provided": { - "type": "boolean" - }, - "ownership_declaration": { - "properties": { - "date": { - "format": "unix-time", - "type": "integer" - }, - "ip": { - "type": "string" - }, - "user_agent": { - "maxLength": 5000, - "type": "string" - } - }, - "title": "company_ownership_declaration", - "type": "object" - }, - "phone": { - "maxLength": 5000, - "type": "string" - }, - "registration_number": { - "maxLength": 5000, - "type": "string" - }, - "structure": { - "enum": [ - "", - "free_zone_establishment", - "free_zone_llc", - "government_instrumentality", - "governmental_unit", - "incorporated_non_profit", - "incorporated_partnership", - "limited_liability_partnership", - "llc", - "multi_member_llc", - "private_company", - "private_corporation", - "private_partnership", - "public_company", - "public_corporation", - "public_partnership", - "registered_charity", - "single_member_llc", - "sole_establishment", - "sole_proprietorship", - "tax_exempt_government_instrumentality", - "unincorporated_association", - "unincorporated_non_profit", - "unincorporated_partnership" - ], - "type": "string", - "x-stripeBypassValidation": true - }, - "tax_id": { - "maxLength": 5000, - "type": "string" - }, - "tax_id_registrar": { - "maxLength": 5000, - "type": "string" - }, - "vat_id": { - "maxLength": 5000, - "type": "string" - }, - "verification": { - "properties": { - "document": { - "properties": { - "back": { - "maxLength": 500, - "type": "string" - }, - "front": { - "maxLength": 500, - "type": "string" - } - }, - "title": "verification_document_specs", - "type": "object" - } - }, - "title": "verification_specs", - "type": "object" - } - }, - "title": "company_specs", - "type": "object" - }, - "default_currency": { - "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts).", - "type": "string" - }, - "documents": { - "description": "Documents that may be submitted to satisfy various informational requests.", - "properties": { - "bank_account_ownership_verification": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - }, - "company_license": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - }, - "company_memorandum_of_association": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - }, - "company_ministerial_decree": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - }, - "company_registration_verification": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - }, - "company_tax_id_verification": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - }, - "proof_of_registration": { - "properties": { - "files": { - "items": { - "maxLength": 500, - "type": "string" - }, - "type": "array" - } - }, - "title": "documents_param", - "type": "object" - } - }, - "title": "documents_specs", - "type": "object" - }, - "email": { - "description": "The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.", - "type": "string" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "external_account": { - "description": "A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

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

With Connect<\/a>, you can delete accounts you manage.<\/p>\n\n

Test-mode accounts can be deleted at any time.<\/p>\n\n

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

If you want to delete your own account, use the account information tab in your account settings<\/a> instead.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/accounts/{account}/bank_accounts": { - "post": { - "description": "

Create an external account for a given account.

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

Retrieve a specified external account for a given account.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/External_account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccountsAccountBankAccountsId", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ] - }, - "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.<\/p>\n\n

You can only update bank accounts when account.controller.requirement_collection<\/a> is application<\/code>, which includes Custom accounts<\/a>.<\/p>\n\n

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

Delete a specified external account for a given account.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_external_account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/accounts/{account}/capabilities": { - "get": { - "description": "

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

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

Retrieves information about the specified Account Capability.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Capability" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccountsAccountCapabilitiesCapability", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "in": "path", - "name": "capability", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - }, - "post": { - "description": "

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

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

List external accounts for an account.

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

Create an external account for a given account.

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

Retrieve a specified external account for a given account.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/External_account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccountsAccountExternalAccountsId", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ] - }, - "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.<\/p>\n\n

You can only update bank accounts when account.controller.requirement_collection<\/a> is application<\/code>, which includes Custom accounts<\/a>.<\/p>\n\n

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

Delete a specified external account for a given account.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_external_account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/accounts/{account}/login_links": { - "post": { - "description": "

Creates a single-use login link for a connected account to access the Express Dashboard.<\/p>\n\n

You can only create login links for accounts that use the Express Dashboard<\/a> and are connected to your platform<\/strong>.<\/p>", - "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": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Login_link" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostAccountsAccountLoginLinks", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/accounts/{account}/people": { - "get": { - "description": "

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

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

Creates a new person.

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

Retrieves an existing person.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Person" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccountsAccountPeoplePerson", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "person", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - }, - "post": { - "description": "

Updates an existing person.

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

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_person" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "in": "path", - "name": "person", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/accounts/{account}/persons": { - "get": { - "description": "

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

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

Creates a new person.

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

Retrieves an existing person.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Person" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetAccountsAccountPersonsPerson", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "person", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - }, - "post": { - "description": "

Updates an existing person.

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

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_person" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "in": "path", - "name": "person", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/accounts/{account}/reject": { - "post": { - "description": "

With Connect<\/a>, you can reject accounts that you have flagged as suspicious.<\/p>\n\n

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.<\/p>", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "reason": { - "description": "The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "reason" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Account" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostAccountsAccountReject", - "parameters": [ - { - "in": "path", - "name": "account", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/apple_pay/domains": { - "get": { - "description": "

List apple pay domains.

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

Create an apple pay domain.

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

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

", + "operationId" : "PostAccountSessions", + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/AccountSessionsBody" + }, + "encoding" : { + "components" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + } + } + } + }, + "required" : true }, - "/apple_pay/domains/{domain}": { - "get": { - "description": "

Retrieve an apple pay domain.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Apple_pay_domain" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetApplePayDomainsDomain", - "parameters": [ - { - "in": "path", - "name": "domain", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - }, - "delete": { - "operationId": "DeleteApplePayDomainsDomain", - "description": "

Delete an apple pay domain.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_apple_pay_domain" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "domain", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/application_fees": { - "get": { - "description": "

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

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

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Fee_refund" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetApplicationFeesFeeRefundsId", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "fee", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - }, - "post": { - "description": "

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.<\/p>\n\n

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

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

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

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "title": "FeeRefundList", - "type": "object", - "x-expandableFields": [ - "data" - ], - "description": "", - "properties": { - "data": { - "description": "Details about each object.", - "items": { - "$ref": "#/components/schemas/Fee_refund" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ] - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetApplicationFeesIdRefunds", - "parameters": [ - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - } - ] - }, - "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.<\/p>\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.<\/p>\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.<\/p>", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "expand": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "amount": { - "description": "A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.", - "type": "integer" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", - "type": "object" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Fee_refund" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostApplicationFeesIdRefunds", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/apps/secrets": { - "get": { - "description": "

List all secrets stored on the given scope.

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

Create or replace a secret in the secret store.

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

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

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

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

", + "operationId" : "GetAccounts", + "parameters" : [ { + "name" : "created", + "in" : "query", + "description" : "Only return connected accounts that were created during the given date interval", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "$ref" : "#/components/schemas/Created" + } + }, { + "name" : "ending_before", + "in" : "query", + "description" : "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + }, + "x-ballerina-name" : "endingBefore" + }, { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer" + } + }, { + "name" : "starting_after", + "in" : "query", + "description" : "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + }, + "x-ballerina-name" : "startingAfter" + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AccountList" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } } + } + } + }, + "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.

", + "operationId" : "PostAccounts", + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/AccountsBody" + }, + "encoding" : { + "bank_account" : { + "style" : "deepObject", + "explode" : true + }, + "business_profile" : { + "style" : "deepObject", + "explode" : true + }, + "capabilities" : { + "style" : "deepObject", + "explode" : true + }, + "company" : { + "style" : "deepObject", + "explode" : true + }, + "controller" : { + "style" : "deepObject", + "explode" : true + }, + "documents" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + }, + "individual" : { + "style" : "deepObject", + "explode" : true + }, + "metadata" : { + "style" : "deepObject", + "explode" : true + }, + "settings" : { + "style" : "deepObject", + "explode" : true + }, + "tos_acceptance" : { + "style" : "deepObject", + "explode" : true + } + } + } + }, + "required" : false }, - "/apps/secrets/find": { - "get": { - "description": "

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

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

Retrieves the current account balance, based on the authentication that was used to make the request.\n For a sample request, see Accounting for negative balances<\/a>.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Balance" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetBalance", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - } - }, - "/balance/history": { - "get": { - "description": "

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

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

Retrieves the balance transaction with the given ID.<\/p>\n\n

Note that this endpoint previously used the path \/v1\/balance\/history\/:id<\/code>.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Balance_transaction" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetBalanceHistoryId", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/balance_transactions": { - "get": { - "description": "

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

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

Retrieves the balance transaction with the given ID.<\/p>\n\n

Note that this endpoint previously used the path \/v1\/balance\/history\/:id<\/code>.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Balance_transaction" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetBalanceTransactionsId", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/billing/meter_event_adjustments": { - "post": { - "description": "

Creates a billing meter event adjustment

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

Creates a billing meter event

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

Retrieve a list of billing meters.

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

Creates a billing meter

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

Retrieves the details of an account.

", + "operationId" : "GetAccountsAccount", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Account" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + }, + "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.

", + "operationId" : "PostAccountsAccount", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/AccountsaccountBody" + }, + "encoding" : { + "business_profile" : { + "style" : "deepObject", + "explode" : true + }, + "capabilities" : { + "style" : "deepObject", + "explode" : true + }, + "company" : { + "style" : "deepObject", + "explode" : true + }, + "documents" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + }, + "individual" : { + "style" : "deepObject", + "explode" : true + }, + "metadata" : { + "style" : "deepObject", + "explode" : true + }, + "settings" : { + "style" : "deepObject", + "explode" : true + }, + "tos_acceptance" : { + "style" : "deepObject", + "explode" : true + } + } + } + }, + "required" : false }, - "/billing/meters/{id}": { - "get": { - "description": "

Retrieves a billing meter given an ID

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

Updates a billing meter

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

Deactivates a billing meter

", - "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": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Billing.meter" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostBillingMetersIdDeactivate", - "parameters": [ - { - "description": "Unique identifier for the object.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/billing/meters/{id}/event_summaries": { - "get": { - "description": "

Retrieve a list of billing meter event summaries.

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

Reactivates a billing meter

", - "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": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Billing.meter" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostBillingMetersIdReactivate", - "parameters": [ - { - "description": "Unique identifier for the object.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/billing_portal/configurations": { - "get": { - "description": "

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

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

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

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

With Connect, you can delete accounts you manage.

\n\n

Test-mode accounts can be deleted at any time.

\n\n

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

\n\n

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

", + "operationId" : "DeleteAccountsAccount", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeletedAccount" + } + } } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/accounts/{account}/bank_accounts" : { + "post" : { + "description" : "

Create an external account for a given account.

", + "operationId" : "PostAccountsAccountBankAccounts", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/AccountBankAccountsBody" + }, + "encoding" : { + "bank_account" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + }, + "metadata" : { + "style" : "deepObject", + "explode" : true + } + } + } + }, + "required" : false }, - "/billing_portal/configurations/{configuration}": { - "get": { - "description": "

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Billing_portal.configuration" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetBillingPortalConfigurationsConfiguration", - "parameters": [ - { - "in": "path", - "name": "configuration", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - }, - "post": { - "description": "

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

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

Creates a session of the customer portal.

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

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

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

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

Search for charges you’ve previously created using Stripe’s Search Query Language<\/a>.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "title": "SearchResult", - "type": "object", - "x-expandableFields": [ - "data" - ], - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/Charge" - }, - "type": "array" - }, - "has_more": { - "type": "boolean" - }, - "next_page": { - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value.", - "enum": [ - "search_result" - ], - "type": "string" - }, - "total_count": { - "description": "The total number of objects that match the query, only accurate up to 10,000.", - "type": "integer" - }, - "url": { - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ] - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetChargesSearch", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).", - "in": "query", - "name": "query", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - } - ] - } - }, - "/charges/{charge}": { - "get": { - "description": "

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Charge" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetChargesCharge", - "parameters": [ - { - "in": "path", - "name": "charge", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - }, - "post": { - "description": "

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

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

Capture the payment of an existing, uncaptured charge that was created with the capture<\/code> option set to false.<\/p>\n\n

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

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

Retrieve a dispute for a specified charge.

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

When you create a new refund, you must specify either a Charge or a PaymentIntent object.<\/p>\n\n

This action refunds a previously created charge that’s not refunded yet.\nFunds are refunded to the credit or debit card that’s originally charged.<\/p>\n\n

You can optionally refund only part of a charge.\nYou can repeat this until the entire charge is refunded.<\/p>\n\n

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

A transfer can be reversed only by the application that created the charge.", - "type": "boolean" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Charge" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostChargesChargeRefund", - "parameters": [ - { - "description": "The identifier of the charge to refund.", - "in": "path", - "name": "charge", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/charges/{charge}/refunds": { - "get": { - "description": "

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

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

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.<\/p>\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.<\/p>\n\n

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

A transfer can be reversed only by the application that created the charge.", - "type": "boolean" - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Refund" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostChargesChargeRefunds", - "parameters": [ - { - "description": "The identifier of the charge to refund.", - "in": "path", - "name": "charge", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/charges/{charge}/refunds/{refund}": { - "get": { - "description": "

Retrieves the details of an existing refund.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Refund" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetChargesChargeRefundsRefund", - "parameters": [ - { - "in": "path", - "name": "charge", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "refund", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ] - }, - "post": { - "description": "

Update a specified refund.

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

Returns a list of Checkout Sessions.

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

Creates a Session object.

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

Retrieve a specified external account for a given account.

", + "operationId" : "GetAccountsAccountBankAccountsId", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + }, { + "name" : "id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExternalAccount" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + }, + "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.

", + "operationId" : "PostAccountsAccountBankAccountsId", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/BankAccountsidBody" + }, + "encoding" : { + "documents" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + }, + "metadata" : { + "style" : "deepObject", + "explode" : true + } + } } + }, + "required" : false }, - "/checkout/sessions/{session}": { - "get": { - "description": "

Retrieves a Session object.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Checkout.session" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetCheckoutSessionsSession", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "session", - "required": true, - "schema": { - "maxLength": 66, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/checkout/sessions/{session}/expire": { - "post": { - "description": "

A Session can be expired when it is in one of these statuses: open<\/code> <\/p>\n\n

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.<\/p>", - "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": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Checkout.session" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostCheckoutSessionsSessionExpire", - "parameters": [ - { - "in": "path", - "name": "session", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/checkout/sessions/{session}/line_items": { - "get": { - "description": "

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

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

Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "title": "ClimateRemovalsOrdersList", - "type": "object", - "x-expandableFields": [ - "data" - ], - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/Climate.order" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", - "maxLength": 5000, - "pattern": "^/v1/climate/orders", - "type": "string" - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ] - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetClimateOrders", - "parameters": [ - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - } - ] - }, - "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.<\/p>", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": { - "beneficiary": { - "explode": true, - "style": "deepObject" - }, - "expand": { - "explode": true, - "style": "deepObject" - }, - "metadata": { - "explode": true, - "style": "deepObject" - } - }, - "schema": { - "additionalProperties": false, - "properties": { - "amount": { - "description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.", - "type": "integer" - }, - "beneficiary": { - "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.", - "properties": { - "public_name": { - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "public_name" - ], - "title": "beneficiary_params", - "type": "object" - }, - "currency": { - "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.", - "maxLength": 5000, - "type": "string" - }, - "expand": { - "description": "Specifies which fields in the response should be expanded.", - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.", - "type": "object" - }, - "metric_tons": { - "description": "Requested number of tons for the order. Either this or `amount` must be specified.", - "format": "decimal", - "type": "string" - }, - "product": { - "description": "Unique identifier of the Climate product.", - "maxLength": 5000, - "type": "string" - } - }, - "required": [ - "product" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Climate.order" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostClimateOrders" + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExternalAccount" + } + } } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + }, + "delete" : { + "description" : "

Delete a specified external account for a given account.

", + "operationId" : "DeleteAccountsAccountBankAccountsId", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "id", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeletedExternalAccount" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/accounts/{account}/capabilities" : { + "get" : { + "description" : "

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

", + "operationId" : "GetAccountsAccountCapabilities", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ListAccountCapability" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/accounts/{account}/capabilities/{capability}" : { + "get" : { + "description" : "

Retrieves information about the specified Account Capability.

", + "operationId" : "GetAccountsAccountCapabilitiesCapability", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "capability", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + }, { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Capability" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + }, + "post" : { + "description" : "

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

", + "operationId" : "PostAccountsAccountCapabilitiesCapability", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "capability", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/CapabilitiescapabilityBody" + }, + "encoding" : { + "expand" : { + "style" : "deepObject", + "explode" : true + } + } + } + }, + "required" : false }, - "/climate/orders/{order}": { - "get": { - "description": "

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Climate.order" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetClimateOrdersOrder", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "Unique identifier of the order.", - "in": "path", - "name": "order", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - }, - "post": { - "description": "

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

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

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\nreservation amount_subtotal<\/code>, but not the amount_fees<\/code> for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total<\/code>.<\/p>", - "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": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Climate.order" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "PostClimateOrdersOrderCancel", - "parameters": [ - { - "description": "Unique identifier of the order.", - "in": "path", - "name": "order", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/climate/products": { - "get": { - "description": "

Lists all available Climate product objects.

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

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

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Climate.product" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetClimateProductsProduct", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "product", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/climate/suppliers": { - "get": { - "description": "

Lists all available Climate supplier objects.

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

Retrieves a Climate supplier object.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Climate.supplier" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetClimateSuppliersSupplier", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "supplier", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/confirmation_tokens/{confirmation_token}": { - "get": { - "description": "

Retrieves an existing ConfirmationToken object

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

Lists all Country Spec objects available in the API.

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

Returns a Country Spec for a given Country code.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Country_spec" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetCountrySpecsCountry", - "parameters": [ - { - "in": "path", - "name": "country", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - } - }, - "/coupons": { - "get": { - "description": "

Returns a list of your coupons.

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

You can create coupons easily via the coupon management<\/a> page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.<\/p>\n\n

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

List external accounts for an account.

", + "operationId" : "GetAccountsAccountExternalAccounts", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + }, { + "name" : "ending_before", + "in" : "query", + "description" : "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + }, + "x-ballerina-name" : "endingBefore" + }, { + "name" : "expand", + "in" : "query", + "description" : "Specifies which fields in the response should be expanded", + "required" : false, + "style" : "deepObject", + "explode" : true, + "schema" : { + "type" : "array", + "items" : { + "maxLength" : 5000, + "type" : "string" + } + } + }, { + "name" : "limit", + "in" : "query", + "description" : "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "integer" + } + }, { + "name" : "object", + "in" : "query", + "description" : "Filter external accounts according to a particular object type", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "maxLength" : 5000, + "type" : "string", + "enum" : [ "bank_account", "card" ], + "x-stripeBypassValidation" : true + } + }, { + "name" : "starting_after", + "in" : "query", + "description" : "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list", + "required" : false, + "style" : "form", + "explode" : true, + "schema" : { + "type" : "string" + }, + "x-ballerina-name" : "startingAfter" + } ], + "responses" : { + "200" : { + "description" : "Successful response", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExternalAccountList" + } + } + } + }, + "default" : { + "description" : "Error response.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + } + } + } + } + }, + "post" : { + "description" : "

Create an external account for a given account.

", + "operationId" : "PostAccountsAccountExternalAccounts", + "parameters" : [ { + "name" : "account", + "in" : "path", + "required" : true, + "style" : "simple", + "explode" : false, + "schema" : { + "maxLength" : 5000, + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/x-www-form-urlencoded" : { + "schema" : { + "$ref" : "#/components/schemas/AccountExternalAccountsBody" + }, + "encoding" : { + "bank_account" : { + "style" : "deepObject", + "explode" : true + }, + "expand" : { + "style" : "deepObject", + "explode" : true + }, + "metadata" : { + "style" : "deepObject", + "explode" : true + } + } } + }, + "required" : false }, - "/coupons/{coupon}": { - "get": { - "description": "

Retrieves the coupon with the given ID.

", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Coupon" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "operationId": "GetCouponsCoupon", - "parameters": [ - { - "in": "path", - "name": "coupon", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - } - ] - }, - "post": { - "description": "

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

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

You can delete coupons via the coupon management<\/a> page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.<\/p>", - "responses": { - "200": { - "description": "Successful response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Deleted_coupon" - } - } - } - }, - "default": { - "description": "Error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - }, - "parameters": [ - { - "in": "path", - "name": "coupon", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ] - } - }, - "/credit_notes": { - "get": { - "description": "

Returns a list of credit notes.

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

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