Stripe API

Online payment processing for internet businesses

stripe.com ↗

Version

2026-04-22.dahlia

OpenAPI

3.0.0

Endpoints

587

Schemas

1385

88

Quality

Updated

3 days ago

Payments payments billing finance

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.stripe.com/

Endpoints

GET POST PUT PATCH DELETE

Account 1 endpoints

GET /v1/account Retrieve account

Retrieves the details of an account.

operationId: GetAccount

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/account

Accountlinks 1 endpoints

POST /v1/account_links Create an account link

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

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
type	string	required
expand	array	optional
account	string	required
collect	string	optional
return_url	string	optional
refresh_url	string	optional
collection_options	object	optional
└ fields	string	optional
└ future_requirements	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/account_links

Accountsessions 1 endpoints

POST /v1/account_sessions Create an Account Session

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

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
account	string	required
components	object	required
└ payouts	object	optional
└ enabled	boolean	required
└ features	object	optional
└ instant_payouts	boolean	optional
└ standard_payouts	boolean	optional
└ edit_payout_schedule	boolean	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ balances	object	optional
└ enabled	boolean	required
└ features	object	optional
└ instant_payouts	boolean	optional
└ standard_payouts	boolean	optional
└ edit_payout_schedule	boolean	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ payments	object	optional
└ enabled	boolean	required
└ features	object	optional
└ capture_payments	boolean	optional
└ refund_management	boolean	optional
└ dispute_management	boolean	optional
└ destination_on_behalf_of_charge_management	boolean	optional
└ documents	object	optional
└ enabled	boolean	required
└ features	object	optional
└ issuing_card	object	optional
└ enabled	boolean	required
└ features	object	optional
└ card_management	boolean	optional
└ cardholder_management	boolean	optional
└ spend_control_management	boolean	optional
└ card_spend_dispute_management	boolean	optional
└ payouts_list	object	optional
└ enabled	boolean	required
└ features	object	optional
└ tax_settings	object	optional
└ enabled	boolean	required
└ features	object	optional
└ disputes_list	object	optional
└ enabled	boolean	required
└ features	object	optional
└ capture_payments	boolean	optional
└ refund_management	boolean	optional
└ dispute_management	boolean	optional
└ destination_on_behalf_of_charge_management	boolean	optional
└ balance_report	object	optional
└ enabled	boolean	required
└ features	object	optional
└ payout_details	object	optional
└ enabled	boolean	required
└ features	object	optional
└ payment_details	object	optional
└ enabled	boolean	required
└ features	object	optional
└ capture_payments	boolean	optional
└ refund_management	boolean	optional
└ dispute_management	boolean	optional
└ destination_on_behalf_of_charge_management	boolean	optional
└ payment_disputes	object	optional
└ enabled	boolean	required
└ features	object	optional
└ refund_management	boolean	optional
└ dispute_management	boolean	optional
└ destination_on_behalf_of_charge_management	boolean	optional
└ financial_account	object	optional
└ enabled	boolean	required
└ features	object	optional
└ send_money	boolean	optional
└ transfer_balance	boolean	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ tax_registrations	object	optional
└ enabled	boolean	required
└ features	object	optional
└ account_management	object	optional
└ enabled	boolean	required
└ features	object	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ account_onboarding	object	optional
└ enabled	boolean	required
└ features	object	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ issuing_cards_list	object	optional
└ enabled	boolean	required
└ features	object	optional
└ card_management	boolean	optional
└ cardholder_management	boolean	optional
└ spend_control_management	boolean	optional
└ card_spend_dispute_management	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ notification_banner	object	optional
└ enabled	boolean	required
└ features	object	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ instant_payouts_promotion	object	optional
└ enabled	boolean	required
└ features	object	optional
└ instant_payouts	boolean	optional
└ external_account_collection	boolean	optional
└ disable_stripe_user_authentication	boolean	optional
└ payout_reconciliation_report	object	optional
└ enabled	boolean	required
└ features	object	optional
└ …1 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/account_sessions

Accounts 29 endpoints

GET /v1/accounts List all connected accounts

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	In	Required	Type	Description
created	query	optional		Only return connected accounts that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts

POST /v1/accounts

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

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

operationId: PostAccounts

Request Body

application/x-www-form-urlencoded

Property	Type	Required
type	string	optional
email	string	optional
expand	array	optional
groups	object	optional
└ payments_pricing	object	optional
company	object	optional
└ name	string	optional
└ phone	string	optional
└ tax_id	string	optional
└ vat_id	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ name_kana	string	optional
└ structure	string	optional
└ name_kanji	string	optional
└ address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ owners_provided	boolean	optional
└ tax_id_registrar	string	optional
└ export_license_id	string	optional
└ registration_date	object	optional
└ directors_provided	boolean	optional
└ executives_provided	boolean	optional
└ export_purpose_code	string	optional
└ registration_number	string	optional
└ ownership_declaration	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	string	optional
└ …3 more	object	optional
country	string	optional
metadata	object	optional
settings	object	optional
└ payouts	object	optional
└ schedule	object	optional
└ interval	string	optional
└ delay_days	object	optional
└ weekly_anchor	string	optional
└ monthly_anchor	integer	optional
└ weekly_payout_days	array	optional
└ monthly_payout_days	array	optional
└ statement_descriptor	string	optional
└ debit_negative_balances	boolean	optional
└ branding	object	optional
└ icon	string	optional
└ logo	string	optional
└ primary_color	string	optional
└ secondary_color	string	optional
└ invoices	object	optional
└ hosted_payment_method_save	string	optional
└ payments	object	optional
└ statement_descriptor	string	optional
└ statement_descriptor_kana	string	optional
└ statement_descriptor_kanji	string	optional
└ treasury	object	optional
└ tos_acceptance	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	object	optional
└ card_issuing	object	optional
└ tos_acceptance	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	object	optional
└ card_payments	object	optional
└ decline_on	object	optional
└ avs_failure	boolean	optional
└ cvc_failure	boolean	optional
└ statement_descriptor_prefix	string	optional
└ statement_descriptor_prefix_kana	object	optional
└ statement_descriptor_prefix_kanji	object	optional
└ bacs_debit_payments	object	optional
└ display_name	string	optional
documents	object	optional
└ company_license	object	optional
└ files	array	optional
└ proof_of_address	object	optional
└ files	array	optional
└ proof_of_registration	object	optional
└ files	array	optional
└ signer	object	optional
└ person	string	optional
└ company_ministerial_decree	object	optional
└ files	array	optional
└ company_tax_id_verification	object	optional
└ files	array	optional
└ company_memorandum_of_association	object	optional
└ files	array	optional
└ company_registration_verification	object	optional
└ files	array	optional
└ bank_account_ownership_verification	object	optional
└ files	array	optional
└ proof_of_ultimate_beneficial_ownership	object	optional
└ files	array	optional
└ signer	object	optional
└ person	string	optional
controller	object	optional
└ fees	object	optional
└ payer	string	optional
└ losses	object	optional
└ payments	string	optional
└ stripe_dashboard	object	optional
└ type	string	optional
└ requirement_collection	string	optional
individual	object	optional
└ dob	object	optional
└ email	string	optional
└ phone	string	optional
└ gender	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ metadata	object	optional
└ id_number	string	optional
└ last_name	string	optional
└ first_name	string	optional
└ ssn_last_4	string	optional
└ maiden_name	string	optional
└ address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ relationship	object	optional
└ owner	boolean	optional
└ title	string	optional
└ director	boolean	optional
└ executive	boolean	optional
└ percent_ownership	object	optional
└ verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ additional_document	object	optional
└ back	string	optional
└ front	string	optional
└ address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ last_name_kana	string	optional
└ first_name_kana	string	optional
└ last_name_kanji	string	optional
└ first_name_kanji	string	optional
└ full_name_aliases	object	optional
└ …3 more	object	optional
bank_account	object	optional
capabilities	object	optional
└ treasury	object	optional
└ requested	boolean	optional
└ transfers	object	optional
└ requested	boolean	optional
└ card_issuing	object	optional
└ requested	boolean	optional
└ eps_payments	object	optional
└ requested	boolean	optional
└ fpx_payments	object	optional
└ requested	boolean	optional
└ jcb_payments	object	optional
└ requested	boolean	optional
└ p24_payments	object	optional
└ requested	boolean	optional
└ pix_payments	object	optional
└ requested	boolean	optional
└ upi_payments	object	optional
└ requested	boolean	optional
└ zip_payments	object	optional
└ requested	boolean	optional
└ alma_payments	object	optional
└ requested	boolean	optional
└ blik_payments	object	optional
└ requested	boolean	optional
└ card_payments	object	optional
└ requested	boolean	optional
└ link_payments	object	optional
└ requested	boolean	optional
└ oxxo_payments	object	optional
└ requested	boolean	optional
└ ideal_payments	object	optional
└ requested	boolean	optional
└ payco_payments	object	optional
└ requested	boolean	optional
└ payto_payments	object	optional
└ requested	boolean	optional
└ swish_payments	object	optional
└ requested	boolean	optional
└ twint_payments	object	optional
└ requested	boolean	optional
└ …44 more	object	optional
account_token	string	optional
business_type	string	optional
tos_acceptance	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	string	optional
└ service_agreement	string	optional
business_profile	object	optional
└ mcc	string	optional
└ url	string	optional
└ name	string	optional
└ support_url	object	optional
└ support_email	string	optional
└ support_phone	string	optional
└ annual_revenue	object	optional
└ amount	integer	required
└ currency	string	required
└ fiscal_year_end	string	required
└ support_address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ product_description	string	optional
└ estimated_worker_count	integer	optional
└ monthly_estimated_revenue	object	optional
└ amount	integer	required
└ currency	string	required
└ minority_owned_business_designation	array	optional
default_currency	string	optional
external_account	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts

DELETE /v1/accounts/{account} Delete an account

With Connect, you can delete accounts you manage.

Test-mode accounts can be deleted at any time.

Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero.

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

operationId: DeleteAccountsAccount

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/accounts/{account}

GET /v1/accounts/{account} Retrieve account

Retrieves the details of an account.

operationId: GetAccountsAccount

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}

POST /v1/accounts/{account} Update an account

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

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

For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.

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

operationId: PostAccountsAccount

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
email	string	optional
expand	array	optional
groups	object	optional
└ payments_pricing	object	optional
company	object	optional
└ name	string	optional
└ phone	string	optional
└ tax_id	string	optional
└ vat_id	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ name_kana	string	optional
└ structure	string	optional
└ name_kanji	string	optional
└ address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ owners_provided	boolean	optional
└ tax_id_registrar	string	optional
└ export_license_id	string	optional
└ registration_date	object	optional
└ directors_provided	boolean	optional
└ executives_provided	boolean	optional
└ export_purpose_code	string	optional
└ registration_number	string	optional
└ ownership_declaration	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	string	optional
└ …3 more	object	optional
metadata	object	optional
settings	object	optional
└ payouts	object	optional
└ schedule	object	optional
└ interval	string	optional
└ delay_days	object	optional
└ weekly_anchor	string	optional
└ monthly_anchor	integer	optional
└ weekly_payout_days	array	optional
└ monthly_payout_days	array	optional
└ statement_descriptor	string	optional
└ debit_negative_balances	boolean	optional
└ branding	object	optional
└ icon	string	optional
└ logo	string	optional
└ primary_color	string	optional
└ secondary_color	string	optional
└ invoices	object	optional
└ default_account_tax_ids	object	optional
└ hosted_payment_method_save	string	optional
└ payments	object	optional
└ statement_descriptor	string	optional
└ statement_descriptor_kana	string	optional
└ statement_descriptor_kanji	string	optional
└ treasury	object	optional
└ tos_acceptance	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	object	optional
└ card_issuing	object	optional
└ tos_acceptance	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	object	optional
└ card_payments	object	optional
└ decline_on	object	optional
└ avs_failure	boolean	optional
└ cvc_failure	boolean	optional
└ statement_descriptor_prefix	string	optional
└ statement_descriptor_prefix_kana	object	optional
└ statement_descriptor_prefix_kanji	object	optional
└ bacs_debit_payments	object	optional
└ display_name	string	optional
documents	object	optional
└ company_license	object	optional
└ files	array	optional
└ proof_of_address	object	optional
└ files	array	optional
└ proof_of_registration	object	optional
└ files	array	optional
└ signer	object	optional
└ person	string	optional
└ company_ministerial_decree	object	optional
└ files	array	optional
└ company_tax_id_verification	object	optional
└ files	array	optional
└ company_memorandum_of_association	object	optional
└ files	array	optional
└ company_registration_verification	object	optional
└ files	array	optional
└ bank_account_ownership_verification	object	optional
└ files	array	optional
└ proof_of_ultimate_beneficial_ownership	object	optional
└ files	array	optional
└ signer	object	optional
└ person	string	optional
individual	object	optional
└ dob	object	optional
└ email	string	optional
└ phone	string	optional
└ gender	string	optional
└ address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ metadata	object	optional
└ id_number	string	optional
└ last_name	string	optional
└ first_name	string	optional
└ ssn_last_4	string	optional
└ maiden_name	string	optional
└ address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ relationship	object	optional
└ owner	boolean	optional
└ title	string	optional
└ director	boolean	optional
└ executive	boolean	optional
└ percent_ownership	object	optional
└ verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ additional_document	object	optional
└ back	string	optional
└ front	string	optional
└ address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ last_name_kana	string	optional
└ first_name_kana	string	optional
└ last_name_kanji	string	optional
└ first_name_kanji	string	optional
└ full_name_aliases	object	optional
└ …3 more	object	optional
capabilities	object	optional
└ treasury	object	optional
└ requested	boolean	optional
└ transfers	object	optional
└ requested	boolean	optional
└ card_issuing	object	optional
└ requested	boolean	optional
└ eps_payments	object	optional
└ requested	boolean	optional
└ fpx_payments	object	optional
└ requested	boolean	optional
└ jcb_payments	object	optional
└ requested	boolean	optional
└ p24_payments	object	optional
└ requested	boolean	optional
└ pix_payments	object	optional
└ requested	boolean	optional
└ upi_payments	object	optional
└ requested	boolean	optional
└ zip_payments	object	optional
└ requested	boolean	optional
└ alma_payments	object	optional
└ requested	boolean	optional
└ blik_payments	object	optional
└ requested	boolean	optional
└ card_payments	object	optional
└ requested	boolean	optional
└ link_payments	object	optional
└ requested	boolean	optional
└ oxxo_payments	object	optional
└ requested	boolean	optional
└ ideal_payments	object	optional
└ requested	boolean	optional
└ payco_payments	object	optional
└ requested	boolean	optional
└ payto_payments	object	optional
└ requested	boolean	optional
└ swish_payments	object	optional
└ requested	boolean	optional
└ twint_payments	object	optional
└ requested	boolean	optional
└ …44 more	object	optional
account_token	string	optional
business_type	string	optional
tos_acceptance	object	optional
└ ip	string	optional
└ date	integer	optional
└ user_agent	string	optional
└ service_agreement	string	optional
business_profile	object	optional
└ mcc	string	optional
└ url	string	optional
└ name	string	optional
└ support_url	object	optional
└ support_email	string	optional
└ support_phone	string	optional
└ annual_revenue	object	optional
└ amount	integer	required
└ currency	string	required
└ fiscal_year_end	string	required
└ support_address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
└ product_description	string	optional
└ estimated_worker_count	integer	optional
└ monthly_estimated_revenue	object	optional
└ amount	integer	required
└ currency	string	required
└ minority_owned_business_designation	array	optional
default_currency	string	optional
external_account	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}

POST /v1/accounts/{account}/bank_accounts Create an external account

Create an external account for a given account.

operationId: PostAccountsAccountBankAccounts

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional
bank_account	object	optional
external_account	string	optional
default_for_currency	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/bank_accounts

DELETE /v1/accounts/{account}/bank_accounts/{id} Delete an external account

Delete a specified external account for a given account.

operationId: DeleteAccountsAccountBankAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
id	path	required	string	Unique identifier for the external account to be deleted.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/accounts/{account}/bank_accounts/{id}

GET /v1/accounts/{account}/bank_accounts/{id} Retrieve an external account

Retrieve a specified external account for a given account.

operationId: GetAccountsAccountBankAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the external account to be retrieved.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/bank_accounts/{id}

POST /v1/accounts/{account}/bank_accounts/{id}

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

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

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

operationId: PostAccountsAccountBankAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
name	string	optional
expand	array	optional
exp_year	string	optional
metadata	object	optional
documents	object	optional
└ bank_account_ownership_verification	object	optional
└ files	array	optional
exp_month	string	optional
address_zip	string	optional
account_type	string	optional
address_city	string	optional
address_line1	string	optional
address_line2	string	optional
address_state	string	optional
address_country	string	optional
account_holder_name	string	optional
account_holder_type	string	optional
default_for_currency	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/bank_accounts/{id}

GET /v1/accounts/{account}/capabilities List all account capabilities

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	In	Required	Type	Description
account	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/capabilities

GET /v1/accounts/{account}/capabilities/{capability} Retrieve an Account Capability

Retrieves information about the specified Account Capability.

operationId: GetAccountsAccountCapabilitiesCapability

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
capability	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/capabilities/{capability}

POST /v1/accounts/{account}/capabilities/{capability} Update an Account Capability

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

operationId: PostAccountsAccountCapabilitiesCapability

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
capability	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
requested	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/capabilities/{capability}

GET /v1/accounts/{account}/external_accounts List all external accounts

List external accounts for an account.

operationId: GetAccountsAccountExternalAccounts

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object	query	optional	string	Filter external accounts according to a particular object type.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/external_accounts

POST /v1/accounts/{account}/external_accounts Create an external account

Create an external account for a given account.

operationId: PostAccountsAccountExternalAccounts

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional
bank_account	object	optional
external_account	string	optional
default_for_currency	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/external_accounts

DELETE /v1/accounts/{account}/external_accounts/{id} Delete an external account

Delete a specified external account for a given account.

operationId: DeleteAccountsAccountExternalAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
id	path	required	string	Unique identifier for the external account to be deleted.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/accounts/{account}/external_accounts/{id}

GET /v1/accounts/{account}/external_accounts/{id} Retrieve an external account

Retrieve a specified external account for a given account.

operationId: GetAccountsAccountExternalAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the external account to be retrieved.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/external_accounts/{id}

POST /v1/accounts/{account}/external_accounts/{id}

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

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

operationId: PostAccountsAccountExternalAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
name	string	optional
expand	array	optional
exp_year	string	optional
metadata	object	optional
documents	object	optional
└ bank_account_ownership_verification	object	optional
└ files	array	optional
exp_month	string	optional
address_zip	string	optional
account_type	string	optional
address_city	string	optional
address_line1	string	optional
address_line2	string	optional
address_state	string	optional
address_country	string	optional
account_holder_name	string	optional
account_holder_type	string	optional
default_for_currency	boolean	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/external_accounts/{id}

POST /v1/accounts/{account}/login_links Create a login link

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

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

operationId: PostAccountsAccountLoginLinks

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/login_links

GET /v1/accounts/{account}/people List all persons

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

operationId: GetAccountsAccountPeople

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
relationship	query	optional	object	Filters on the list of people returned based on the person’s relationship to the account’s company.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/people

POST /v1/accounts/{account}/people Create a person

Creates a new person.

operationId: PostAccountsAccountPeople

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
dob	object	optional
email	string	optional
phone	string	optional
expand	array	optional
gender	string	optional
address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
metadata	object	optional
documents	object	optional
└ visa	object	optional
└ files	array	optional
└ passport	object	optional
└ files	array	optional
└ company_authorization	object	optional
└ files	array	optional
id_number	string	optional
last_name	string	optional
first_name	string	optional
ssn_last_4	string	optional
maiden_name	string	optional
nationality	string	optional
address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
person_token	string	optional
relationship	object	optional
└ owner	boolean	optional
└ title	string	optional
└ director	boolean	optional
└ executive	boolean	optional
└ authorizer	boolean	optional
└ legal_guardian	boolean	optional
└ representative	boolean	optional
└ percent_ownership	object	optional
us_cfpb_data	object	optional
└ race_details	object	optional
└ race	array	optional
└ race_other	string	optional
└ ethnicity_details	object	optional
└ ethnicity	array	optional
└ ethnicity_other	string	optional
└ self_identified_gender	string	optional
verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ additional_document	object	optional
└ back	string	optional
└ front	string	optional
address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
…9 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/people

DELETE /v1/accounts/{account}/people/{person} Delete a person

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

operationId: DeleteAccountsAccountPeoplePerson

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
person	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/accounts/{account}/people/{person}

GET /v1/accounts/{account}/people/{person} Retrieve a person

Retrieves an existing person.

operationId: GetAccountsAccountPeoplePerson

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.
person	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/people/{person}

POST /v1/accounts/{account}/people/{person} Update a person

Updates an existing person.

operationId: PostAccountsAccountPeoplePerson

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
person	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
dob	object	optional
email	string	optional
phone	string	optional
expand	array	optional
gender	string	optional
address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
metadata	object	optional
documents	object	optional
└ visa	object	optional
└ files	array	optional
└ passport	object	optional
└ files	array	optional
└ company_authorization	object	optional
└ files	array	optional
id_number	string	optional
last_name	string	optional
first_name	string	optional
ssn_last_4	string	optional
maiden_name	string	optional
nationality	string	optional
address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
person_token	string	optional
relationship	object	optional
└ owner	boolean	optional
└ title	string	optional
└ director	boolean	optional
└ executive	boolean	optional
└ authorizer	boolean	optional
└ legal_guardian	boolean	optional
└ representative	boolean	optional
└ percent_ownership	object	optional
us_cfpb_data	object	optional
└ race_details	object	optional
└ race	array	optional
└ race_other	string	optional
└ ethnicity_details	object	optional
└ ethnicity	array	optional
└ ethnicity_other	string	optional
└ self_identified_gender	string	optional
verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ additional_document	object	optional
└ back	string	optional
└ front	string	optional
address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
…9 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/people/{person}

GET /v1/accounts/{account}/persons List all persons

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

operationId: GetAccountsAccountPersons

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
relationship	query	optional	object	Filters on the list of people returned based on the person’s relationship to the account’s company.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/persons

POST /v1/accounts/{account}/persons Create a person

Creates a new person.

operationId: PostAccountsAccountPersons

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
dob	object	optional
email	string	optional
phone	string	optional
expand	array	optional
gender	string	optional
address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
metadata	object	optional
documents	object	optional
└ visa	object	optional
└ files	array	optional
└ passport	object	optional
└ files	array	optional
└ company_authorization	object	optional
└ files	array	optional
id_number	string	optional
last_name	string	optional
first_name	string	optional
ssn_last_4	string	optional
maiden_name	string	optional
nationality	string	optional
address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
person_token	string	optional
relationship	object	optional
└ owner	boolean	optional
└ title	string	optional
└ director	boolean	optional
└ executive	boolean	optional
└ authorizer	boolean	optional
└ legal_guardian	boolean	optional
└ representative	boolean	optional
└ percent_ownership	object	optional
us_cfpb_data	object	optional
└ race_details	object	optional
└ race	array	optional
└ race_other	string	optional
└ ethnicity_details	object	optional
└ ethnicity	array	optional
└ ethnicity_other	string	optional
└ self_identified_gender	string	optional
verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ additional_document	object	optional
└ back	string	optional
└ front	string	optional
address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
…9 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/persons

DELETE /v1/accounts/{account}/persons/{person} Delete a person

operationId: DeleteAccountsAccountPersonsPerson

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
person	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/accounts/{account}/persons/{person}

GET /v1/accounts/{account}/persons/{person} Retrieve a person

Retrieves an existing person.

operationId: GetAccountsAccountPersonsPerson

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.
person	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/persons/{person}

POST /v1/accounts/{account}/persons/{person} Update a person

Updates an existing person.

operationId: PostAccountsAccountPersonsPerson

Parameters

Name	In	Required	Type	Description
account	path	required	string	—
person	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
dob	object	optional
email	string	optional
phone	string	optional
expand	array	optional
gender	string	optional
address	object	optional
└ city	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
metadata	object	optional
documents	object	optional
└ visa	object	optional
└ files	array	optional
└ passport	object	optional
└ files	array	optional
└ company_authorization	object	optional
└ files	array	optional
id_number	string	optional
last_name	string	optional
first_name	string	optional
ssn_last_4	string	optional
maiden_name	string	optional
nationality	string	optional
address_kana	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
person_token	string	optional
relationship	object	optional
└ owner	boolean	optional
└ title	string	optional
└ director	boolean	optional
└ executive	boolean	optional
└ authorizer	boolean	optional
└ legal_guardian	boolean	optional
└ representative	boolean	optional
└ percent_ownership	object	optional
us_cfpb_data	object	optional
└ race_details	object	optional
└ race	array	optional
└ race_other	string	optional
└ ethnicity_details	object	optional
└ ethnicity	array	optional
└ ethnicity_other	string	optional
└ self_identified_gender	string	optional
verification	object	optional
└ document	object	optional
└ back	string	optional
└ front	string	optional
└ additional_document	object	optional
└ back	string	optional
└ front	string	optional
address_kanji	object	optional
└ city	string	optional
└ town	string	optional
└ line1	string	optional
└ line2	string	optional
└ state	string	optional
└ country	string	optional
└ postal_code	string	optional
…9 more	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/persons/{person}

POST /v1/accounts/{account}/reject Reject an account

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

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

operationId: PostAccountsAccountReject

Parameters

Name	In	Required	Type	Description
account	path	required	string	—

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
reason	string	required

Responses

default

Error response.

200

Successful response.

POST /v1/accounts/{account}/reject

Applepay 4 endpoints

GET /v1/apple_pay/domains

List apple pay domains.

operationId: GetApplePayDomains

Parameters

Name	In	Required	Type	Description
domain_name	query	optional	string	—
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apple_pay/domains

POST /v1/apple_pay/domains

Create an apple pay domain.

operationId: PostApplePayDomains

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
domain_name	string	required

Responses

default

Error response.

200

Successful response.

POST /v1/apple_pay/domains

DELETE /v1/apple_pay/domains/{domain}

Delete an apple pay domain.

operationId: DeleteApplePayDomainsDomain

Parameters

Name	In	Required	Type	Description
domain	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

DELETE /v1/apple_pay/domains/{domain}

GET /v1/apple_pay/domains/{domain}

Retrieve an apple pay domain.

operationId: GetApplePayDomainsDomain

Parameters

Name	In	Required	Type	Description
domain	path	required	string	—
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apple_pay/domains/{domain}

Applicationfees 7 endpoints

GET /v1/application_fees List all application fees

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

operationId: GetApplicationFees

Parameters

Name	In	Required	Type	Description
charge	query	optional	string	Only return application fees for the charge specified by this charge ID.
created	query	optional		Only return applications fees that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/application_fees

GET /v1/application_fees/{fee}/refunds/{id} Retrieve an application fee refund

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

operationId: GetApplicationFeesFeeRefundsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
fee	path	required	string	—
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/application_fees/{fee}/refunds/{id}

POST /v1/application_fees/{fee}/refunds/{id} Update an application fee refund

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

This request only accepts metadata as an argument.

operationId: PostApplicationFeesFeeRefundsId

Parameters

Name	In	Required	Type	Description
fee	path	required	string	—
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
expand	array	optional
metadata	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/application_fees/{fee}/refunds/{id}

GET /v1/application_fees/{id} Retrieve an application fee

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

operationId: GetApplicationFeesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/application_fees/{id}

POST /v1/application_fees/{id}/refund

operationId: PostApplicationFeesIdRefund

Parameters

Name	In	Required	Type	Description
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
amount	integer	optional
expand	array	optional
directive	string	optional

Responses

default

Error response.

200

Successful response.

POST /v1/application_fees/{id}/refund

GET /v1/application_fees/{id}/refunds List all application fee refunds

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

operationId: GetApplicationFeesIdRefunds

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	—
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/application_fees/{id}/refunds

POST /v1/application_fees/{id}/refunds Create an application fee refund

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

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

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

operationId: PostApplicationFeesIdRefunds

Parameters

Name	In	Required	Type	Description
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Property	Type	Required
amount	integer	optional
expand	array	optional
metadata	object	optional

Responses

default

Error response.

200

Successful response.

POST /v1/application_fees/{id}/refunds

Apps 4 endpoints

GET /v1/apps/secrets List secrets

List all secrets stored on the given scope.

operationId: GetAppsSecrets

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
scope	query	required	object	Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apps/secrets

POST /v1/apps/secrets Set a Secret

Create or replace a secret in the secret store.

operationId: PostAppsSecrets

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
name	string	required
scope	object	required
└ type	string	required
└ user	string	optional
expand	array	optional
payload	string	required
expires_at	integer	optional

Responses

default

Error response.

200

Successful response.

POST /v1/apps/secrets

POST /v1/apps/secrets/delete Delete a Secret

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

operationId: PostAppsSecretsDelete

Request Body

required

application/x-www-form-urlencoded

Property	Type	Required
name	string	required
scope	object	required
└ type	string	required
└ user	string	optional
expand	array	optional

Responses

default

Error response.

200

Successful response.

POST /v1/apps/secrets/delete

GET /v1/apps/secrets/find Find a Secret

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

operationId: GetAppsSecretsFind

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
name	query	required	string	A name for the secret that’s unique within the scope.
scope	query	required	object	Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apps/secrets/find

Balance 3 endpoints

GET /v1/balance Retrieve balance

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

operationId: GetBalance

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance

GET /v1/balance/history List all balance transactions

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

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

operationId: GetBalanceHistory

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return transactions that were created during the given date interval.
currency	query	optional	string	Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payout	query	optional	string	For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
source	query	optional	string	Only returns transactions associated with the given object.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	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`, `inbound_transfer`, `inbound_transfer_reversal`, `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`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance/history

GET /v1/balance/history/{id} Retrieve a balance transaction

Retrieves the balance transaction with the given ID.

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

operationId: GetBalanceHistoryId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	—

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance/history/{id}

Load more endpoints

Schemas

object account

{
  "type": "object",
  "title": "Account",
  "required": [
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "custom",
        "express",
        "none",
        "standard"
      ],
      "type": "string",
      "description": "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform."
    },
    "groups": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_group_membership"
        }
      ],
      "nullable": true,
      "description": "The groups associated with the account."
    },
    "object": {
      "enum": [
        "account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "company": {
      "$ref": "#/components/schemas/legal_entity_company"
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account's country."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the account was connected. Measured in seconds since the Unix epoch."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "settings": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_settings"
        }
      ],
      "nullable": true,
      "description": "Options for customizing how the account functions within Stripe."
    },
    "controller": {
      "$ref": "#/components/schemas/account_unification_account_controller"
    },
    "individual": {
      "$ref": "#/components/schemas/person"
    },
    "capabilities": {
      "$ref": "#/components/schemas/account_capabilities"
    },
    "requirements": {
      "$ref": "#/components/schemas/account_requirements"
    },
    "business_type": {
      "enum": [
        "company",
        "government_entity",
        "individual",
        "non_profit"
      ],
      "type": "string",
      "nullable": true,
      "description": "The business type.",
      "x-stripeBypassValidation": true
    },
    "tos_acceptance": {
      "$ref": "#/components/schemas/account_tos_acceptance"
    },
    "charges_enabled": {
      "type": "boolean",
      "description": "Whether the account can process charges."
    },
    "payouts_enabled": {
      "type": "boolean",
      "description": "Whether the funds in this account can be paid out."
    },
    "business_profile": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_business_profile"
        }
      ],
      "nullable": true,
      "description": "Business information about the account."
    },
    "default_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts)."
    },
    "details_submitted": {
      "type": "boolean",
      "description": "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details."
    },
    "external_accounts": {
      "type": "object",
      "title": "ExternalAccountList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              }
            ],
            "title": "Polymorphic",
            "x-stripeBypassValidation": true
          },
          "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.",
      "x-expandableFields": [
        "data"
      ]
    },
    "future_requirements": {
      "$ref": "#/components/schemas/account_future_requirements"
    }
  },
  "description": "For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user.\n\nThis is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).",
  "x-resourceId": "account",
  "x-expandableFields": [
    "business_profile",
    "capabilities",
    "company",
    "controller",
    "external_accounts",
    "future_requirements",
    "groups",
    "individual",
    "requirements",
    "settings",
    "tos_acceptance"
  ]
}

object account_annual_revenue

{
  "type": "object",
  "title": "AccountAnnualRevenue",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "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)."
    },
    "fiscal_year_end": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_bacs_debit_payments_settings

{
  "type": "object",
  "title": "AccountBacsDebitPaymentsSettings",
  "properties": {
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free."
    },
    "service_user_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_branding_settings

{
  "type": "object",
  "title": "AccountBrandingSettings",
  "properties": {
    "icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "primary_color": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A CSS hex color value representing the primary branding color for this account"
    },
    "secondary_color": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A CSS hex color value representing the secondary branding color for this account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "icon",
    "logo"
  ]
}

object account_business_profile

{
  "type": "object",
  "title": "AccountBusinessProfile",
  "properties": {
    "mcc": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The business's publicly available website."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer-facing business name."
    },
    "support_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A publicly available website for handling support issues."
    },
    "support_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A publicly available email address for sending support issues to."
    },
    "support_phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A publicly available phone number to call with support issues."
    },
    "annual_revenue": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_annual_revenue"
        }
      ],
      "nullable": true,
      "description": "The applicant's gross annual revenue for its preceding fiscal year."
    },
    "support_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "A publicly available mailing address for sending support issues to."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 40000,
      "description": "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes."
    },
    "estimated_worker_count": {
      "type": "integer",
      "nullable": true,
      "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business."
    },
    "monthly_estimated_revenue": {
      "$ref": "#/components/schemas/account_monthly_estimated_revenue"
    },
    "minority_owned_business_designation": {
      "type": "array",
      "items": {
        "enum": [
          "lgbtqi_owned_business",
          "minority_owned_business",
          "none_of_these_apply",
          "prefer_not_to_answer",
          "women_owned_business"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business."
    }
  },
  "description": "",
  "x-expandableFields": [
    "annual_revenue",
    "monthly_estimated_revenue",
    "support_address"
  ]
}

object account_capabilities

{
  "type": "object",
  "title": "AccountCapabilities",
  "properties": {
    "treasury": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the banking capability, or whether the account can have bank accounts."
    },
    "transfers": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account."
    },
    "card_issuing": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards"
    },
    "eps_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges."
    },
    "fpx_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges."
    },
    "jcb_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency."
    },
    "p24_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges."
    },
    "pix_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the pix payments capability of the account, or whether the account can directly process pix charges."
    },
    "upi_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the upi payments capability of the account, or whether the account can directly process upi charges."
    },
    "zip_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges."
    },
    "alma_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Alma capability of the account, or whether the account can directly process Alma payments."
    },
    "blik_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the blik payments capability of the account, or whether the account can directly process blik charges."
    },
    "card_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges."
    },
    "link_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the link_payments capability of the account, or whether the account can directly process Link charges."
    },
    "oxxo_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges."
    },
    "ideal_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges."
    },
    "payco_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Payco capability of the account, or whether the account can directly process Payco payments."
    },
    "payto_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the PayTo capability of the account, or whether the account can directly process PayTo charges."
    },
    "swish_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Swish capability of the account, or whether the account can directly process Swish payments."
    },
    "twint_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges."
    },
    "affirm_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Affirm capability of the account, or whether the account can directly process Affirm charges."
    },
    "billie_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Billie capability of the account, or whether the account can directly process Billie payments."
    },
    "boleto_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges."
    },
    "crypto_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Crypto capability of the account, or whether the account can directly process Crypto payments."
    },
    "klarna_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges."
    },
    "legacy_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the legacy payments capability of the account."
    },
    "mb_way_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges."
    },
    "paynow_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges."
    },
    "sofort_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges."
    },
    "sunbit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments."
    },
    "app_distribution": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the `app_distribution` capability of the account, or whether the platform can distribute apps to other accounts."
    },
    "cashapp_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments."
    },
    "giropay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges."
    },
    "grabpay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges."
    },
    "konbini_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the konbini payments capability of the account, or whether the account can directly process konbini charges."
    },
    "kr_card_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the KrCard capability of the account, or whether the account can directly process KrCard payments."
    },
    "satispay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Satispay capability of the account, or whether the account can directly process Satispay payments."
    },
    "kakao_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments."
    },
    "mobilepay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges."
    },
    "naver_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments."
    },
    "promptpay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges."
    },
    "acss_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges."
    },
    "amazon_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments."
    },
    "bacs_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges."
    },
    "bancontact_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges."
    },
    "multibanco_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges."
    },
    "sepa_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges."
    },
    "pay_by_bank_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges."
    },
    "revolut_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments."
    },
    "samsung_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments."
    },
    "au_becs_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges."
    },
    "bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges."
    },
    "tax_reporting_us_1099_k": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the tax reporting 1099-K (US) capability of the account."
    },
    "cartes_bancaires_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency."
    },
    "gb_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges."
    },
    "jp_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges."
    },
    "mx_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges."
    },
    "us_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges."
    },
    "afterpay_clearpay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges."
    },
    "tax_reporting_us_1099_misc": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the tax reporting 1099-MISC (US) capability of the account."
    },
    "sepa_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges."
    },
    "india_international_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India."
    },
    "us_bank_account_ach_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges."
    },
    "nz_bank_account_becs_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_capability_future_requirements

{
  "type": "object",
  "title": "AccountCapabilityFutureRequirements",
  "required": [
    "currently_due",
    "errors",
    "eventually_due",
    "past_due",
    "pending_verification"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well."
    },
    "disabled_reason": {
      "enum": [
        "other",
        "paused.inactivity",
        "pending.onboarding",
        "pending.review",
        "platform_disabled",
        "platform_paused",
        "rejected.inactivity",
        "rejected.other",
        "rejected.unsupported_business",
        "requirements.fields_needed"
      ],
      "type": "string",
      "nullable": true,
      "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.",
      "x-stripeBypassValidation": true
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_capability_requirements

{
  "type": "object",
  "title": "AccountCapabilityRequirements",
  "required": [
    "currently_due",
    "errors",
    "eventually_due",
    "past_due",
    "pending_verification"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set."
    },
    "disabled_reason": {
      "enum": [
        "other",
        "paused.inactivity",
        "pending.onboarding",
        "pending.review",
        "platform_disabled",
        "platform_paused",
        "rejected.inactivity",
        "rejected.other",
        "rejected.unsupported_business",
        "requirements.fields_needed"
      ],
      "type": "string",
      "nullable": true,
      "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).",
      "x-stripeBypassValidation": true
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_card_issuing_settings

{
  "type": "object",
  "title": "AccountCardIssuingSettings",
  "properties": {
    "tos_acceptance": {
      "$ref": "#/components/schemas/card_issuing_account_terms_of_service"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tos_acceptance"
  ]
}

object account_card_payments_settings

{
  "type": "object",
  "title": "AccountCardPaymentsSettings",
  "properties": {
    "decline_on": {
      "$ref": "#/components/schemas/account_decline_charge_on"
    },
    "statement_descriptor_prefix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion."
    },
    "statement_descriptor_prefix_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion."
    },
    "statement_descriptor_prefix_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion."
    }
  },
  "description": "",
  "x-expandableFields": [
    "decline_on"
  ]
}

object account_dashboard_settings

{
  "type": "object",
  "title": "AccountDashboardSettings",
  "properties": {
    "timezone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones)."
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_decline_charge_on

{
  "type": "object",
  "title": "AccountDeclineChargeOn",
  "required": [
    "avs_failure",
    "cvc_failure"
  ],
  "properties": {
    "avs_failure": {
      "type": "boolean",
      "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification."
    },
    "cvc_failure": {
      "type": "boolean",
      "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_future_requirements

{
  "type": "object",
  "title": "AccountFutureRequirements",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "nullable": true,
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well."
    },
    "disabled_reason": {
      "enum": [
        "action_required.requested_capabilities",
        "listed",
        "other",
        "platform_paused",
        "rejected.fraud",
        "rejected.incomplete_verification",
        "rejected.listed",
        "rejected.other",
        "rejected.platform_fraud",
        "rejected.platform_other",
        "rejected.platform_terms_of_service",
        "rejected.terms_of_service",
        "requirements.past_due",
        "requirements.pending_verification",
        "under_review"
      ],
      "type": "string",
      "nullable": true,
      "description": "This is typed as an enum for consistency with `requirements.disabled_reason`."
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_group_membership

{
  "type": "object",
  "title": "AccountGroupMembership",
  "properties": {
    "payments_pricing": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_invoices_settings

{
  "type": "object",
  "title": "AccountInvoicesSettings",
  "properties": {
    "default_account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized."
    },
    "hosted_payment_method_save": {
      "enum": [
        "always",
        "never",
        "offer"
      ],
      "type": "string",
      "nullable": true,
      "description": "Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page."
    }
  },
  "description": "",
  "x-expandableFields": [
    "default_account_tax_ids"
  ]
}

object account_link

{
  "type": "object",
  "title": "AccountLink",
  "required": [
    "created",
    "expires_at",
    "object",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL for the account link."
    },
    "object": {
      "enum": [
        "account_link"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which this account link will expire."
    }
  },
  "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://docs.stripe.com/connect/custom/hosted-onboarding)",
  "x-resourceId": "account_link",
  "x-expandableFields": []
}

object account_monthly_estimated_revenue

{
  "type": "object",
  "title": "AccountMonthlyEstimatedRevenue",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal)."
    },
    "currency": {
      "type": "string",
      "format": "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)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_payments_settings

{
  "type": "object",
  "title": "AccountPaymentsSettings",
  "properties": {
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge."
    },
    "statement_descriptor_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors)."
    },
    "statement_descriptor_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_payout_settings

{
  "type": "object",
  "title": "AccountPayoutSettings",
  "required": [
    "debit_negative_balances",
    "schedule"
  ],
  "properties": {
    "schedule": {
      "$ref": "#/components/schemas/transfer_schedule"
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard."
    },
    "debit_negative_balances": {
      "type": "boolean",
      "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "schedule"
  ]
}

object account_requirements

{
  "type": "object",
  "title": "AccountRequirements",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "nullable": true,
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set."
    },
    "disabled_reason": {
      "enum": [
        "action_required.requested_capabilities",
        "listed",
        "other",
        "platform_paused",
        "rejected.fraud",
        "rejected.incomplete_verification",
        "rejected.listed",
        "rejected.other",
        "rejected.platform_fraud",
        "rejected.platform_other",
        "rejected.platform_terms_of_service",
        "rejected.terms_of_service",
        "requirements.past_due",
        "requirements.pending_verification",
        "under_review"
      ],
      "type": "string",
      "nullable": true,
      "description": "If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification)."
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_requirements_alternative

{
  "type": "object",
  "title": "AccountRequirementsAlternative",
  "required": [
    "alternative_fields_due",
    "original_fields_due"
  ],
  "properties": {
    "original_fields_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are due and can be resolved by providing all fields in `alternative_fields_due`."
    },
    "alternative_fields_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that can be provided to resolve all fields in `original_fields_due`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_requirements_error

{
  "type": "object",
  "title": "AccountRequirementsError",
  "required": [
    "code",
    "reason",
    "requirement"
  ],
  "properties": {
    "code": {
      "enum": [
        "external_request",
        "information_missing",
        "invalid_address_city_state_postal_code",
        "invalid_address_highway_contract_box",
        "invalid_address_private_mailbox",
        "invalid_business_profile_name",
        "invalid_business_profile_name_denylisted",
        "invalid_company_name_denylisted",
        "invalid_dob_age_over_maximum",
        "invalid_dob_age_under_18",
        "invalid_dob_age_under_minimum",
        "invalid_product_description_length",
        "invalid_product_description_url_match",
        "invalid_representative_country",
        "invalid_signator",
        "invalid_statement_descriptor_business_mismatch",
        "invalid_statement_descriptor_denylisted",
        "invalid_statement_descriptor_length",
        "invalid_statement_descriptor_prefix_denylisted",
        "invalid_statement_descriptor_prefix_mismatch",
        "invalid_street_address",
        "invalid_tax_id",
        "invalid_tax_id_format",
        "invalid_tos_acceptance",
        "invalid_url_denylisted",
        "invalid_url_format",
        "invalid_url_web_presence_detected",
        "invalid_url_website_business_information_mismatch",
        "invalid_url_website_empty",
        "invalid_url_website_inaccessible",
        "invalid_url_website_inaccessible_geoblocked",
        "invalid_url_website_inaccessible_password_protected",
        "invalid_url_website_incomplete",
        "invalid_url_website_incomplete_cancellation_policy",
        "invalid_url_website_incomplete_customer_service_details",
        "invalid_url_website_incomplete_legal_restrictions",
        "invalid_url_website_incomplete_refund_policy",
        "invalid_url_website_incomplete_return_policy",
        "invalid_url_website_incomplete_terms_and_conditions",
        "invalid_url_website_incomplete_under_construction",
        "invalid_url_website_other",
        "invalid_value_other",
        "unsupported_business_type",
        "verification_directors_mismatch",
        "verification_document_address_mismatch",
        "verification_document_address_missing",
        "verification_document_corrupt",
        "verification_document_country_not_supported",
        "verification_document_directors_mismatch",
        "verification_document_dob_mismatch",
        "verification_document_duplicate_type",
        "verification_document_expired",
        "verification_document_failed_copy",
        "verification_document_failed_greyscale",
        "verification_document_failed_other",
        "verification_document_failed_test_mode",
        "verification_document_fraudulent",
        "verification_document_id_number_mismatch",
        "verification_document_id_number_missing",
        "verification_document_incomplete",
        "verification_document_invalid",
        "verification_document_issue_or_expiry_date_missing",
        "verification_document_manipulated",
        "verification_document_missing_back",
        "verification_document_missing_front",
        "verification_document_name_mismatch",
        "verification_document_name_missing",
        "verification_document_nationality_mismatch",
        "verification_document_not_readable",
        "verification_document_not_signed",
        "verification_document_not_uploaded",
        "verification_document_photo_mismatch",
        "verification_document_too_large",
        "verification_document_type_not_supported",
        "verification_extraneous_directors",
        "verification_failed_address_match",
        "verification_failed_authorizer_authority",
        "verification_failed_business_iec_number",
        "verification_failed_document_match",
        "verification_failed_id_number_match",
        "verification_failed_keyed_identity",
        "verification_failed_keyed_match",
        "verification_failed_name_match",
        "verification_failed_other",
        "verification_failed_representative_authority",
        "verification_failed_residential_address",
        "verification_failed_tax_id_match",
        "verification_failed_tax_id_not_issued",
        "verification_legal_entity_structure_mismatch",
        "verification_missing_directors",
        "verification_missing_executives",
        "verification_missing_owners",
        "verification_rejected_ownership_exemption_reason",
        "verification_requires_additional_memorandum_of_associations",
        "verification_requires_additional_proof_of_registration",
        "verification_supportability"
      ],
      "type": "string",
      "description": "The code for the type of error.",
      "x-stripeBypassValidation": true
    },
    "reason": {
      "type": "string",
      "maxLength": 5000,
      "description": "An informative message that indicates the error type and provides additional details about the error."
    },
    "requirement": {
      "type": "string",
      "maxLength": 5000,
      "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_sepa_debit_payments_settings

{
  "type": "object",
  "title": "AccountSepaDebitPaymentsSettings",
  "properties": {
    "creditor_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "SEPA creditor identifier that identifies the company making the payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_session

{
  "type": "object",
  "title": "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession",
  "required": [
    "account",
    "client_secret",
    "components",
    "expires_at",
    "livemode",
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "account_session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the account the AccountSession was created for"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "components": {
      "$ref": "#/components/schemas/connect_embedded_account_session_create_components"
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which this AccountSession will expire."
    },
    "client_secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled."
    }
  },
  "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components)",
  "x-resourceId": "account_session",
  "x-expandableFields": [
    "components"
  ]
}

object account_settings

{
  "type": "object",
  "title": "AccountSettings",
  "required": [
    "branding",
    "card_payments",
    "dashboard",
    "payments"
  ],
  "properties": {
    "payouts": {
      "$ref": "#/components/schemas/account_payout_settings"
    },
    "branding": {
      "$ref": "#/components/schemas/account_branding_settings"
    },
    "invoices": {
      "$ref": "#/components/schemas/account_invoices_settings"
    },
    "payments": {
      "$ref": "#/components/schemas/account_payments_settings"
    },
    "treasury": {
      "$ref": "#/components/schemas/account_treasury_settings"
    },
    "dashboard": {
      "$ref": "#/components/schemas/account_dashboard_settings"
    },
    "card_issuing": {
      "$ref": "#/components/schemas/account_card_issuing_settings"
    },
    "card_payments": {
      "$ref": "#/components/schemas/account_card_payments_settings"
    },
    "bacs_debit_payments": {
      "$ref": "#/components/schemas/account_bacs_debit_payments_settings"
    },
    "sepa_debit_payments": {
      "$ref": "#/components/schemas/account_sepa_debit_payments_settings"
    }
  },
  "description": "",
  "x-expandableFields": [
    "bacs_debit_payments",
    "branding",
    "card_issuing",
    "card_payments",
    "dashboard",
    "invoices",
    "payments",
    "payouts",
    "sepa_debit_payments",
    "treasury"
  ]
}

object account_terms_of_service

{
  "type": "object",
  "title": "AccountTermsOfService",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the account representative accepted the service agreement."
    },
    "date": {
      "type": "integer",
      "nullable": true,
      "description": "The Unix timestamp marking when the account representative accepted the service agreement."
    },
    "user_agent": {
      "type": "string",
      "maxLength": 5000,
      "description": "The user agent of the browser from which the account representative accepted the service agreement."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_tos_acceptance

{
  "type": "object",
  "title": "AccountTOSAcceptance",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the account representative accepted their service agreement"
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the account representative accepted their service agreement"
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user agent of the browser from which the account representative accepted their service agreement"
    },
    "service_agreement": {
      "type": "string",
      "maxLength": 5000,
      "description": "The user's service agreement type"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_treasury_settings

{
  "type": "object",
  "title": "AccountTreasurySettings",
  "properties": {
    "tos_acceptance": {
      "$ref": "#/components/schemas/account_terms_of_service"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tos_acceptance"
  ]
}

object account_unification_account_controller

{
  "type": "object",
  "title": "AccountUnificationAccountController",
  "required": [
    "type"
  ],
  "properties": {
    "fees": {
      "$ref": "#/components/schemas/account_unification_account_controller_fees"
    },
    "type": {
      "enum": [
        "account",
        "application"
      ],
      "type": "string",
      "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself."
    },
    "losses": {
      "$ref": "#/components/schemas/account_unification_account_controller_losses"
    },
    "is_controller": {
      "type": "boolean",
      "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null."
    },
    "stripe_dashboard": {
      "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard"
    },
    "requirement_collection": {
      "enum": [
        "application",
        "stripe"
      ],
      "type": "string",
      "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account."
    }
  },
  "description": "",
  "x-expandableFields": [
    "fees",
    "losses",
    "stripe_dashboard"
  ]
}

object account_unification_account_controller_fees

{
  "type": "object",
  "title": "AccountUnificationAccountControllerFees",
  "required": [
    "payer"
  ],
  "properties": {
    "payer": {
      "enum": [
        "account",
        "application",
        "application_custom",
        "application_express"
      ],
      "type": "string",
      "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_unification_account_controller_losses

{
  "type": "object",
  "title": "AccountUnificationAccountControllerLosses",
  "required": [
    "payments"
  ],
  "properties": {
    "payments": {
      "enum": [
        "application",
        "stripe"
      ],
      "type": "string",
      "description": "A value indicating who is liable when this account can't pay back negative balances from payments."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_unification_account_controller_stripe_dashboard

{
  "type": "object",
  "title": "AccountUnificationAccountControllerStripeDashboard",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "express",
        "full",
        "none"
      ],
      "type": "string",
      "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object address

{
  "type": "object",
  "title": "Address",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City, district, suburb, town, or village."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1, such as the street, PO Box, or company name."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2, such as the apartment, suite, unit, or building."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object alma_installments

{
  "type": "object",
  "title": "alma_installments",
  "required": [
    "count"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of installments."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object amazon_pay_underlying_payment_method_funding_details

{
  "type": "object",
  "title": "amazon_pay_underlying_payment_method_funding_details",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/payment_method_details_passthrough_card"
    },
    "type": {
      "enum": [
        "card"
      ],
      "type": "string",
      "nullable": true,
      "description": "funding type of the underlying payment method."
    }
  },
  "description": "",
  "x-expandableFields": [
    "card"
  ]
}

object api_errors

{
  "type": "object",
  "title": "APIErrors",
  "required": [
    "type"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported."
    },
    "type": {
      "enum": [
        "api_error",
        "card_error",
        "idempotency_error",
        "invalid_request_error"
      ],
      "type": "string",
      "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`"
    },
    "param": {
      "type": "string",
      "maxLength": 5000,
      "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field."
    },
    "charge": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors, the ID of the failed charge."
    },
    "source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_account"
        },
        {
          "$ref": "#/components/schemas/card"
        },
        {
          "$ref": "#/components/schemas/source"
        }
      ],
      "description": "The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source.",
      "x-stripeBypassValidation": true
    },
    "doc_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported."
    },
    "message": {
      "type": "string",
      "maxLength": 40000,
      "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users."
    },
    "advice_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one."
    },
    "decline_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one."
    },
    "setup_intent": {
      "$ref": "#/components/schemas/setup_intent"
    },
    "payment_intent": {
      "$ref": "#/components/schemas/payment_intent"
    },
    "payment_method": {
      "$ref": "#/components/schemas/payment_method"
    },
    "request_log_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL to the request log entry in your dashboard."
    },
    "network_advice_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error."
    },
    "payment_method_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors."
    },
    "network_decline_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For payments declined by the network, an alphanumeric code which indicates the reason the payment failed."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_intent",
    "payment_method",
    "setup_intent",
    "source"
  ]
}

object apple_pay_domain

{
  "type": "object",
  "title": "ApplePayDomain",
  "required": [
    "created",
    "domain_name",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "apple_pay_domain"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "domain_name": {
      "type": "string",
      "maxLength": 5000
    }
  },
  "description": "",
  "x-resourceId": "apple_pay_domain",
  "x-expandableFields": []
}

object application

{
  "type": "object",
  "title": "Application",
  "required": [
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the application."
    },
    "object": {
      "enum": [
        "application"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object application_fee

{
  "type": "object",
  "title": "PlatformFee",
  "required": [
    "account",
    "amount",
    "amount_refunded",
    "application",
    "charge",
    "created",
    "currency",
    "id",
    "livemode",
    "object",
    "refunded",
    "refunds"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount earned, in cents (or local equivalent)."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "ID of the charge that the application fee was taken from.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "application_fee"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "ID of the Stripe account this fee was taken from.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "refunds": {
      "type": "object",
      "title": "FeeRefundList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/fee_refund"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of refunds that have been applied to the fee.",
      "x-expandableFields": [
        "data"
      ]
    },
    "currency": {
      "type": "string",
      "format": "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)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "refunded": {
      "type": "boolean",
      "description": "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false."
    },
    "fee_source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/platform_earning_fee_source"
        }
      ],
      "nullable": true,
      "description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from."
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "description": "ID of the Connect application that earned the fee.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "amount_refunded": {
      "type": "integer",
      "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)"
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "originating_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    }
  },
  "description": "",
  "x-resourceId": "application_fee",
  "x-expandableFields": [
    "account",
    "application",
    "balance_transaction",
    "charge",
    "fee_source",
    "originating_transaction",
    "refunds"
  ]
}

object apps.secret

{
  "type": "object",
  "title": "SecretServiceResourceSecret",
  "required": [
    "created",
    "id",
    "livemode",
    "name",
    "object",
    "scope"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "A name for the secret that's unique within the scope."
    },
    "scope": {
      "$ref": "#/components/schemas/secret_service_resource_scope"
    },
    "object": {
      "enum": [
        "apps.secret"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "deleted": {
      "type": "boolean",
      "description": "If true, indicates that this secret has been deleted"
    },
    "payload": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The plaintext secret value to be stored."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes."
    }
  },
  "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects)",
  "x-resourceId": "apps.secret",
  "x-expandableFields": [
    "scope"
  ]
}

object automatic_tax

{
  "type": "object",
  "title": "AutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "status": {
      "enum": [
        "complete",
        "failed",
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "The status of the most recent automated tax calculation for this invoice."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices."
    },
    "provider": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tax provider powering automatic tax."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    },
    "disabled_reason": {
      "enum": [
        "finalization_requires_location_inputs",
        "finalization_system_error"
      ],
      "type": "string",
      "nullable": true,
      "description": "If Stripe disabled automatic tax, this enum describes why."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object balance

{
  "type": "object",
  "title": "Balance",
  "required": [
    "available",
    "livemode",
    "object",
    "pending"
  ],
  "properties": {
    "object": {
      "enum": [
        "balance"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "issuing": {
      "$ref": "#/components/schemas/balance_detail"
    },
    "pending": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property."
    },
    "connect_reserved": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property."
    },
    "instant_available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount_net"
      },
      "description": "Funds that you can pay out using Instant Payouts."
    },
    "refund_and_dispute_prefunding": {
      "$ref": "#/components/schemas/balance_detail_ungated"
    }
  },
  "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nThe top-level `available` and `pending` comprise your \"payments balance.\"\n\nRelated guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances)",
  "x-resourceId": "balance",
  "x-expandableFields": [
    "available",
    "connect_reserved",
    "instant_available",
    "issuing",
    "pending",
    "refund_and_dispute_prefunding"
  ]
}

object balance_amount

{
  "type": "object",
  "title": "BalanceAmount",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Balance amount."
    },
    "currency": {
      "type": "string",
      "format": "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)."
    },
    "source_types": {
      "$ref": "#/components/schemas/balance_amount_by_source_type"
    }
  },
  "description": "",
  "x-expandableFields": [
    "source_types"
  ]
}

object balance_amount_by_source_type

{
  "type": "object",
  "title": "BalanceAmountBySourceType",
  "properties": {
    "fpx": {
      "type": "integer",
      "description": "Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method."
    },
    "card": {
      "type": "integer",
      "description": "Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits)."
    },
    "bank_account": {
      "type": "integer",
      "description": "Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object balance_amount_net

{
  "type": "object",
  "title": "BalanceAmountNet",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Balance amount."
    },
    "currency": {
      "type": "string",
      "format": "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)."
    },
    "source_types": {
      "$ref": "#/components/schemas/balance_amount_by_source_type"
    },
    "net_available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_net_available"
      },
      "description": "Breakdown of balance by destination."
    }
  },
  "description": "",
  "x-expandableFields": [
    "net_available",
    "source_types"
  ]
}

object balance_detail

{
  "type": "object",
  "title": "BalanceDetail",
  "required": [
    "available"
  ],
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that are available for use."
    }
  },
  "description": "",
  "x-expandableFields": [
    "available"
  ]
}

object balance_detail_ungated

{
  "type": "object",
  "title": "BalanceDetailUngated",
  "required": [
    "available",
    "pending"
  ],
  "properties": {
    "pending": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that are pending"
    },
    "available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that are available for use."
    }
  },
  "description": "",
  "x-expandableFields": [
    "available",
    "pending"
  ]
}

object balance_net_available

{
  "type": "object",
  "title": "BalanceNetAvailable",
  "required": [
    "amount",
    "destination"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Net balance amount, subtracting fees from platform-set pricing."
    },
    "destination": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the external account for this net balance (not expandable)."
    },
    "source_types": {
      "$ref": "#/components/schemas/balance_amount_by_source_type"
    }
  },
  "description": "",
  "x-expandableFields": [
    "source_types"
  ]
}

object balance_settings

{
  "type": "object",
  "title": "BalanceSettingsResourceBalanceSettings",
  "required": [
    "object",
    "payments"
  ],
  "properties": {
    "object": {
      "enum": [
        "balance_settings"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "payments": {
      "$ref": "#/components/schemas/balance_settings_resource_payments"
    }
  },
  "description": "Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.",
  "x-resourceId": "balance_settings",
  "x-expandableFields": [
    "payments"
  ]
}

object balance_settings_resource_payments

{
  "type": "object",
  "title": "BalanceSettingsResourcePayments",
  "required": [
    "settlement_timing"
  ],
  "properties": {
    "payouts": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/balance_settings_resource_payouts"
        }
      ],
      "nullable": true,
      "description": "Settings specific to the account's payouts."
    },
    "settlement_timing": {
      "$ref": "#/components/schemas/balance_settings_resource_settlement_timing"
    },
    "debit_negative_balances": {
      "type": "boolean",
      "nullable": true,
      "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payouts",
    "settlement_timing"
  ]
}

Load more schemas

Versions

Version	Endpoints	Schemas	Ingested	Status
2026-04-22.dahlia	587	1385	2026-04-27	current
2026-03-25.dahlia	587	1359	2026-04-19