openapi.city
Sign in

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

Clear filters
GET POST PUT PATCH DELETE

Accountsessions 1 endpoints

POST /v1/account_sessions

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 13 endpoints

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
POST /v1/accounts/{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 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
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}
POST /v1/accounts/{account}/capabilities/{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}
POST /v1/accounts/{account}/external_accounts

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
POST /v1/accounts/{account}/external_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: 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

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
POST /v1/accounts/{account}/people

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
POST /v1/accounts/{account}/people/{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}
POST /v1/accounts/{account}/persons

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
POST /v1/accounts/{account}/persons/{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

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 1 endpoints

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

Applicationfees 3 endpoints

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

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}
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
POST /v1/application_fees/{id}/refunds

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 2 endpoints

POST /v1/apps/secrets

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

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

Balancesettings 1 endpoints

POST /v1/balance_settings

Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts

operationId: PostBalanceSettings

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
payments object optional
└ payouts object optional
└ schedule object optional
└ interval string optional
└ weekly_payout_days array optional
└ monthly_payout_days array optional
└ statement_descriptor string optional
└ minimum_balance_by_currency object optional
└ settlement_timing object optional
└ delay_days_override object optional
└ debit_negative_balances boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/balance_settings

Billing 14 endpoints

POST /v1/billing/alerts

Creates a billing alert

operationId: PostBillingAlerts

Request Body

required
application/x-www-form-urlencoded
Property Type Required
title string required
expand array optional
alert_type string required
usage_threshold object optional
└ gte integer required
└ meter string required
└ filters array optional
└ type string required
└ customer string optional
└ recurrence string required

Responses

default

Error response.
200

Successful response.
POST /v1/billing/alerts
POST /v1/billing/alerts/{id}/activate

Reactivates this alert, allowing it to trigger again.

operationId: PostBillingAlertsIdActivate

Parameters

Name In Required Type Description
id 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/billing/alerts/{id}/activate
POST /v1/billing/alerts/{id}/archive

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

operationId: PostBillingAlertsIdArchive

Parameters

Name In Required Type Description
id 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/billing/alerts/{id}/archive
POST /v1/billing/alerts/{id}/deactivate

Deactivates this alert, preventing it from triggering.

operationId: PostBillingAlertsIdDeactivate

Parameters

Name In Required Type Description
id 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/billing/alerts/{id}/deactivate
POST /v1/billing/credit_grants

Creates a credit grant.

operationId: PostBillingCreditGrants

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name string optional
amount object required
└ type string required
└ monetary object optional
└ value integer required
└ currency string required
expand array optional
category string optional
customer string optional
metadata object optional
priority integer optional
expires_at integer optional
effective_at integer optional
customer_account string optional
applicability_config object required
└ scope object required
└ prices array optional
└ id string required
└ price_type string optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing/credit_grants
POST /v1/billing/credit_grants/{id}

Updates a credit grant.

operationId: PostBillingCreditGrantsId

Parameters

Name In Required Type Description
id path required string

Unique identifier for the object.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
expires_at object optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing/credit_grants/{id}
POST /v1/billing/credit_grants/{id}/expire

Expires a credit grant.

operationId: PostBillingCreditGrantsIdExpire

Parameters

Name In Required Type Description
id path required string

Unique identifier for the object.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing/credit_grants/{id}/expire
POST /v1/billing/credit_grants/{id}/void

Voids a credit grant.

operationId: PostBillingCreditGrantsIdVoid

Parameters

Name In Required Type Description
id path required string

Unique identifier for the object.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing/credit_grants/{id}/void
POST /v1/billing/meter_event_adjustments

Creates a billing meter event adjustment.

operationId: PostBillingMeterEventAdjustments

Request Body

required
application/x-www-form-urlencoded
Property Type Required
type string required
cancel object optional
└ identifier string optional
expand array optional
event_name string required

Responses

default

Error response.
200

Successful response.
POST /v1/billing/meter_event_adjustments
POST /v1/billing/meter_events

Creates a billing meter event.

operationId: PostBillingMeterEvents

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
payload object required
timestamp integer optional
event_name string required
identifier string optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing/meter_events
POST /v1/billing/meters

Creates a billing meter.

operationId: PostBillingMeters

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
event_name string required
display_name string required
value_settings object optional
└ event_payload_key string required
customer_mapping object optional
└ type string required
└ event_payload_key string required
event_time_window string optional
default_aggregation object required
└ formula string required

Responses

default

Error response.
200

Successful response.
POST /v1/billing/meters
POST /v1/billing/meters/{id}

Updates a billing meter.

operationId: PostBillingMetersId

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
display_name string optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing/meters/{id}
POST /v1/billing/meters/{id}/deactivate

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

operationId: PostBillingMetersIdDeactivate

Parameters

Name In Required Type Description
id 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/billing/meters/{id}/deactivate
POST /v1/billing/meters/{id}/reactivate

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

operationId: PostBillingMetersIdReactivate

Parameters

Name In Required Type Description
id 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/billing/meters/{id}/reactivate

Billingportal 3 endpoints

POST /v1/billing_portal/configurations

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

operationId: PostBillingPortalConfigurations

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name object optional
expand array optional
features object required
└ customer_update object optional
└ enabled boolean required
└ allowed_updates object optional
└ invoice_history object optional
└ enabled boolean required
└ subscription_cancel object optional
└ mode string optional
└ enabled boolean required
└ proration_behavior string optional
└ cancellation_reason object optional
└ enabled boolean required
└ options object required
└ subscription_update object optional
└ enabled boolean required
└ products object optional
└ proration_behavior string optional
└ billing_cycle_anchor string optional
└ trial_update_behavior string optional
└ schedule_at_period_end object optional
└ conditions array optional
└ default_allowed_updates object optional
└ payment_method_update object optional
└ enabled boolean required
└ payment_method_configuration object optional
metadata object optional
login_page object optional
└ enabled boolean required
business_profile object optional
└ headline object optional
└ privacy_policy_url string optional
└ terms_of_service_url string optional
default_return_url object optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing_portal/configurations
POST /v1/billing_portal/configurations/{configuration}

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

operationId: PostBillingPortalConfigurationsConfiguration

Parameters

Name In Required Type Description
configuration path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
name object optional
active boolean optional
expand array optional
features object optional
└ customer_update object optional
└ enabled boolean optional
└ allowed_updates object optional
└ invoice_history object optional
└ enabled boolean required
└ subscription_cancel object optional
└ mode string optional
└ enabled boolean optional
└ proration_behavior string optional
└ cancellation_reason object optional
└ enabled boolean required
└ options object optional
└ subscription_update object optional
└ enabled boolean optional
└ products object optional
└ proration_behavior string optional
└ billing_cycle_anchor string optional
└ trial_update_behavior string optional
└ schedule_at_period_end object optional
└ conditions object optional
└ default_allowed_updates object optional
└ payment_method_update object optional
└ enabled boolean required
└ payment_method_configuration object optional
metadata object optional
login_page object optional
└ enabled boolean required
business_profile object optional
└ headline object optional
└ privacy_policy_url object optional
└ terms_of_service_url object optional
default_return_url object optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing_portal/configurations/{configuration}
POST /v1/billing_portal/sessions

Creates a session of the customer portal.

operationId: PostBillingPortalSessions

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
locale string optional
customer string optional
flow_data object optional
└ type string required
└ after_completion object optional
└ type string required
└ redirect object optional
└ return_url string required
└ hosted_confirmation object optional
└ custom_message string optional
└ subscription_cancel object optional
└ retention object optional
└ type string required
└ coupon_offer object required
└ subscription string required
└ subscription_update object optional
└ subscription string required
└ subscription_update_confirm object optional
└ items array required
└ id string required
└ price string optional
└ quantity integer optional
└ discounts array optional
└ coupon string optional
└ promotion_code string optional
└ subscription string required
return_url string optional
on_behalf_of string optional
configuration string optional
customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/billing_portal/sessions

Charges 8 endpoints

POST /v1/charges

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

operationId: PostCharges

Request Body

application/x-www-form-urlencoded
Property Type Required
card object optional
amount integer optional
expand array optional
source string optional
capture boolean optional
currency string optional
customer string optional
metadata object optional
shipping object optional
└ name string required
└ phone string optional
└ address object required
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
└ carrier string optional
└ tracking_number string optional
description string optional
destination object optional
on_behalf_of string optional
radar_options object optional
└ session string optional
receipt_email string optional
transfer_data object optional
└ amount integer optional
└ destination string required
transfer_group string optional
application_fee integer optional
statement_descriptor string optional
application_fee_amount integer optional
statement_descriptor_suffix string optional

Responses

default

Error response.
200

Successful response.
POST /v1/charges
POST /v1/charges/{charge}

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

operationId: PostChargesCharge

Parameters

Name In Required Type Description
charge path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
customer string optional
metadata object optional
shipping object optional
└ name string required
└ phone string optional
└ address object required
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
└ carrier string optional
└ tracking_number string optional
description string optional
fraud_details object optional
└ user_report string required
receipt_email string optional
transfer_group string optional

Responses

default

Error response.
200

Successful response.
POST /v1/charges/{charge}
POST /v1/charges/{charge}/capture

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

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

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

operationId: PostChargesChargeCapture

Parameters

Name In Required Type Description
charge path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
receipt_email string optional
transfer_data object optional
└ amount integer optional
transfer_group string optional
application_fee integer optional
statement_descriptor string optional
application_fee_amount integer optional
statement_descriptor_suffix string optional

Responses

default

Error response.
200

Successful response.
POST /v1/charges/{charge}/capture
POST /v1/charges/{charge}/dispute
operationId: PostChargesChargeDispute

Parameters

Name In Required Type Description
charge path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
submit boolean optional
evidence object optional
└ receipt string optional
└ service_date string optional
└ customer_name string optional
└ refund_policy string optional
└ shipping_date string optional
└ billing_address string optional
└ shipping_address string optional
└ shipping_carrier string optional
└ enhanced_evidence object optional
└ customer_signature string optional
└ uncategorized_file string optional
└ uncategorized_text string optional
└ access_activity_log string optional
└ cancellation_policy string optional
└ duplicate_charge_id string optional
└ product_description string optional
└ customer_purchase_ip string optional
└ cancellation_rebuttal string optional
└ service_documentation string optional
└ customer_communication string optional
└ …8 more object optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/charges/{charge}/dispute
POST /v1/charges/{charge}/dispute/close
operationId: PostChargesChargeDisputeClose

Parameters

Name In Required Type Description
charge 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/charges/{charge}/dispute/close
POST /v1/charges/{charge}/refund

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

This action refunds a previously created charge that’s not refunded yet. Funds are refunded to the credit or debit card that’s originally charged.

You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded.

After you entirely refund a charge, you can’t refund it again. This method raises an error when it’s called on an already-refunded charge, or when you attempt to refund more money than is left on a charge.

operationId: PostChargesChargeRefund

Parameters

Name In Required Type Description
charge path required string

The identifier of the charge to refund.

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
reason string optional
metadata object optional
payment_intent string optional
reverse_transfer boolean optional
instructions_email string optional
refund_application_fee boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/charges/{charge}/refund
POST /v1/charges/{charge}/refunds

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

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

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

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

operationId: PostChargesChargeRefunds

Parameters

Name In Required Type Description
charge path required string

The identifier of the charge to refund.

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
origin string optional
reason string optional
currency string optional
customer string optional
metadata object optional
payment_intent string optional
reverse_transfer boolean optional
instructions_email string optional
refund_application_fee boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/charges/{charge}/refunds
POST /v1/charges/{charge}/refunds/{refund}

Update a specified refund.

operationId: PostChargesChargeRefundsRefund

Parameters

Name In Required Type Description
charge path required string —
refund 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/charges/{charge}/refunds/{refund}

Checkout 3 endpoints

POST /v1/checkout/sessions

Creates a Checkout Session object.

operationId: PostCheckoutSessions

Request Body

application/x-www-form-urlencoded
Property Type Required
mode string optional
expand array optional
locale string optional
ui_mode string optional
currency string optional
customer string optional
metadata object optional
discounts array optional
└ coupon string optional
└ promotion_code string optional
cancel_url string optional
expires_at integer optional
line_items array optional
└ price string optional
└ metadata object optional
└ quantity integer optional
└ tax_rates array optional
└ price_data object optional
└ product string optional
└ currency string required
└ recurring object optional
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ product_data object optional
└ name string required
└ images array optional
└ metadata object optional
└ tax_code string optional
└ unit_label string optional
└ description string optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ dynamic_tax_rates array optional
└ adjustable_quantity object optional
└ enabled boolean required
└ maximum integer optional
└ minimum integer optional
return_url string optional
custom_text object optional
└ submit object optional
└ after_submit object optional
└ shipping_address object optional
└ terms_of_service_acceptance object optional
permissions object optional
└ update_shipping_details string optional
submit_type string optional
success_url string optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
custom_fields array optional
└ key string required
└ text object optional
└ default_value string optional
└ maximum_length integer optional
└ minimum_length integer optional
└ type string required
└ label object required
└ type string required
└ custom string required
└ numeric object optional
└ default_value string optional
└ maximum_length integer optional
└ minimum_length integer optional
└ dropdown object optional
└ options array required
└ label string required
└ value string required
└ default_value string optional
└ optional boolean optional
customer_email string optional
optional_items array optional
└ price string required
└ quantity integer required
└ adjustable_quantity object optional
└ enabled boolean required
└ maximum integer optional
└ minimum integer optional
…31 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/checkout/sessions
POST /v1/checkout/sessions/{session}

Updates a Checkout Session object.

Related guide: Dynamically update a Checkout Session

operationId: PostCheckoutSessionsSession

Parameters

Name In Required Type Description
session path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
line_items array optional
└ id string optional
└ price string optional
└ metadata object optional
└ quantity integer optional
└ tax_rates object optional
└ price_data object optional
└ product string optional
└ currency string required
└ recurring object optional
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ product_data object optional
└ name string required
└ images array optional
└ metadata object optional
└ tax_code string optional
└ unit_label string optional
└ description string optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ adjustable_quantity object optional
└ enabled boolean required
└ maximum integer optional
└ minimum integer optional
shipping_options object optional
collected_information object optional
└ shipping_details object optional
└ name string required
└ address object required
└ city string optional
└ line1 string required
└ line2 string optional
└ state string optional
└ country string required
└ postal_code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/checkout/sessions/{session}
POST /v1/checkout/sessions/{session}/expire

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

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

operationId: PostCheckoutSessionsSessionExpire

Parameters

Name In Required Type Description
session 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/checkout/sessions/{session}/expire

Climate 3 endpoints

POST /v1/climate/orders

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

operationId: PostClimateOrders

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
product string required
currency string optional
metadata object optional
beneficiary object optional
└ public_name string required
metric_tons string optional

Responses

default

Error response.
200

Successful response.
POST /v1/climate/orders
POST /v1/climate/orders/{order}

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

operationId: PostClimateOrdersOrder

Parameters

Name In Required Type Description
order path required string

Unique identifier of the order.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
beneficiary object optional

Responses

default

Error response.
200

Successful response.
POST /v1/climate/orders/{order}
POST /v1/climate/orders/{order}/cancel

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the amount_total.

operationId: PostClimateOrdersOrderCancel

Parameters

Name In Required Type Description
order path required string

Unique identifier of the order.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/climate/orders/{order}/cancel

Coupons 2 endpoints

POST /v1/coupons

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

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

operationId: PostCoupons

Request Body

application/x-www-form-urlencoded
Property Type Required
id string optional
name string optional
expand array optional
currency string optional
duration string optional
metadata object optional
redeem_by integer optional
amount_off integer optional
applies_to object optional
└ products array optional
percent_off number optional
max_redemptions integer optional
currency_options object optional
duration_in_months integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/coupons
POST /v1/coupons/{coupon}

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

operationId: PostCouponsCoupon

Parameters

Name In Required Type Description
coupon path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
expand array optional
metadata object optional
currency_options object optional

Responses

default

Error response.
200

Successful response.
POST /v1/coupons/{coupon}

Creditnotes 3 endpoints

POST /v1/credit_notes

Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:

  • Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.

You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount, post_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.

operationId: PostCreditNotes

Request Body

required
application/x-www-form-urlencoded
Property Type Required
memo string optional
lines array optional
└ type string required
└ amount integer optional
└ metadata object optional
└ quantity integer optional
└ tax_rates object optional
└ description string optional
└ tax_amounts object optional
└ unit_amount integer optional
└ invoice_line_item string optional
└ unit_amount_decimal string optional
amount integer optional
expand array optional
reason string optional
invoice string required
refunds array optional
└ type string optional
└ refund string optional
└ amount_refunded integer optional
└ payment_record_refund object optional
└ refund_group string required
└ payment_record string required
metadata object optional
email_type string optional
effective_at integer optional
credit_amount integer optional
refund_amount integer optional
shipping_cost object optional
└ shipping_rate string optional
out_of_band_amount integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/credit_notes
POST /v1/credit_notes/{id}

Updates an existing credit note.

operationId: PostCreditNotesId

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
memo string optional
expand array optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/credit_notes/{id}
POST /v1/credit_notes/{id}/void

Marks a credit note as void. Learn more about voiding credit notes.

operationId: PostCreditNotesIdVoid

Parameters

Name In Required Type Description
id 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/credit_notes/{id}/void

Customersessions 1 endpoints

POST /v1/customer_sessions

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

operationId: PostCustomerSessions

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
customer string optional
components object required
└ buy_button object optional
└ enabled boolean required
└ pricing_table object optional
└ enabled boolean required
└ customer_sheet object optional
└ enabled boolean required
└ features object optional
└ payment_method_remove string optional
└ payment_method_allow_redisplay_filters array optional
└ payment_element object optional
└ enabled boolean required
└ features object optional
└ payment_method_save string optional
└ payment_method_remove string optional
└ payment_method_redisplay string optional
└ payment_method_save_usage string optional
└ payment_method_redisplay_limit integer optional
└ payment_method_allow_redisplay_filters array optional
└ mobile_payment_element object optional
└ enabled boolean required
└ features object optional
└ payment_method_save string optional
└ payment_method_remove string optional
└ payment_method_redisplay string optional
└ payment_method_allow_redisplay_filters array optional
└ payment_method_save_allow_redisplay_override string optional
customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customer_sessions

Customers 17 endpoints

POST /v1/customers

Creates a new customer object.

operationId: PostCustomers

Request Body

application/x-www-form-urlencoded
Property Type Required
tax object optional
└ ip_address object optional
└ validate_location string optional
name string optional
email string optional
phone string optional
expand array optional
source string optional
address object optional
balance integer optional
metadata object optional
shipping object optional
tax_exempt string optional
test_clock string optional
description string optional
tax_id_data array optional
└ type string required
└ value string required
cash_balance object optional
└ settings object optional
└ reconciliation_mode string optional
business_name object optional
invoice_prefix string optional
payment_method string optional
individual_name object optional
invoice_settings object optional
└ footer string optional
└ custom_fields object optional
└ rendering_options object optional
└ default_payment_method string optional
…2 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers
POST /v1/customers/{customer}

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

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

operationId: PostCustomersCustomer

Parameters

Name In Required Type Description
customer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
tax object optional
└ ip_address object optional
└ validate_location string optional
card object optional
name string optional
email string optional
phone string optional
expand array optional
source string optional
address object optional
balance integer optional
metadata object optional
shipping object optional
tax_exempt string optional
description string optional
bank_account object optional
cash_balance object optional
└ settings object optional
└ reconciliation_mode string optional
default_card string optional
business_name object optional
default_source string optional
invoice_prefix string optional
individual_name object optional
…5 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}
POST /v1/customers/{customer}/balance_transactions

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

operationId: PostCustomersCustomerBalanceTransactions

Parameters

Name In Required Type Description
customer path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
currency string required
metadata object optional
description string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/balance_transactions
POST /v1/customers/{customer}/balance_transactions/{transaction}

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

operationId: PostCustomersCustomerBalanceTransactionsTransaction

Parameters

Name In Required Type Description
customer path required string —
transaction path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
description string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/balance_transactions/{transaction}
POST /v1/customers/{customer}/bank_accounts

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

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

operationId: PostCustomersCustomerBankAccounts

Parameters

Name In Required Type Description
customer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
card object optional
expand array optional
source string optional
metadata object optional
bank_account object optional
alipay_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/bank_accounts
POST /v1/customers/{customer}/bank_accounts/{id}

Update a specified source for a given customer.

operationId: PostCustomersCustomerBankAccountsId

Parameters

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

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
owner object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
expand array optional
exp_year string optional
metadata object optional
exp_month string optional
address_zip 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

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/bank_accounts/{id}
POST /v1/customers/{customer}/bank_accounts/{id}/verify

Verify a specified bank account for a given customer.

operationId: PostCustomersCustomerBankAccountsIdVerify

Parameters

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

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
amounts array optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/bank_accounts/{id}/verify
POST /v1/customers/{customer}/cards

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

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

operationId: PostCustomersCustomerCards

Parameters

Name In Required Type Description
customer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
card object optional
expand array optional
source string optional
metadata object optional
bank_account object optional
alipay_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/cards
POST /v1/customers/{customer}/cards/{id}

Update a specified source for a given customer.

operationId: PostCustomersCustomerCardsId

Parameters

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

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
owner object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
expand array optional
exp_year string optional
metadata object optional
exp_month string optional
address_zip 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

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/cards/{id}
POST /v1/customers/{customer}/cash_balance

Changes the settings on a customer’s cash balance.

operationId: PostCustomersCustomerCashBalance

Parameters

Name In Required Type Description
customer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
settings object optional
└ reconciliation_mode string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/cash_balance
POST /v1/customers/{customer}/funding_instructions

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

operationId: PostCustomersCustomerFundingInstructions

Parameters

Name In Required Type Description
customer path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
currency string required
funding_type string required
bank_transfer object required
└ type string required
└ eu_bank_transfer object optional
└ country string required
└ requested_address_types array optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/funding_instructions
POST /v1/customers/{customer}/sources

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

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

operationId: PostCustomersCustomerSources

Parameters

Name In Required Type Description
customer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
card object optional
expand array optional
source string optional
metadata object optional
bank_account object optional
alipay_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/sources
POST /v1/customers/{customer}/sources/{id}

Update a specified source for a given customer.

operationId: PostCustomersCustomerSourcesId

Parameters

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

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
owner object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
expand array optional
exp_year string optional
metadata object optional
exp_month string optional
address_zip 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

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/sources/{id}
POST /v1/customers/{customer}/sources/{id}/verify

Verify a specified bank account for a given customer.

operationId: PostCustomersCustomerSourcesIdVerify

Parameters

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

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
amounts array optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/sources/{id}/verify
POST /v1/customers/{customer}/subscriptions

Creates a new subscription on an existing customer.

operationId: PostCustomersCustomerSubscriptions

Parameters

Name In Required Type Description
customer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
items array optional
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ billing_thresholds object optional
expand array optional
currency string optional
metadata object optional
cancel_at object optional
discounts object optional
trial_end object optional
off_session boolean optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
transfer_data object optional
└ destination string required
└ amount_percent number optional
days_until_due integer optional
default_source string optional
trial_settings object optional
└ end_behavior object required
└ missing_payment_method string required
trial_from_plan boolean optional
invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ account_tax_ids object optional
payment_behavior string optional
payment_settings object optional
└ payment_method_types object optional
└ payment_method_options object optional
└ pix object optional
└ upi object optional
└ card object optional
└ payto object optional
└ konbini object optional
└ acss_debit object optional
└ bancontact object optional
└ sepa_debit object optional
└ us_bank_account object optional
└ customer_balance object optional
└ save_default_payment_method string optional
add_invoice_items array optional
└ price string optional
└ period object optional
└ end object required
└ type string required
└ timestamp integer optional
└ start object required
└ type string required
└ timestamp integer optional
└ metadata object optional
└ quantity integer optional
└ discounts array optional
└ coupon string optional
└ discount string optional
└ promotion_code string optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
collection_method string optional
default_tax_rates object optional
…9 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/subscriptions
POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}

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

operationId: PostCustomersCustomerSubscriptionsSubscriptionExposedId

Parameters

Name In Required Type Description
customer path required string —
subscription_exposed_id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
items array optional
└ id string optional
└ price string optional
└ deleted boolean optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ clear_usage boolean optional
└ billing_thresholds object optional
expand array optional
metadata object optional
cancel_at object optional
discounts object optional
trial_end object optional
off_session boolean optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
transfer_data object optional
days_until_due integer optional
default_source object optional
proration_date integer optional
trial_settings object optional
└ end_behavior object required
└ missing_payment_method string required
trial_from_plan boolean optional
invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ account_tax_ids object optional
pause_collection object optional
payment_behavior string optional
payment_settings object optional
└ payment_method_types object optional
└ payment_method_options object optional
└ pix object optional
└ upi object optional
└ card object optional
└ payto object optional
└ konbini object optional
└ acss_debit object optional
└ bancontact object optional
└ sepa_debit object optional
└ us_bank_account object optional
└ customer_balance object optional
└ save_default_payment_method string optional
add_invoice_items array optional
└ price string optional
└ period object optional
└ end object required
└ type string required
└ timestamp integer optional
└ start object required
└ type string required
└ timestamp integer optional
└ metadata object optional
└ quantity integer optional
└ discounts array optional
└ coupon string optional
└ discount string optional
└ promotion_code string optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
collection_method string optional
…9 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
POST /v1/customers/{customer}/tax_ids

Creates a new tax_id object for a customer.

operationId: PostCustomersCustomerTaxIds

Parameters

Name In Required Type Description
customer path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
type string required
value string required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/customers/{customer}/tax_ids

Disputes 2 endpoints

POST /v1/disputes/{dispute}

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

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

operationId: PostDisputesDispute

Parameters

Name In Required Type Description
dispute path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
submit boolean optional
evidence object optional
└ receipt string optional
└ service_date string optional
└ customer_name string optional
└ refund_policy string optional
└ shipping_date string optional
└ billing_address string optional
└ shipping_address string optional
└ shipping_carrier string optional
└ enhanced_evidence object optional
└ customer_signature string optional
└ uncategorized_file string optional
└ uncategorized_text string optional
└ access_activity_log string optional
└ cancellation_policy string optional
└ duplicate_charge_id string optional
└ product_description string optional
└ customer_purchase_ip string optional
└ cancellation_rebuttal string optional
└ service_documentation string optional
└ customer_communication string optional
└ …8 more object optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/disputes/{dispute}
POST /v1/disputes/{dispute}/close

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

operationId: PostDisputesDisputeClose

Parameters

Name In Required Type Description
dispute 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/disputes/{dispute}/close

Entitlements 2 endpoints

POST /v1/entitlements/features

Creates a feature

operationId: PostEntitlementsFeatures

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name string required
expand array optional
metadata object optional
lookup_key string required

Responses

default

Error response.
200

Successful response.
POST /v1/entitlements/features
POST /v1/entitlements/features/{id}

Update a feature’s metadata or permanently deactivate it.

operationId: PostEntitlementsFeaturesId

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
active boolean optional
expand array optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/entitlements/features/{id}

Ephemeralkeys 1 endpoints

POST /v1/ephemeral_keys

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

operationId: PostEphemeralKeys

Request Body

application/x-www-form-urlencoded
Property Type Required
nonce string optional
expand array optional
customer string optional
issuing_card string optional
verification_session string optional

Responses

default

Error response.
200

Successful response.
POST /v1/ephemeral_keys

Externalaccounts 1 endpoints

POST /v1/external_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: PostExternalAccountsId

Parameters

Name In Required Type Description
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/external_accounts/{id}

Files 1 endpoints

POST /v1/files

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

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

operationId: PostFiles

Request Body

required
multipart/form-data
Property Type Required
file string required
expand array optional
purpose string required
file_link_data object optional
└ create boolean required
└ metadata object optional
└ expires_at integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/files

Financialconnections 5 endpoints

POST /v1/financial_connections/accounts/{account}/disconnect

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

operationId: PostFinancialConnectionsAccountsAccountDisconnect

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/financial_connections/accounts/{account}/disconnect
POST /v1/financial_connections/accounts/{account}/refresh

Refreshes the data associated with a Financial Connections Account.

operationId: PostFinancialConnectionsAccountsAccountRefresh

Parameters

Name In Required Type Description
account path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
features array required

Responses

default

Error response.
200

Successful response.
POST /v1/financial_connections/accounts/{account}/refresh
POST /v1/financial_connections/accounts/{account}/subscribe

Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.

operationId: PostFinancialConnectionsAccountsAccountSubscribe

Parameters

Name In Required Type Description
account path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
features array required

Responses

default

Error response.
200

Successful response.
POST /v1/financial_connections/accounts/{account}/subscribe
POST /v1/financial_connections/accounts/{account}/unsubscribe

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

operationId: PostFinancialConnectionsAccountsAccountUnsubscribe

Parameters

Name In Required Type Description
account path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
features array required

Responses

default

Error response.
200

Successful response.
POST /v1/financial_connections/accounts/{account}/unsubscribe
POST /v1/financial_connections/sessions

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

operationId: PostFinancialConnectionsSessions

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
filters object optional
└ countries array optional
└ account_subcategories array optional
prefetch array optional
return_url string optional
permissions array required
account_holder object required
└ type string required
└ account string optional
└ customer string optional
└ customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/financial_connections/sessions

Forwarding 1 endpoints

POST /v1/forwarding/requests

Creates a ForwardingRequest object.

operationId: PostForwardingRequests

Request Body

required
application/x-www-form-urlencoded
Property Type Required
url string required
expand array optional
request object optional
└ body string optional
└ headers array optional
└ name string required
└ value string required
metadata object optional
replacements array required
payment_method string required

Responses

default

Error response.
200

Successful response.
POST /v1/forwarding/requests

Identity 4 endpoints

POST /v1/identity/verification_sessions

Creates a VerificationSession object.

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

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

Related guide: Verify your users’ identity documents

operationId: PostIdentityVerificationSessions

Request Body

application/x-www-form-urlencoded
Property Type Required
type string optional
expand array optional
options object optional
└ document object optional
metadata object optional
return_url string optional
related_person object optional
└ person string required
└ account string required
provided_details object optional
└ email string optional
└ phone string optional
related_customer string optional
verification_flow string optional
client_reference_id string optional
related_customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/identity/verification_sessions
POST /v1/identity/verification_sessions/{session}

Updates a VerificationSession object.

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

operationId: PostIdentityVerificationSessionsSession

Parameters

Name In Required Type Description
session path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
type string optional
expand array optional
options object optional
└ document object optional
metadata object optional
provided_details object optional
└ email string optional
└ phone string optional

Responses

default

Error response.
200

Successful response.
POST /v1/identity/verification_sessions/{session}
POST /v1/identity/verification_sessions/{session}/cancel

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

operationId: PostIdentityVerificationSessionsSessionCancel

Parameters

Name In Required Type Description
session 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/identity/verification_sessions/{session}/cancel
POST /v1/identity/verification_sessions/{session}/redact

Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

A VerificationSession object can be redacted when it is in requires_input or verified status. Redacting a VerificationSession in requires_action state will automatically cancel it.

The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s redaction.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted event will be emitted.

Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string [redacted] or a similar placeholder. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

Learn more.

operationId: PostIdentityVerificationSessionsSessionRedact

Parameters

Name In Required Type Description
session 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/identity/verification_sessions/{session}/redact

Invoicerenderingtemplates 2 endpoints

POST /v1/invoice_rendering_templates/{template}/archive

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

operationId: PostInvoiceRenderingTemplatesTemplateArchive

Parameters

Name In Required Type Description
template 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/invoice_rendering_templates/{template}/archive
POST /v1/invoice_rendering_templates/{template}/unarchive

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

operationId: PostInvoiceRenderingTemplatesTemplateUnarchive

Parameters

Name In Required Type Description
template 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/invoice_rendering_templates/{template}/unarchive

Invoiceitems 2 endpoints

POST /v1/invoiceitems

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

operationId: PostInvoiceitems

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
period object optional
└ end integer required
└ start integer required
invoice string optional
pricing object optional
└ price string optional
currency string optional
customer string optional
metadata object optional
quantity integer optional
tax_code object optional
discounts object optional
tax_rates array optional
price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
description string optional
discountable boolean optional
subscription string optional
tax_behavior string optional
customer_account string optional
quantity_decimal string optional
unit_amount_decimal string optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoiceitems
POST /v1/invoiceitems/{invoiceitem}

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

operationId: PostInvoiceitemsInvoiceitem

Parameters

Name In Required Type Description
invoiceitem path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
period object optional
└ end integer required
└ start integer required
pricing object optional
└ price string optional
metadata object optional
quantity integer optional
tax_code object optional
discounts object optional
tax_rates object optional
price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
description string optional
discountable boolean optional
tax_behavior string optional
quantity_decimal string optional
unit_amount_decimal string optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoiceitems/{invoiceitem}

Invoices 13 endpoints

POST /v1/invoices

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

operationId: PostInvoices

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
footer string optional
issuer object optional
└ type string required
└ account string optional
number string optional
currency string optional
customer string optional
due_date integer optional
metadata object optional
discounts object optional
rendering object optional
└ pdf object optional
└ page_size string optional
└ template string optional
└ template_version object optional
└ amount_tax_display string optional
description string optional
auto_advance boolean optional
effective_at integer optional
from_invoice object optional
└ action string required
└ invoice string required
on_behalf_of string optional
subscription string optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
custom_fields object optional
shipping_cost object optional
└ shipping_rate string optional
└ shipping_rate_data object optional
└ type string optional
└ metadata object optional
└ tax_code string optional
└ display_name string required
└ fixed_amount object optional
└ amount integer required
└ currency string required
└ currency_options object optional
└ tax_behavior string optional
└ delivery_estimate object optional
└ maximum object optional
└ minimum object optional
transfer_data object optional
└ amount integer optional
└ destination string required
…13 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices
POST /v1/invoices/create_preview

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

You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.

The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

operationId: PostInvoicesCreatePreview

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
issuer object optional
└ type string required
└ account string optional
currency string optional
customer string optional
schedule string optional
discounts object optional
on_behalf_of object optional
preview_mode string optional
subscription string optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
invoice_items array optional
└ price string optional
└ amount integer optional
└ period object optional
└ end integer required
└ start integer required
└ currency string optional
└ metadata object optional
└ quantity integer optional
└ tax_code object optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ description string optional
└ invoiceitem string optional
└ unit_amount integer optional
└ discountable boolean optional
└ tax_behavior string optional
└ quantity_decimal string optional
└ unit_amount_decimal string optional
customer_account string optional
customer_details object optional
└ tax object optional
└ ip_address object optional
└ address object optional
└ tax_ids array optional
└ type string required
└ value string required
└ shipping object optional
└ tax_exempt string optional
schedule_details object optional
└ phases array optional
└ items array required
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ billing_thresholds object optional
└ trial boolean optional
└ duration object optional
└ interval string required
└ interval_count integer optional
└ end_date object optional
└ metadata object optional
└ discounts object optional
└ trial_end object optional
└ start_date object optional
└ description object optional
└ on_behalf_of string optional
└ automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ transfer_data object optional
└ destination string required
└ amount_percent number optional
└ invoice_settings object optional
└ issuer object optional
└ days_until_due integer optional
└ account_tax_ids object optional
└ add_invoice_items array optional
└ price string optional
└ period object optional
└ metadata object optional
└ quantity integer optional
└ discounts array optional
└ tax_rates object optional
└ price_data object optional
└ collection_method string optional
└ default_tax_rates object optional
└ billing_thresholds object optional
└ proration_behavior string optional
└ billing_cycle_anchor string optional
└ default_payment_method string optional
└ …1 more object optional
└ billing_mode object optional
└ type string required
└ flexible object optional
└ proration_discounts string optional
└ end_behavior string optional
└ proration_behavior string optional
subscription_details object optional
└ items array optional
└ id string optional
└ price string optional
└ deleted boolean optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ clear_usage boolean optional
└ billing_thresholds object optional
└ cancel_at object optional
└ resume_at string optional
└ trial_end object optional
└ cancel_now boolean optional
└ start_date integer optional
└ billing_mode object optional
└ type string required
└ flexible object optional
└ proration_discounts string optional
└ proration_date integer optional
└ default_tax_rates object optional
└ proration_behavior string optional
└ billing_cycle_anchor object optional
└ cancel_at_period_end boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/create_preview
POST /v1/invoices/{invoice}

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

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

operationId: PostInvoicesInvoice

Parameters

Name In Required Type Description
invoice path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
footer string optional
issuer object optional
└ type string required
└ account string optional
number object optional
due_date integer optional
metadata object optional
discounts object optional
rendering object optional
└ pdf object optional
└ page_size string optional
└ template string optional
└ template_version object optional
└ amount_tax_display string optional
description string optional
auto_advance boolean optional
effective_at object optional
on_behalf_of object optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
custom_fields object optional
shipping_cost object optional
transfer_data object optional
days_until_due integer optional
default_source object optional
account_tax_ids object optional
payment_settings object optional
└ default_mandate object optional
└ payment_method_types object optional
└ payment_method_options object optional
└ pix object optional
└ upi object optional
└ card object optional
└ payto object optional
└ konbini object optional
└ acss_debit object optional
└ bancontact object optional
└ sepa_debit object optional
└ us_bank_account object optional
└ customer_balance object optional
…7 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}
POST /v1/invoices/{invoice}/add_lines

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

operationId: PostInvoicesInvoiceAddLines

Parameters

Name In Required Type Description
invoice path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
lines array required
└ amount integer optional
└ period object optional
└ end integer required
└ start integer required
└ pricing object optional
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string optional
└ currency string required
└ unit_amount integer optional
└ product_data object optional
└ name string required
└ images array optional
└ metadata object optional
└ tax_code string optional
└ unit_label string optional
└ description string optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ description string optional
└ tax_amounts object optional
└ discountable boolean optional
└ invoice_item string optional
└ quantity_decimal string optional
expand array optional
invoice_metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/add_lines
POST /v1/invoices/{invoice}/attach_payment

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.

For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited to the invoice, increasing its amount_paid. When the invoice is fully paid, the invoice’s status becomes paid.

If the PaymentIntent’s status is already succeeded when it’s attached, it’s credited to the invoice immediately.

See: Partial payments to learn more.

operationId: PostInvoicesInvoiceAttachPayment

Parameters

Name In Required Type Description
invoice path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
payment_intent string optional
payment_record string optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/attach_payment
POST /v1/invoices/{invoice}/finalize

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

operationId: PostInvoicesInvoiceFinalize

Parameters

Name In Required Type Description
invoice path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
auto_advance boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/finalize
POST /v1/invoices/{invoice}/lines/{line_item_id}

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized.

operationId: PostInvoicesInvoiceLinesLineItemId

Parameters

Name In Required Type Description
invoice path required string

Invoice ID of line item
line_item_id path required string

Invoice line item ID

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
period object optional
└ end integer required
└ start integer required
pricing object optional
└ price string optional
metadata object optional
quantity integer optional
discounts object optional
tax_rates object optional
price_data object optional
└ product string optional
└ currency string required
└ unit_amount integer optional
└ product_data object optional
└ name string required
└ images array optional
└ metadata object optional
└ tax_code string optional
└ unit_label string optional
└ description string optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
description string optional
tax_amounts object optional
discountable boolean optional
quantity_decimal string optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/lines/{line_item_id}
POST /v1/invoices/{invoice}/mark_uncollectible

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

operationId: PostInvoicesInvoiceMarkUncollectible

Parameters

Name In Required Type Description
invoice 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/invoices/{invoice}/mark_uncollectible
POST /v1/invoices/{invoice}/pay

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

operationId: PostInvoicesInvoicePay

Parameters

Name In Required Type Description
invoice path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
source string optional
forgive boolean optional
mandate object optional
off_session boolean optional
payment_method string optional
paid_out_of_band boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/pay
POST /v1/invoices/{invoice}/remove_lines

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

operationId: PostInvoicesInvoiceRemoveLines

Parameters

Name In Required Type Description
invoice path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
lines array required
└ id string required
└ behavior string required
expand array optional
invoice_metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/remove_lines
POST /v1/invoices/{invoice}/send

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

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

operationId: PostInvoicesInvoiceSend

Parameters

Name In Required Type Description
invoice 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/invoices/{invoice}/send
POST /v1/invoices/{invoice}/update_lines

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

operationId: PostInvoicesInvoiceUpdateLines

Parameters

Name In Required Type Description
invoice path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
lines array required
└ id string required
└ amount integer optional
└ period object optional
└ end integer required
└ start integer required
└ pricing object optional
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string optional
└ currency string required
└ unit_amount integer optional
└ product_data object optional
└ name string required
└ images array optional
└ metadata object optional
└ tax_code string optional
└ unit_label string optional
└ description string optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ description string optional
└ tax_amounts object optional
└ discountable boolean optional
└ quantity_decimal string optional
expand array optional
invoice_metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/invoices/{invoice}/update_lines
POST /v1/invoices/{invoice}/void

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

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

operationId: PostInvoicesInvoiceVoid

Parameters

Name In Required Type Description
invoice 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/invoices/{invoice}/void

Issuing 13 endpoints

POST /v1/issuing/authorizations/{authorization}

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

operationId: PostIssuingAuthorizationsAuthorization

Parameters

Name In Required Type Description
authorization 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/issuing/authorizations/{authorization}
POST /v1/issuing/cardholders

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

operationId: PostIssuingCardholders

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name string required
type string optional
email string optional
expand array optional
status string optional
billing object required
└ address object required
└ city string required
└ line1 string required
└ line2 string optional
└ state string optional
└ country string required
└ postal_code string required
company object optional
└ tax_id string optional
metadata object optional
individual object optional
└ dob object optional
└ day integer required
└ year integer required
└ month integer required
└ last_name string optional
└ first_name string optional
└ card_issuing object optional
└ user_terms_acceptance object optional
└ ip string optional
└ date integer optional
└ user_agent object optional
└ verification object optional
└ document object optional
└ back string optional
└ front string optional
phone_number string optional
preferred_locales array optional
spending_controls object optional
└ spending_limits array optional
└ amount integer required
└ interval string required
└ categories array optional
└ allowed_categories array optional
└ blocked_categories array optional
└ allowed_card_presences array optional
└ blocked_card_presences array optional
└ spending_limits_currency string optional
└ allowed_merchant_countries array optional
└ blocked_merchant_countries array optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/cardholders
POST /v1/issuing/cardholders/{cardholder}

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

operationId: PostIssuingCardholdersCardholder

Parameters

Name In Required Type Description
cardholder path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
email string optional
expand array optional
status string optional
billing object optional
└ address object required
└ city string required
└ line1 string required
└ line2 string optional
└ state string optional
└ country string required
└ postal_code string required
company object optional
└ tax_id string optional
metadata object optional
individual object optional
└ dob object optional
└ day integer required
└ year integer required
└ month integer required
└ last_name string optional
└ first_name string optional
└ card_issuing object optional
└ user_terms_acceptance object optional
└ ip string optional
└ date integer optional
└ user_agent object optional
└ verification object optional
└ document object optional
└ back string optional
└ front string optional
phone_number string optional
preferred_locales array optional
spending_controls object optional
└ spending_limits array optional
└ amount integer required
└ interval string required
└ categories array optional
└ allowed_categories array optional
└ blocked_categories array optional
└ allowed_card_presences array optional
└ blocked_card_presences array optional
└ spending_limits_currency string optional
└ allowed_merchant_countries array optional
└ blocked_merchant_countries array optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/cardholders/{cardholder}
POST /v1/issuing/cards

Creates an Issuing Card object.

operationId: PostIssuingCards

Request Body

required
application/x-www-form-urlencoded
Property Type Required
pin object optional
└ encrypted_number string optional
type string required
expand array optional
status string optional
currency string required
exp_year integer optional
metadata object optional
shipping object optional
└ name string required
└ type string optional
└ address object required
└ city string required
└ line1 string required
└ line2 string optional
└ state string optional
└ country string required
└ postal_code string required
└ customs object optional
└ eori_number string optional
└ service string optional
└ phone_number string optional
└ require_signature boolean optional
└ address_validation object optional
└ mode string required
exp_month integer optional
cardholder string optional
second_line object optional
replacement_for string optional
financial_account string optional
spending_controls object optional
└ spending_limits array optional
└ amount integer required
└ interval string required
└ categories array optional
└ allowed_categories array optional
└ blocked_categories array optional
└ allowed_card_presences array optional
└ blocked_card_presences array optional
└ allowed_merchant_countries array optional
└ blocked_merchant_countries array optional
lifecycle_controls object optional
└ cancel_after object required
└ payment_count integer required
replacement_reason string optional
personalization_design string optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/cards
POST /v1/issuing/cards/{card}

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

operationId: PostIssuingCardsCard

Parameters

Name In Required Type Description
card path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
pin object optional
└ encrypted_number string optional
expand array optional
status string optional
metadata object optional
shipping object optional
└ name string required
└ type string optional
└ address object required
└ city string required
└ line1 string required
└ line2 string optional
└ state string optional
└ country string required
└ postal_code string required
└ customs object optional
└ eori_number string optional
└ service string optional
└ phone_number string optional
└ require_signature boolean optional
└ address_validation object optional
└ mode string required
spending_controls object optional
└ spending_limits array optional
└ amount integer required
└ interval string required
└ categories array optional
└ allowed_categories array optional
└ blocked_categories array optional
└ allowed_card_presences array optional
└ blocked_card_presences array optional
└ allowed_merchant_countries array optional
└ blocked_merchant_countries array optional
cancellation_reason string optional
personalization_design string optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/cards/{card}
POST /v1/issuing/disputes

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

operationId: PostIssuingDisputes

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
evidence object optional
└ other object optional
└ reason string optional
└ canceled object optional
└ duplicate object optional
└ fraudulent object optional
└ not_received object optional
└ no_valid_authorization object optional
└ service_not_as_described object optional
└ merchandise_not_as_described object optional
metadata object optional
treasury object optional
└ received_debit string required
transaction string optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/disputes
POST /v1/issuing/disputes/{dispute}

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

operationId: PostIssuingDisputesDispute

Parameters

Name In Required Type Description
dispute path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
evidence object optional
└ other object optional
└ reason string optional
└ canceled object optional
└ duplicate object optional
└ fraudulent object optional
└ not_received object optional
└ no_valid_authorization object optional
└ service_not_as_described object optional
└ merchandise_not_as_described object optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/disputes/{dispute}
POST /v1/issuing/disputes/{dispute}/submit

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

operationId: PostIssuingDisputesDisputeSubmit

Parameters

Name In Required Type Description
dispute 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/issuing/disputes/{dispute}/submit
POST /v1/issuing/personalization_designs

Creates a personalization design object.

operationId: PostIssuingPersonalizationDesigns

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name string optional
expand array optional
metadata object optional
card_logo string optional
lookup_key string optional
preferences object optional
└ is_default boolean required
carrier_text object optional
└ footer_body object optional
└ header_body object optional
└ footer_title object optional
└ header_title object optional
physical_bundle string required
transfer_lookup_key boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/personalization_designs
POST /v1/issuing/personalization_designs/{personalization_design}

Updates a card personalization object.

operationId: PostIssuingPersonalizationDesignsPersonalizationDesign

Parameters

Name In Required Type Description
personalization_design path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
name object optional
expand array optional
metadata object optional
card_logo object optional
lookup_key object optional
preferences object optional
└ is_default boolean required
carrier_text object optional
physical_bundle string optional
transfer_lookup_key boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/personalization_designs/{personalization_design}
POST /v1/issuing/settlements/{settlement}

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

operationId: PostIssuingSettlementsSettlement

Parameters

Name In Required Type Description
settlement 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/issuing/settlements/{settlement}
POST /v1/issuing/tokens/{token}

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

operationId: PostIssuingTokensToken

Parameters

Name In Required Type Description
token path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
status string required

Responses

default

Error response.
200

Successful response.
POST /v1/issuing/tokens/{token}
POST /v1/issuing/transactions/{transaction}

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

operationId: PostIssuingTransactionsTransaction

Parameters

Name In Required Type Description
transaction 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/issuing/transactions/{transaction}

Linkaccountsessions 1 endpoints

POST /v1/link_account_sessions

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

operationId: PostLinkAccountSessions

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
filters object optional
└ countries array optional
└ account_subcategories array optional
prefetch array optional
return_url string optional
permissions array required
account_holder object required
└ type string required
└ account string optional
└ customer string optional
└ customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/link_account_sessions

Linkedaccounts 2 endpoints

POST /v1/linked_accounts/{account}/disconnect

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

operationId: PostLinkedAccountsAccountDisconnect

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/linked_accounts/{account}/disconnect
POST /v1/linked_accounts/{account}/refresh

Refreshes the data associated with a Financial Connections Account.

operationId: PostLinkedAccountsAccountRefresh

Parameters

Name In Required Type Description
account path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
features array required

Responses

default

Error response.
200

Successful response.
POST /v1/linked_accounts/{account}/refresh

Paymentintents 8 endpoints

POST /v1/payment_intents

Creates a PaymentIntent object.

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

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

operationId: PostPaymentIntents

Request Body

required
application/x-www-form-urlencoded
Property Type Required
hooks object optional
└ inputs object optional
└ tax object optional
└ calculation object required
amount integer required
expand array optional
confirm boolean optional
mandate string optional
currency string required
customer string optional
metadata object optional
shipping object optional
└ name string required
└ phone string optional
└ address object required
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
└ carrier string optional
└ tracking_number string optional
return_url string optional
description string optional
off_session object optional
mandate_data object optional
on_behalf_of string optional
radar_options object optional
└ session string optional
receipt_email string optional
transfer_data object optional
└ amount integer optional
└ destination string required
amount_details object optional
└ tax object optional
└ shipping object optional
└ line_items object optional
└ discount_amount object optional
└ enforce_arithmetic_validation boolean optional
capture_method string optional
payment_method string optional
…17 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents
POST /v1/payment_intents/{intent}

Updates properties on a PaymentIntent object without confirming.

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

operationId: PostPaymentIntentsIntent

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
hooks object optional
└ inputs object optional
└ tax object optional
└ calculation object required
amount integer optional
expand array optional
currency string optional
customer string optional
metadata object optional
shipping object optional
description string optional
receipt_email object optional
transfer_data object optional
└ amount integer optional
amount_details object optional
capture_method string optional
payment_method string optional
transfer_group string optional
payment_details object optional
customer_account string optional
setup_future_usage string optional
payment_method_data object optional
└ eps object optional
└ bank string optional
└ fpx object optional
└ bank string required
└ p24 object optional
└ bank string optional
└ pix object optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ zip object optional
└ alma object optional
└ blik object optional
└ link object optional
└ oxxo object optional
└ type string required
└ ideal object optional
└ bank string optional
└ payco object optional
└ payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
└ swish object optional
└ twint object optional
└ affirm object optional
└ alipay object optional
└ billie object optional
└ boleto object optional
└ tax_id string required
└ …37 more object optional
payment_method_types array optional
statement_descriptor string optional
…5 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}
POST /v1/payment_intents/{intent}/apply_customer_balance

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

operationId: PostPaymentIntentsIntentApplyCustomerBalance

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
currency string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}/apply_customer_balance
POST /v1/payment_intents/{intent}/cancel

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can directly cancel the PaymentIntent for a Checkout Session only when the PaymentIntent has a status of requires_capture. Otherwise, you must expire the Checkout Session.

operationId: PostPaymentIntentsIntentCancel

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
cancellation_reason string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}/cancel
POST /v1/payment_intents/{intent}/capture

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

operationId: PostPaymentIntentsIntentCapture

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
hooks object optional
└ inputs object optional
└ tax object optional
└ calculation object required
expand array optional
metadata object optional
final_capture boolean optional
transfer_data object optional
└ amount integer optional
amount_details object optional
└ tax object optional
└ shipping object optional
└ line_items object optional
└ discount_amount object optional
└ enforce_arithmetic_validation boolean optional
payment_details object optional
amount_to_capture integer optional
statement_descriptor string optional
application_fee_amount integer optional
statement_descriptor_suffix string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}/capture
POST /v1/payment_intents/{intent}/confirm

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.

If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual).

If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment.

If the confirmation_method is manual, all payment attempts must be initiated using a secret key.

If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.

There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.

operationId: PostPaymentIntentsIntentConfirm

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
hooks object optional
└ inputs object optional
└ tax object optional
└ calculation object required
expand array optional
mandate string optional
shipping object optional
return_url string optional
off_session object optional
mandate_data object optional
client_secret string optional
radar_options object optional
└ session string optional
receipt_email object optional
amount_details object optional
capture_method string optional
payment_method string optional
use_stripe_sdk boolean optional
payment_details object optional
amount_to_confirm integer optional
confirmation_token string optional
setup_future_usage string optional
payment_method_data object optional
└ eps object optional
└ bank string optional
└ fpx object optional
└ bank string required
└ p24 object optional
└ bank string optional
└ pix object optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ zip object optional
└ alma object optional
└ blik object optional
└ link object optional
└ oxxo object optional
└ type string required
└ ideal object optional
└ bank string optional
└ payco object optional
└ payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
└ swish object optional
└ twint object optional
└ affirm object optional
└ alipay object optional
└ billie object optional
└ boleto object optional
└ tax_id string required
└ …37 more object optional
payment_method_types array optional
…3 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}/confirm
POST /v1/payment_intents/{intent}/increment_authorization

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

operationId: PostPaymentIntentsIntentIncrementAuthorization

Parameters

Name In Required Type Description
intent path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
hooks object optional
└ inputs object optional
└ tax object optional
└ calculation object required
amount integer required
expand array optional
metadata object optional
description string optional
transfer_data object optional
└ amount integer optional
amount_details object optional
└ tax object optional
└ shipping object optional
└ line_items object optional
└ discount_amount object optional
└ enforce_arithmetic_validation boolean optional
payment_details object optional
└ order_reference object optional
└ customer_reference object optional
statement_descriptor string optional
application_fee_amount integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}/increment_authorization
POST /v1/payment_intents/{intent}/verify_microdeposits

Verifies microdeposits on a PaymentIntent object.

operationId: PostPaymentIntentsIntentVerifyMicrodeposits

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
amounts array optional
client_secret string optional
descriptor_code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_intents/{intent}/verify_microdeposits

Paymentmethodconfigurations 2 endpoints

POST /v1/payment_method_configurations

Creates a payment method configuration

operationId: PostPaymentMethodConfigurations

Request Body

application/x-www-form-urlencoded
Property Type Required
eps object optional
└ display_preference object optional
└ preference string optional
fpx object optional
└ display_preference object optional
└ preference string optional
jcb object optional
└ display_preference object optional
└ preference string optional
p24 object optional
└ display_preference object optional
└ preference string optional
pix object optional
└ display_preference object optional
└ preference string optional
upi object optional
└ display_preference object optional
└ preference string optional
zip object optional
└ display_preference object optional
└ preference string optional
alma object optional
└ display_preference object optional
└ preference string optional
blik object optional
└ display_preference object optional
└ preference string optional
card object optional
└ display_preference object optional
└ preference string optional
link object optional
└ display_preference object optional
└ preference string optional
name string optional
oxxo object optional
└ display_preference object optional
└ preference string optional
ideal object optional
└ display_preference object optional
└ preference string optional
payco object optional
└ display_preference object optional
└ preference string optional
payto object optional
└ display_preference object optional
└ preference string optional
swish object optional
└ display_preference object optional
└ preference string optional
twint object optional
└ display_preference object optional
└ preference string optional
affirm object optional
└ display_preference object optional
└ preference string optional
alipay object optional
└ display_preference object optional
└ preference string optional
…41 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_method_configurations
POST /v1/payment_method_configurations/{configuration}

Update payment method configuration

operationId: PostPaymentMethodConfigurationsConfiguration

Parameters

Name In Required Type Description
configuration path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
eps object optional
└ display_preference object optional
└ preference string optional
fpx object optional
└ display_preference object optional
└ preference string optional
jcb object optional
└ display_preference object optional
└ preference string optional
p24 object optional
└ display_preference object optional
└ preference string optional
pix object optional
└ display_preference object optional
└ preference string optional
upi object optional
└ display_preference object optional
└ preference string optional
zip object optional
└ display_preference object optional
└ preference string optional
alma object optional
└ display_preference object optional
└ preference string optional
blik object optional
└ display_preference object optional
└ preference string optional
card object optional
└ display_preference object optional
└ preference string optional
link object optional
└ display_preference object optional
└ preference string optional
name string optional
oxxo object optional
└ display_preference object optional
└ preference string optional
ideal object optional
└ display_preference object optional
└ preference string optional
payco object optional
└ display_preference object optional
└ preference string optional
payto object optional
└ display_preference object optional
└ preference string optional
swish object optional
└ display_preference object optional
└ preference string optional
twint object optional
└ display_preference object optional
└ preference string optional
active boolean optional
affirm object optional
└ display_preference object optional
└ preference string optional
…41 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_method_configurations/{configuration}

Paymentmethoddomains 3 endpoints

POST /v1/payment_method_domains

Creates a payment method domain.

operationId: PostPaymentMethodDomains

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
enabled boolean optional
domain_name string required

Responses

default

Error response.
200

Successful response.
POST /v1/payment_method_domains
POST /v1/payment_method_domains/{payment_method_domain}

Updates an existing payment method domain.

operationId: PostPaymentMethodDomainsPaymentMethodDomain

Parameters

Name In Required Type Description
payment_method_domain path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
enabled boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_method_domains/{payment_method_domain}
POST /v1/payment_method_domains/{payment_method_domain}/validate

Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate

Parameters

Name In Required Type Description
payment_method_domain 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/payment_method_domains/{payment_method_domain}/validate

Paymentmethods 4 endpoints

POST /v1/payment_methods

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

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

operationId: PostPaymentMethods

Request Body

application/x-www-form-urlencoded
Property Type Required
eps object optional
└ bank string optional
fpx object optional
└ bank string required
p24 object optional
└ bank string optional
pix object optional
upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
zip object optional
alma object optional
blik object optional
card object optional
link object optional
oxxo object optional
type string optional
ideal object optional
└ bank string optional
payco object optional
payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
swish object optional
twint object optional
affirm object optional
alipay object optional
billie object optional
…42 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_methods
POST /v1/payment_methods/{payment_method}

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

operationId: PostPaymentMethodsPaymentMethod

Parameters

Name In Required Type Description
payment_method path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
card object optional
└ exp_year integer optional
└ networks object optional
└ preferred string optional
└ exp_month integer optional
payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
expand array optional
metadata object optional
allow_redisplay string optional
billing_details object optional
└ name object optional
└ email object optional
└ phone object optional
└ tax_id string optional
└ address object optional
us_bank_account object optional
└ account_type string optional
└ account_holder_type string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_methods/{payment_method}
POST /v1/payment_methods/{payment_method}/attach

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

operationId: PostPaymentMethodsPaymentMethodAttach

Parameters

Name In Required Type Description
payment_method path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
customer string optional
customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_methods/{payment_method}/attach
POST /v1/payment_methods/{payment_method}/detach

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

operationId: PostPaymentMethodsPaymentMethodDetach

Parameters

Name In Required Type Description
payment_method 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/payment_methods/{payment_method}/detach

Paymentrecords 7 endpoints

POST /v1/payment_records/report_payment

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

operationId: PostPaymentRecordsReportPayment

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
failed object optional
└ failed_at integer required
outcome string optional
metadata object optional
guaranteed object optional
└ guaranteed_at integer required
description string optional
initiated_at integer required
amount_requested object required
└ value integer required
└ currency string required
customer_details object optional
└ name string optional
└ email string optional
└ phone string optional
└ customer string optional
shipping_details object optional
└ name string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
customer_presence string optional
processor_details object optional
└ type string required
└ custom object optional
└ payment_reference string required
payment_method_details object required
└ type string optional
└ custom object optional
└ type string optional
└ display_name string optional
└ payment_method string optional
└ billing_details object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/report_payment
POST /v1/payment_records/{id}/report_payment_attempt

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

operationId: PostPaymentRecordsIdReportPaymentAttempt

Parameters

Name In Required Type Description
id path required string

The ID of the Payment Record.

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
failed object optional
└ failed_at integer required
outcome string optional
metadata object optional
guaranteed object optional
└ guaranteed_at integer required
description string optional
initiated_at integer required
shipping_details object optional
└ name string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
payment_method_details object optional
└ type string optional
└ custom object optional
└ type string optional
└ display_name string optional
└ payment_method string optional
└ billing_details object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/{id}/report_payment_attempt
POST /v1/payment_records/{id}/report_payment_attempt_canceled

Report that the most recent payment attempt on the specified Payment Record was canceled.

operationId: PostPaymentRecordsIdReportPaymentAttemptCanceled

Parameters

Name In Required Type Description
id path required string

The ID of the Payment Record.

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
canceled_at integer required

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/{id}/report_payment_attempt_canceled
POST /v1/payment_records/{id}/report_payment_attempt_failed

Report that the most recent payment attempt on the specified Payment Record failed or errored.

operationId: PostPaymentRecordsIdReportPaymentAttemptFailed

Parameters

Name In Required Type Description
id path required string

The ID of the Payment Record.

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
failed_at integer required

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/{id}/report_payment_attempt_failed
POST /v1/payment_records/{id}/report_payment_attempt_guaranteed

Report that the most recent payment attempt on the specified Payment Record was guaranteed.

operationId: PostPaymentRecordsIdReportPaymentAttemptGuaranteed

Parameters

Name In Required Type Description
id path required string

The ID of the Payment Record.

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
guaranteed_at integer required

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/{id}/report_payment_attempt_guaranteed
POST /v1/payment_records/{id}/report_payment_attempt_informational

Report informational updates on the specified Payment Record.

operationId: PostPaymentRecordsIdReportPaymentAttemptInformational

Parameters

Name In Required Type Description
id path required string

The ID of the Payment Record.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
description object optional
customer_details object optional
└ name string optional
└ email string optional
└ phone string optional
└ customer string optional
shipping_details object optional

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/{id}/report_payment_attempt_informational
POST /v1/payment_records/{id}/report_refund

Report that the most recent payment attempt on the specified Payment Record was refunded.

operationId: PostPaymentRecordsIdReportRefund

Parameters

Name In Required Type Description
id path required string

The ID of the Payment Record.

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount object optional
└ value integer required
└ currency string required
expand array optional
outcome string required
metadata object optional
refunded object required
└ refunded_at integer required
initiated_at integer optional
processor_details object required
└ type string required
└ custom object optional
└ refund_reference string required

Responses

default

Error response.
200

Successful response.
POST /v1/payment_records/{id}/report_refund

Payouts 4 endpoints

POST /v1/payouts

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

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

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

operationId: PostPayouts

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
method string optional
currency string required
metadata object optional
description string optional
destination string optional
source_type string optional
payout_method string optional
statement_descriptor string optional

Responses

default

Error response.
200

Successful response.
POST /v1/payouts
POST /v1/payouts/{payout}

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

operationId: PostPayoutsPayout

Parameters

Name In Required Type Description
payout 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/payouts/{payout}
POST /v1/payouts/{payout}/cancel

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

operationId: PostPayoutsPayoutCancel

Parameters

Name In Required Type Description
payout 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/payouts/{payout}/cancel
POST /v1/payouts/{payout}/reverse

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

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

operationId: PostPayoutsPayoutReverse

Parameters

Name In Required Type Description
payout 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/payouts/{payout}/reverse

Plans 2 endpoints

POST /v1/plans

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

operationId: PostPlans

Request Body

required
application/x-www-form-urlencoded
Property Type Required
id string optional
meter string optional
tiers array optional
└ up_to object required
└ flat_amount integer optional
└ unit_amount integer optional
└ flat_amount_decimal string optional
└ unit_amount_decimal string optional
active boolean optional
amount integer optional
expand array optional
product object optional
currency string required
interval string required
metadata object optional
nickname string optional
tiers_mode string optional
usage_type string optional
amount_decimal string optional
billing_scheme string optional
interval_count integer optional
transform_usage object optional
└ round string required
└ divide_by integer required
trial_period_days integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/plans
POST /v1/plans/{plan}

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

operationId: PostPlansPlan

Parameters

Name In Required Type Description
plan path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
active boolean optional
expand array optional
product string optional
metadata object optional
nickname string optional
trial_period_days integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/plans/{plan}

Prices 2 endpoints

POST /v1/prices

Creates a new Price for an existing Product. The Price can be recurring or one-time.

operationId: PostPrices

Request Body

required
application/x-www-form-urlencoded
Property Type Required
tiers array optional
└ up_to object required
└ flat_amount integer optional
└ unit_amount integer optional
└ flat_amount_decimal string optional
└ unit_amount_decimal string optional
active boolean optional
expand array optional
product string optional
currency string required
metadata object optional
nickname string optional
recurring object optional
└ meter string optional
└ interval string required
└ usage_type string optional
└ interval_count integer optional
lookup_key string optional
tiers_mode string optional
unit_amount integer optional
product_data object optional
└ id string optional
└ name string required
└ active boolean optional
└ metadata object optional
└ tax_code string optional
└ unit_label string optional
└ statement_descriptor string optional
tax_behavior string optional
billing_scheme string optional
currency_options object optional
custom_unit_amount object optional
└ preset integer optional
└ enabled boolean required
└ maximum integer optional
└ minimum integer optional
transform_quantity object optional
└ round string required
└ divide_by integer required
transfer_lookup_key boolean optional
unit_amount_decimal string optional

Responses

default

Error response.
200

Successful response.
POST /v1/prices
POST /v1/prices/{price}

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

operationId: PostPricesPrice

Parameters

Name In Required Type Description
price path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
active boolean optional
expand array optional
metadata object optional
nickname string optional
lookup_key string optional
tax_behavior string optional
currency_options object optional
transfer_lookup_key boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/prices/{price}

Products 3 endpoints

POST /v1/products

Creates a new product object.

operationId: PostProducts

Request Body

required
application/x-www-form-urlencoded
Property Type Required
id string optional
url string optional
name string required
active boolean optional
expand array optional
images array optional
metadata object optional
tax_code string optional
shippable boolean optional
unit_label string optional
description string optional
default_price_data object optional
└ currency string required
└ metadata object optional
└ recurring object optional
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ currency_options object optional
└ custom_unit_amount object optional
└ preset integer optional
└ enabled boolean required
└ maximum integer optional
└ minimum integer optional
└ unit_amount_decimal string optional
marketing_features array optional
└ name string required
package_dimensions object optional
└ width number required
└ height number required
└ length number required
└ weight number required
statement_descriptor string optional

Responses

default

Error response.
200

Successful response.
POST /v1/products
POST /v1/products/{id}

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

operationId: PostProductsId

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
url object optional
name string optional
active boolean optional
expand array optional
images object optional
metadata object optional
tax_code object optional
shippable boolean optional
unit_label object optional
description object optional
default_price string optional
marketing_features object optional
package_dimensions object optional
statement_descriptor string optional

Responses

default

Error response.
200

Successful response.
POST /v1/products/{id}
POST /v1/products/{product}/features

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

operationId: PostProductsProductFeatures

Parameters

Name In Required Type Description
product path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
entitlement_feature string required

Responses

default

Error response.
200

Successful response.
POST /v1/products/{product}/features

Promotioncodes 2 endpoints

POST /v1/promotion_codes

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

operationId: PostPromotionCodes

Request Body

required
application/x-www-form-urlencoded
Property Type Required
code string optional
active boolean optional
expand array optional
customer string optional
metadata object optional
promotion object required
└ type string required
└ coupon string optional
expires_at integer optional
restrictions object optional
└ minimum_amount integer optional
└ currency_options object optional
└ first_time_transaction boolean optional
└ minimum_amount_currency string optional
max_redemptions integer optional
customer_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/promotion_codes
POST /v1/promotion_codes/{promotion_code}

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

operationId: PostPromotionCodesPromotionCode

Parameters

Name In Required Type Description
promotion_code path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
active boolean optional
expand array optional
metadata object optional
restrictions object optional
└ currency_options object optional

Responses

default

Error response.
200

Successful response.
POST /v1/promotion_codes/{promotion_code}

Quotes 5 endpoints

POST /v1/quotes

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

operationId: PostQuotes

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
footer object optional
header object optional
customer string optional
metadata object optional
discounts object optional
expires_at integer optional
from_quote object optional
└ quote string required
└ is_revision boolean optional
line_items array optional
└ price string optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object optional
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
test_clock string optional
description object optional
on_behalf_of object optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
transfer_data object optional
customer_account string optional
invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ days_until_due integer optional
collection_method string optional
default_tax_rates object optional
subscription_data object optional
└ metadata object optional
└ description string optional
└ billing_mode object optional
└ type string required
└ flexible object optional
└ proration_discounts string optional
└ effective_date object optional
└ trial_period_days object optional
application_fee_amount object optional
…1 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/quotes
POST /v1/quotes/{quote}

A quote models prices and services for a customer.

operationId: PostQuotesQuote

Parameters

Name In Required Type Description
quote path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
footer object optional
header object optional
customer string optional
metadata object optional
discounts object optional
expires_at integer optional
line_items array optional
└ id string optional
└ price string optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object optional
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
description object optional
on_behalf_of object optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
transfer_data object optional
customer_account string optional
invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ days_until_due integer optional
collection_method string optional
default_tax_rates object optional
subscription_data object optional
└ metadata object optional
└ description object optional
└ effective_date object optional
└ trial_period_days object optional
application_fee_amount object optional
application_fee_percent object optional

Responses

default

Error response.
200

Successful response.
POST /v1/quotes/{quote}
POST /v1/quotes/{quote}/accept

Accepts the specified quote.

operationId: PostQuotesQuoteAccept

Parameters

Name In Required Type Description
quote 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/quotes/{quote}/accept
POST /v1/quotes/{quote}/cancel

Cancels the quote.

operationId: PostQuotesQuoteCancel

Parameters

Name In Required Type Description
quote 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/quotes/{quote}/cancel
POST /v1/quotes/{quote}/finalize

Finalizes the quote.

operationId: PostQuotesQuoteFinalize

Parameters

Name In Required Type Description
quote path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
expires_at integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/quotes/{quote}/finalize

Radar 4 endpoints

POST /v1/radar/payment_evaluations

Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.

operationId: PostRadarPaymentEvaluations

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
payment_details object required
└ amount integer required
└ currency string required
└ description string optional
└ shipping_details object optional
└ name string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
└ statement_descriptor string optional
└ money_movement_details object optional
└ card object optional
└ payment_type string optional
└ customer_presence string optional
└ money_movement_type string required
└ payment_method_details object required
└ payment_method string required
└ billing_details object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
customer_details object required
└ name string optional
└ email string optional
└ phone string optional
└ customer string optional
└ customer_account string optional
client_device_metadata_details object optional
└ radar_session string required

Responses

default

Error response.
200

Successful response.
POST /v1/radar/payment_evaluations
POST /v1/radar/value_list_items

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

operationId: PostRadarValueListItems

Request Body

required
application/x-www-form-urlencoded
Property Type Required
value string required
expand array optional
value_list string required

Responses

default

Error response.
200

Successful response.
POST /v1/radar/value_list_items
POST /v1/radar/value_lists

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

operationId: PostRadarValueLists

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name string required
alias string required
expand array optional
metadata object optional
item_type string optional

Responses

default

Error response.
200

Successful response.
POST /v1/radar/value_lists
POST /v1/radar/value_lists/{value_list}

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

operationId: PostRadarValueListsValueList

Parameters

Name In Required Type Description
value_list path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
alias string optional
expand array optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/radar/value_lists/{value_list}

Refunds 3 endpoints

POST /v1/refunds

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

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

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

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

operationId: PostRefunds

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
charge string optional
expand array optional
origin string optional
reason string optional
currency string optional
customer string optional
metadata object optional
payment_intent string optional
reverse_transfer boolean optional
instructions_email string optional
refund_application_fee boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/refunds
POST /v1/refunds/{refund}

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

This request only accepts metadata as an argument.

operationId: PostRefundsRefund

Parameters

Name In Required Type Description
refund 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/refunds/{refund}
POST /v1/refunds/{refund}/cancel

Cancels a refund with a status of requires_action.

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

operationId: PostRefundsRefundCancel

Parameters

Name In Required Type Description
refund 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/refunds/{refund}/cancel

Reporting 1 endpoints

POST /v1/reporting/report_runs

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

operationId: PostReportingReportRuns

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
parameters object optional
└ payout string optional
└ columns array optional
└ currency string optional
└ timezone string optional
└ interval_end integer optional
└ interval_start integer optional
└ connected_account string optional
└ reporting_category string optional
report_type string required

Responses

default

Error response.
200

Successful response.
POST /v1/reporting/report_runs

Reviews 1 endpoints

POST /v1/reviews/{review}/approve

Approves a Review object, closing it and removing it from the list of reviews.

operationId: PostReviewsReviewApprove

Parameters

Name In Required Type Description
review 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/reviews/{review}/approve

Setupintents 5 endpoints

POST /v1/setup_intents

Creates a SetupIntent object.

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

operationId: PostSetupIntents

Request Body

application/x-www-form-urlencoded
Property Type Required
usage string optional
expand array optional
confirm boolean optional
customer string optional
metadata object optional
return_url string optional
single_use object optional
└ amount integer required
└ currency string required
description string optional
mandate_data object optional
on_behalf_of string optional
attach_to_self boolean optional
payment_method string optional
use_stripe_sdk boolean optional
flow_directions array optional
customer_account string optional
confirmation_token string optional
payment_method_data object optional
└ eps object optional
└ bank string optional
└ fpx object optional
└ bank string required
└ p24 object optional
└ bank string optional
└ pix object optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ zip object optional
└ alma object optional
└ blik object optional
└ link object optional
└ oxxo object optional
└ type string required
└ ideal object optional
└ bank string optional
└ payco object optional
└ payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
└ swish object optional
└ twint object optional
└ affirm object optional
└ alipay object optional
└ billie object optional
└ boleto object optional
└ tax_id string required
└ …37 more object optional
payment_method_types array optional
payment_method_options object optional
└ pix object optional
└ mandate_options object optional
└ amount integer optional
└ currency string optional
└ end_date string optional
└ reference string optional
└ start_date string optional
└ amount_type string optional
└ payment_schedule string optional
└ amount_includes_iof string optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ setup_future_usage string optional
└ card object optional
└ network string optional
└ three_d_secure object optional
└ version string optional
└ cryptogram string optional
└ transaction_id string optional
└ network_options object optional
└ ares_trans_status string optional
└ electronic_commerce_indicator string optional
└ requestor_challenge_indicator string optional
└ mandate_options object optional
└ amount integer required
└ currency string required
└ end_date integer optional
└ interval string required
└ reference string required
└ start_date integer required
└ amount_type string required
└ description string optional
└ interval_count integer optional
└ supported_types array optional
└ request_three_d_secure string optional
└ link object optional
└ payto object optional
└ mandate_options object optional
└ amount object optional
└ purpose string optional
└ end_date object optional
└ start_date object optional
└ amount_type string optional
└ payment_schedule string optional
└ payments_per_period object optional
└ klarna object optional
└ currency string optional
└ on_demand object optional
└ average_amount integer optional
└ maximum_amount integer optional
└ minimum_amount integer optional
└ purchase_interval string optional
└ purchase_interval_count integer optional
└ subscriptions object optional
└ preferred_locale string optional
└ paypal object optional
└ billing_agreement_id string optional
└ acss_debit object optional
└ currency string optional
└ mandate_options object optional
└ default_for array optional
└ payment_schedule string optional
└ transaction_type string optional
└ custom_mandate_url object optional
└ interval_description string optional
└ verification_method string optional
└ amazon_pay object optional
└ bacs_debit object optional
└ mandate_options object optional
└ reference_prefix object optional
└ sepa_debit object optional
└ mandate_options object optional
└ reference_prefix object optional
└ card_present object optional
└ us_bank_account object optional
└ networks object optional
└ requested array optional
└ mandate_options object optional
└ collection_method string optional
└ verification_method string optional
└ financial_connections object optional
└ filters object optional
└ prefetch array optional
└ return_url string optional
└ permissions array optional
automatic_payment_methods object optional
└ enabled boolean required
└ allow_redirects string optional
…2 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/setup_intents
POST /v1/setup_intents/{intent}

Updates a SetupIntent object.

operationId: PostSetupIntentsIntent

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
customer string optional
metadata object optional
description string optional
attach_to_self boolean optional
payment_method string optional
flow_directions array optional
customer_account string optional
payment_method_data object optional
└ eps object optional
└ bank string optional
└ fpx object optional
└ bank string required
└ p24 object optional
└ bank string optional
└ pix object optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ zip object optional
└ alma object optional
└ blik object optional
└ link object optional
└ oxxo object optional
└ type string required
└ ideal object optional
└ bank string optional
└ payco object optional
└ payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
└ swish object optional
└ twint object optional
└ affirm object optional
└ alipay object optional
└ billie object optional
└ boleto object optional
└ tax_id string required
└ …37 more object optional
payment_method_types array optional
payment_method_options object optional
└ pix object optional
└ mandate_options object optional
└ amount integer optional
└ currency string optional
└ end_date string optional
└ reference string optional
└ start_date string optional
└ amount_type string optional
└ payment_schedule string optional
└ amount_includes_iof string optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ setup_future_usage string optional
└ card object optional
└ network string optional
└ three_d_secure object optional
└ version string optional
└ cryptogram string optional
└ transaction_id string optional
└ network_options object optional
└ ares_trans_status string optional
└ electronic_commerce_indicator string optional
└ requestor_challenge_indicator string optional
└ mandate_options object optional
└ amount integer required
└ currency string required
└ end_date integer optional
└ interval string required
└ reference string required
└ start_date integer required
└ amount_type string required
└ description string optional
└ interval_count integer optional
└ supported_types array optional
└ request_three_d_secure string optional
└ link object optional
└ payto object optional
└ mandate_options object optional
└ amount object optional
└ purpose string optional
└ end_date object optional
└ start_date object optional
└ amount_type string optional
└ payment_schedule string optional
└ payments_per_period object optional
└ klarna object optional
└ currency string optional
└ on_demand object optional
└ average_amount integer optional
└ maximum_amount integer optional
└ minimum_amount integer optional
└ purchase_interval string optional
└ purchase_interval_count integer optional
└ subscriptions object optional
└ preferred_locale string optional
└ paypal object optional
└ billing_agreement_id string optional
└ acss_debit object optional
└ currency string optional
└ mandate_options object optional
└ default_for array optional
└ payment_schedule string optional
└ transaction_type string optional
└ custom_mandate_url object optional
└ interval_description string optional
└ verification_method string optional
└ amazon_pay object optional
└ bacs_debit object optional
└ mandate_options object optional
└ reference_prefix object optional
└ sepa_debit object optional
└ mandate_options object optional
└ reference_prefix object optional
└ card_present object optional
└ us_bank_account object optional
└ networks object optional
└ requested array optional
└ mandate_options object optional
└ collection_method string optional
└ verification_method string optional
└ financial_connections object optional
└ filters object optional
└ prefetch array optional
└ return_url string optional
└ permissions array optional
payment_method_configuration string optional
excluded_payment_method_types object optional

Responses

default

Error response.
200

Successful response.
POST /v1/setup_intents/{intent}
POST /v1/setup_intents/{intent}/cancel

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

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

operationId: PostSetupIntentsIntentCancel

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
cancellation_reason string optional

Responses

default

Error response.
200

Successful response.
POST /v1/setup_intents/{intent}/cancel
POST /v1/setup_intents/{intent}/confirm

Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

operationId: PostSetupIntentsIntentConfirm

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
return_url string optional
mandate_data object optional
client_secret string optional
payment_method string optional
use_stripe_sdk boolean optional
confirmation_token string optional
payment_method_data object optional
└ eps object optional
└ bank string optional
└ fpx object optional
└ bank string required
└ p24 object optional
└ bank string optional
└ pix object optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ zip object optional
└ alma object optional
└ blik object optional
└ link object optional
└ oxxo object optional
└ type string required
└ ideal object optional
└ bank string optional
└ payco object optional
└ payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
└ swish object optional
└ twint object optional
└ affirm object optional
└ alipay object optional
└ billie object optional
└ boleto object optional
└ tax_id string required
└ …37 more object optional
payment_method_options object optional
└ pix object optional
└ mandate_options object optional
└ amount integer optional
└ currency string optional
└ end_date string optional
└ reference string optional
└ start_date string optional
└ amount_type string optional
└ payment_schedule string optional
└ amount_includes_iof string optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ setup_future_usage string optional
└ card object optional
└ network string optional
└ three_d_secure object optional
└ version string optional
└ cryptogram string optional
└ transaction_id string optional
└ network_options object optional
└ ares_trans_status string optional
└ electronic_commerce_indicator string optional
└ requestor_challenge_indicator string optional
└ mandate_options object optional
└ amount integer required
└ currency string required
└ end_date integer optional
└ interval string required
└ reference string required
└ start_date integer required
└ amount_type string required
└ description string optional
└ interval_count integer optional
└ supported_types array optional
└ request_three_d_secure string optional
└ link object optional
└ payto object optional
└ mandate_options object optional
└ amount object optional
└ purpose string optional
└ end_date object optional
└ start_date object optional
└ amount_type string optional
└ payment_schedule string optional
└ payments_per_period object optional
└ klarna object optional
└ currency string optional
└ on_demand object optional
└ average_amount integer optional
└ maximum_amount integer optional
└ minimum_amount integer optional
└ purchase_interval string optional
└ purchase_interval_count integer optional
└ subscriptions object optional
└ preferred_locale string optional
└ paypal object optional
└ billing_agreement_id string optional
└ acss_debit object optional
└ currency string optional
└ mandate_options object optional
└ default_for array optional
└ payment_schedule string optional
└ transaction_type string optional
└ custom_mandate_url object optional
└ interval_description string optional
└ verification_method string optional
└ amazon_pay object optional
└ bacs_debit object optional
└ mandate_options object optional
└ reference_prefix object optional
└ sepa_debit object optional
└ mandate_options object optional
└ reference_prefix object optional
└ card_present object optional
└ us_bank_account object optional
└ networks object optional
└ requested array optional
└ mandate_options object optional
└ collection_method string optional
└ verification_method string optional
└ financial_connections object optional
└ filters object optional
└ prefetch array optional
└ return_url string optional
└ permissions array optional

Responses

default

Error response.
200

Successful response.
POST /v1/setup_intents/{intent}/confirm
POST /v1/setup_intents/{intent}/verify_microdeposits

Verifies microdeposits on a SetupIntent object.

operationId: PostSetupIntentsIntentVerifyMicrodeposits

Parameters

Name In Required Type Description
intent path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
amounts array optional
client_secret string optional
descriptor_code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/setup_intents/{intent}/verify_microdeposits

Shippingrates 2 endpoints

POST /v1/shipping_rates

Creates a new shipping rate object.

operationId: PostShippingRates

Request Body

required
application/x-www-form-urlencoded
Property Type Required
type string optional
expand array optional
metadata object optional
tax_code string optional
display_name string required
fixed_amount object optional
└ amount integer required
└ currency string required
└ currency_options object optional
tax_behavior string optional
delivery_estimate object optional
└ maximum object optional
└ unit string required
└ value integer required
└ minimum object optional
└ unit string required
└ value integer required

Responses

default

Error response.
200

Successful response.
POST /v1/shipping_rates
POST /v1/shipping_rates/{shipping_rate_token}

Updates an existing shipping rate object.

operationId: PostShippingRatesShippingRateToken

Parameters

Name In Required Type Description
shipping_rate_token path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
active boolean optional
expand array optional
metadata object optional
fixed_amount object optional
└ currency_options object optional
tax_behavior string optional

Responses

default

Error response.
200

Successful response.
POST /v1/shipping_rates/{shipping_rate_token}

Sigma 1 endpoints

POST /v1/sigma/saved_queries/{id}

Update an existing Sigma query that previously exists

operationId: PostSigmaSavedQueriesId

Parameters

Name In Required Type Description
id path required string

The id of the saved query to update. This should be a valid id that was previously created.

Request Body

application/x-www-form-urlencoded
Property Type Required
sql string optional
name string optional
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/sigma/saved_queries/{id}

Sources 3 endpoints

POST /v1/sources

Creates a new source object.

operationId: PostSources

Request Body

application/x-www-form-urlencoded
Property Type Required
flow string optional
type string optional
owner object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
token string optional
usage string optional
amount integer optional
expand array optional
mandate object optional
└ amount object optional
└ currency string optional
└ interval string optional
└ acceptance object optional
└ ip string optional
└ date integer optional
└ type string optional
└ online object optional
└ ip string optional
└ date integer optional
└ user_agent string optional
└ status string required
└ offline object optional
└ contact_email string required
└ user_agent string optional
└ notification_method string optional
currency string optional
customer string optional
metadata object optional
receiver object optional
└ refund_attributes_method string optional
redirect object optional
└ return_url string required
source_order object optional
└ items array optional
└ type string optional
└ amount integer optional
└ parent string optional
└ currency string optional
└ quantity integer optional
└ description string optional
└ shipping object optional
└ name string optional
└ phone string optional
└ address object required
└ city string optional
└ line1 string required
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
└ carrier string optional
└ tracking_number string optional
original_source string optional
statement_descriptor string optional

Responses

default

Error response.
200

Successful response.
POST /v1/sources
POST /v1/sources/{source}

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

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

operationId: PostSourcesSource

Parameters

Name In Required Type Description
source path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
owner object optional
└ name string optional
└ email string optional
└ phone string optional
└ address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
amount integer optional
expand array optional
mandate object optional
└ amount object optional
└ currency string optional
└ interval string optional
└ acceptance object optional
└ ip string optional
└ date integer optional
└ type string optional
└ online object optional
└ ip string optional
└ date integer optional
└ user_agent string optional
└ status string required
└ offline object optional
└ contact_email string required
└ user_agent string optional
└ notification_method string optional
metadata object optional
source_order object optional
└ items array optional
└ type string optional
└ amount integer optional
└ parent string optional
└ currency string optional
└ quantity integer optional
└ description string optional
└ shipping object optional
└ name string optional
└ phone string optional
└ address object required
└ city string optional
└ line1 string required
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
└ carrier string optional
└ tracking_number string optional

Responses

default

Error response.
200

Successful response.
POST /v1/sources/{source}
POST /v1/sources/{source}/verify

Verify a given source.

operationId: PostSourcesSourceVerify

Parameters

Name In Required Type Description
source path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
values array required

Responses

default

Error response.
200

Successful response.
POST /v1/sources/{source}/verify

Subscriptionitems 2 endpoints

POST /v1/subscription_items

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

operationId: PostSubscriptionItems

Request Body

required
application/x-www-form-urlencoded
Property Type Required
price string optional
expand array optional
metadata object optional
quantity integer optional
discounts object optional
tax_rates object optional
price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
subscription string required
proration_date integer optional
payment_behavior string optional
billing_thresholds object optional
proration_behavior string optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscription_items
POST /v1/subscription_items/{item}

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

operationId: PostSubscriptionItemsItem

Parameters

Name In Required Type Description
item path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
price string optional
expand array optional
metadata object optional
quantity integer optional
discounts object optional
tax_rates object optional
price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
off_session boolean optional
proration_date integer optional
payment_behavior string optional
billing_thresholds object optional
proration_behavior string optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscription_items/{item}

Subscriptionschedules 4 endpoints

POST /v1/subscription_schedules

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

operationId: PostSubscriptionSchedules

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
phases array optional
└ items array required
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ billing_thresholds object optional
└ trial boolean optional
└ currency string optional
└ duration object optional
└ interval string required
└ interval_count integer optional
└ end_date integer optional
└ metadata object optional
└ discounts object optional
└ trial_end integer optional
└ description object optional
└ on_behalf_of string optional
└ automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
└ transfer_data object optional
└ destination string required
└ amount_percent number optional
└ invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ days_until_due integer optional
└ account_tax_ids object optional
└ add_invoice_items array optional
└ price string optional
└ period object optional
└ end object required
└ start object required
└ metadata object optional
└ quantity integer optional
└ discounts array optional
└ coupon string optional
└ discount string optional
└ promotion_code string optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ collection_method string optional
└ default_tax_rates object optional
└ billing_thresholds object optional
└ proration_behavior string optional
└ billing_cycle_anchor string optional
└ default_payment_method string optional
└ …1 more object optional
customer string optional
metadata object optional
start_date object optional
billing_mode object optional
└ type string required
└ flexible object optional
└ proration_discounts string optional
end_behavior string optional
customer_account string optional
default_settings object optional
└ description object optional
└ on_behalf_of object optional
└ automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
└ transfer_data object optional
└ invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ days_until_due integer optional
└ account_tax_ids object optional
└ collection_method string optional
└ billing_thresholds object optional
└ billing_cycle_anchor string optional
└ default_payment_method string optional
└ application_fee_percent number optional
from_subscription string optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscription_schedules
POST /v1/subscription_schedules/{schedule}

Updates an existing subscription schedule.

operationId: PostSubscriptionSchedulesSchedule

Parameters

Name In Required Type Description
schedule path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
phases array optional
└ items array required
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ billing_thresholds object optional
└ trial boolean optional
└ duration object optional
└ interval string required
└ interval_count integer optional
└ end_date object optional
└ metadata object optional
└ discounts object optional
└ trial_end object optional
└ start_date object optional
└ description object optional
└ on_behalf_of string optional
└ automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
└ transfer_data object optional
└ destination string required
└ amount_percent number optional
└ invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ days_until_due integer optional
└ account_tax_ids object optional
└ add_invoice_items array optional
└ price string optional
└ period object optional
└ end object required
└ start object required
└ metadata object optional
└ quantity integer optional
└ discounts array optional
└ coupon string optional
└ discount string optional
└ promotion_code string optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ collection_method string optional
└ default_tax_rates object optional
└ billing_thresholds object optional
└ proration_behavior string optional
└ billing_cycle_anchor string optional
└ default_payment_method string optional
└ …1 more object optional
metadata object optional
end_behavior string optional
default_settings object optional
└ description object optional
└ on_behalf_of object optional
└ automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
└ transfer_data object optional
└ invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ days_until_due integer optional
└ account_tax_ids object optional
└ collection_method string optional
└ billing_thresholds object optional
└ billing_cycle_anchor string optional
└ default_payment_method string optional
└ application_fee_percent number optional
proration_behavior string optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscription_schedules/{schedule}
POST /v1/subscription_schedules/{schedule}/cancel

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

operationId: PostSubscriptionSchedulesScheduleCancel

Parameters

Name In Required Type Description
schedule path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
prorate boolean optional
invoice_now boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscription_schedules/{schedule}/cancel
POST /v1/subscription_schedules/{schedule}/release

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

operationId: PostSubscriptionSchedulesScheduleRelease

Parameters

Name In Required Type Description
schedule path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
preserve_cancel_date boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscription_schedules/{schedule}/release

Subscriptions 4 endpoints

POST /v1/subscriptions

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

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

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

operationId: PostSubscriptions

Request Body

application/x-www-form-urlencoded
Property Type Required
items array optional
└ price string optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ billing_thresholds object optional
expand array optional
currency string optional
customer string optional
metadata object optional
cancel_at object optional
discounts object optional
trial_end object optional
description string optional
off_session boolean optional
billing_mode object optional
└ type string required
└ flexible object optional
└ proration_discounts string optional
on_behalf_of object optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
transfer_data object optional
└ destination string required
└ amount_percent number optional
days_until_due integer optional
default_source string optional
trial_settings object optional
└ end_behavior object required
└ missing_payment_method string required
trial_from_plan boolean optional
customer_account string optional
invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ account_tax_ids object optional
…15 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscriptions
POST /v1/subscriptions/{subscription_exposed_id}

Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the create preview endpoint.

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

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

  • The billing interval is changed (for example, from monthly to yearly).
  • The subscription moves from free to paid.
  • A trial starts or ends.

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

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

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

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

operationId: PostSubscriptionsSubscriptionExposedId

Parameters

Name In Required Type Description
subscription_exposed_id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
items array optional
└ id string optional
└ price string optional
└ deleted boolean optional
└ metadata object optional
└ quantity integer optional
└ discounts object optional
└ tax_rates object optional
└ price_data object optional
└ product string required
└ currency string required
└ recurring object required
└ interval string required
└ interval_count integer optional
└ unit_amount integer optional
└ tax_behavior string optional
└ unit_amount_decimal string optional
└ clear_usage boolean optional
└ billing_thresholds object optional
expand array optional
metadata object optional
cancel_at object optional
discounts object optional
trial_end object optional
description object optional
off_session boolean optional
on_behalf_of object optional
automatic_tax object optional
└ enabled boolean required
└ liability object optional
└ type string required
└ account string optional
transfer_data object optional
days_until_due integer optional
default_source object optional
proration_date integer optional
trial_settings object optional
└ end_behavior object required
└ missing_payment_method string required
trial_from_plan boolean optional
invoice_settings object optional
└ issuer object optional
└ type string required
└ account string optional
└ account_tax_ids object optional
pause_collection object optional
payment_behavior string optional
payment_settings object optional
└ payment_method_types object optional
└ payment_method_options object optional
└ pix object optional
└ upi object optional
└ card object optional
└ payto object optional
└ konbini object optional
└ acss_debit object optional
└ bancontact object optional
└ sepa_debit object optional
└ us_bank_account object optional
└ customer_balance object optional
└ save_default_payment_method string optional
…11 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscriptions/{subscription_exposed_id}
POST /v1/subscriptions/{subscription}/migrate

Upgrade the billing_mode of an existing subscription.

operationId: PostSubscriptionsSubscriptionMigrate

Parameters

Name In Required Type Description
subscription path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
billing_mode object required
└ type string required
└ flexible object optional
└ proration_discounts string optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscriptions/{subscription}/migrate
POST /v1/subscriptions/{subscription}/resume

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice isn’t paid by the expiration date, it is voided and the subscription remains paused. You can only resume subscriptions with collection_method set to charge_automatically. send_invoice subscriptions are not supported.

operationId: PostSubscriptionsSubscriptionResume

Parameters

Name In Required Type Description
subscription path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
proration_date integer optional
proration_behavior string optional
billing_cycle_anchor string optional

Responses

default

Error response.
200

Successful response.
POST /v1/subscriptions/{subscription}/resume

Tax 6 endpoints

POST /v1/tax/calculations

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

operationId: PostTaxCalculations

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
currency string required
customer string optional
tax_date integer optional
line_items array required
└ amount integer required
└ product string optional
└ metadata object optional
└ quantity integer optional
└ tax_code string optional
└ reference string optional
└ tax_behavior string optional
shipping_cost object optional
└ amount integer optional
└ tax_code string optional
└ tax_behavior string optional
└ shipping_rate string optional
customer_details object optional
└ address object optional
└ city object optional
└ line1 object optional
└ line2 object optional
└ state object optional
└ country string required
└ postal_code object optional
└ tax_ids array optional
└ type string required
└ value string required
└ ip_address string optional
└ address_source string optional
└ taxability_override string optional
ship_from_details object optional
└ address object required
└ city object optional
└ line1 object optional
└ line2 object optional
└ state object optional
└ country string required
└ postal_code object optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax/calculations
POST /v1/tax/registrations

Creates a new Tax Registration object.

operationId: PostTaxRegistrations

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
country string required
expires_at integer optional
active_from object required
country_options object required
└ ae object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ al object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ am object optional
└ type string required
└ ao object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ at object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string required
└ au object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ aw object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ az object optional
└ type string required
└ ba object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ bb object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ bd object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ be object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string required
└ bf object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ bg object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string required
└ bh object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ bj object optional
└ type string required
└ bs object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ by object optional
└ type string required
└ ca object optional
└ type string required
└ province_standard object optional
└ province string required
└ cd object optional
└ type string required
└ standard object optional
└ place_of_supply_scheme string optional
└ …81 more object optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax/registrations
POST /v1/tax/registrations/{id}

Updates an existing Tax Registration object.

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

operationId: PostTaxRegistrationsId

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
expires_at object optional
active_from object optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax/registrations/{id}
POST /v1/tax/settings

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

operationId: PostTaxSettings

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
defaults object optional
└ tax_code string optional
└ tax_behavior string optional
head_office object optional
└ address object required
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax/settings
POST /v1/tax/transactions/create_from_calculation

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

operationId: PostTaxTransactionsCreateFromCalculation

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
posted_at integer optional
reference string required
calculation string required

Responses

default

Error response.
200

Successful response.
POST /v1/tax/transactions/create_from_calculation
POST /v1/tax/transactions/create_reversal

Partially or fully reverses a previously created Transaction.

operationId: PostTaxTransactionsCreateReversal

Request Body

required
application/x-www-form-urlencoded
Property Type Required
mode string required
expand array optional
metadata object optional
reference string required
line_items array optional
└ amount integer required
└ metadata object optional
└ quantity integer optional
└ reference string required
└ amount_tax integer required
└ original_line_item string required
flat_amount integer optional
shipping_cost object optional
└ amount integer required
└ amount_tax integer required
original_transaction string required

Responses

default

Error response.
200

Successful response.
POST /v1/tax/transactions/create_reversal

Taxids 1 endpoints

POST /v1/tax_ids

Creates a new account or customer tax_id object.

operationId: PostTaxIds

Request Body

required
application/x-www-form-urlencoded
Property Type Required
type string required
owner object optional
└ type string required
└ account string optional
└ customer string optional
└ customer_account string optional
value string required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax_ids

Taxrates 2 endpoints

POST /v1/tax_rates

Creates a new tax rate.

operationId: PostTaxRates

Request Body

required
application/x-www-form-urlencoded
Property Type Required
state string optional
active boolean optional
expand array optional
country string optional
metadata object optional
tax_type string optional
inclusive boolean required
percentage number required
description string optional
display_name string required
jurisdiction string optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax_rates
POST /v1/tax_rates/{tax_rate}

Updates an existing tax rate.

operationId: PostTaxRatesTaxRate

Parameters

Name In Required Type Description
tax_rate path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
state string optional
active boolean optional
expand array optional
country string optional
metadata object optional
tax_type string optional
description string optional
display_name string optional
jurisdiction string optional

Responses

default

Error response.
200

Successful response.
POST /v1/tax_rates/{tax_rate}

Terminal 17 endpoints

POST /v1/terminal/configurations

Creates a new Configuration object.

operationId: PostTerminalConfigurations

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
wifi object optional
expand array optional
offline object optional
tipping object optional
cellular object optional
stripe_s700 object optional
└ splashscreen object optional
stripe_s710 object optional
└ splashscreen object optional
reboot_window object optional
└ end_hour integer required
└ start_hour integer required
verifone_p400 object optional
└ splashscreen object optional
bbpos_wisepad3 object optional
└ splashscreen object optional
bbpos_wisepos_e object optional
└ splashscreen object optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/configurations
POST /v1/terminal/configurations/{configuration}

Updates a new Configuration object.

operationId: PostTerminalConfigurationsConfiguration

Parameters

Name In Required Type Description
configuration path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
name string optional
wifi object optional
expand array optional
offline object optional
tipping object optional
cellular object optional
stripe_s700 object optional
stripe_s710 object optional
reboot_window object optional
verifone_p400 object optional
bbpos_wisepad3 object optional
bbpos_wisepos_e object optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/configurations/{configuration}
POST /v1/terminal/connection_tokens

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

operationId: PostTerminalConnectionTokens

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
location string optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/connection_tokens
POST /v1/terminal/locations

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

operationId: PostTerminalLocations

Request Body

application/x-www-form-urlencoded
Property Type Required
phone string optional
expand array optional
address object optional
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string required
└ postal_code string optional
metadata object 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
display_name 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
display_name_kana string optional
display_name_kanji string optional
configuration_overrides string optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/locations
POST /v1/terminal/locations/{location}

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

operationId: PostTerminalLocationsLocation

Parameters

Name In Required Type Description
location path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
phone object optional
expand array 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
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
display_name object 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
display_name_kana object optional
display_name_kanji object optional
configuration_overrides object optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/locations/{location}
POST /v1/terminal/onboarding_links

Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.

operationId: PostTerminalOnboardingLinks

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
link_type string required
link_options object required
└ apple_terms_and_conditions object optional
└ allow_relinking boolean optional
└ merchant_display_name string required
on_behalf_of string optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/onboarding_links
POST /v1/terminal/readers

Creates a new Reader object.

operationId: PostTerminalReaders

Request Body

required
application/x-www-form-urlencoded
Property Type Required
label string optional
expand array optional
location string optional
metadata object optional
registration_code string required

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers
POST /v1/terminal/readers/{reader}

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

operationId: PostTerminalReadersReader

Parameters

Name In Required Type Description
reader path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
label object optional
expand array optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}
POST /v1/terminal/readers/{reader}/cancel_action

Cancels the current reader action. See Programmatic Cancellation for more details.

operationId: PostTerminalReadersReaderCancelAction

Parameters

Name In Required Type Description
reader 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/terminal/readers/{reader}/cancel_action
POST /v1/terminal/readers/{reader}/collect_inputs

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

operationId: PostTerminalReadersReaderCollectInputs

Parameters

Name In Required Type Description
reader path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
inputs array required
└ type string required
└ toggles array optional
└ title string optional
└ description string optional
└ default_value string optional
└ required boolean optional
└ selection object optional
└ choices array required
└ id string required
└ text string required
└ style string optional
└ custom_text object required
└ title string required
└ description string optional
└ skip_button string optional
└ submit_button string optional
metadata object optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/collect_inputs
POST /v1/terminal/readers/{reader}/collect_payment_method

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

operationId: PostTerminalReadersReaderCollectPaymentMethod

Parameters

Name In Required Type Description
reader path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
collect_config object optional
└ tipping object optional
└ amount_eligible integer optional
└ skip_tipping boolean optional
└ allow_redisplay string optional
└ enable_customer_cancellation boolean optional
payment_intent string required

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/collect_payment_method
POST /v1/terminal/readers/{reader}/confirm_payment_intent

Finalizes a payment on a Reader. See Confirming a Payment for more details.

operationId: PostTerminalReadersReaderConfirmPaymentIntent

Parameters

Name In Required Type Description
reader path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
confirm_config object optional
└ return_url string optional
payment_intent string required

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/confirm_payment_intent
POST /v1/terminal/readers/{reader}/process_payment_intent

Initiates a payment flow on a Reader. See process the payment for more details.

operationId: PostTerminalReadersReaderProcessPaymentIntent

Parameters

Name In Required Type Description
reader path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
payment_intent string required
process_config object optional
└ tipping object optional
└ amount_eligible integer optional
└ return_url string optional
└ skip_tipping boolean optional
└ allow_redisplay string optional
└ enable_customer_cancellation boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/process_payment_intent
POST /v1/terminal/readers/{reader}/process_setup_intent

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

operationId: PostTerminalReadersReaderProcessSetupIntent

Parameters

Name In Required Type Description
reader path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
setup_intent string required
process_config object optional
└ enable_customer_cancellation boolean optional
allow_redisplay string required

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/process_setup_intent
POST /v1/terminal/readers/{reader}/refund_payment

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

operationId: PostTerminalReadersReaderRefundPayment

Parameters

Name In Required Type Description
reader path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
charge string optional
expand array optional
metadata object optional
payment_intent string optional
reverse_transfer boolean optional
refund_payment_config object optional
└ enable_customer_cancellation boolean optional
refund_application_fee boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/refund_payment
POST /v1/terminal/readers/{reader}/set_reader_display

Sets the reader display to show cart details.

operationId: PostTerminalReadersReaderSetReaderDisplay

Parameters

Name In Required Type Description
reader path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
cart object optional
└ tax integer optional
└ total integer required
└ currency string required
└ line_items array required
└ amount integer required
└ quantity integer required
└ description string required
type string required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/readers/{reader}/set_reader_display
POST /v1/terminal/refunds

Internal endpoint for terminal use to create a refund for a card_present charge. This endpoint only supports card_present payment method types (excludes interac_present).

You can optionally refund only part of a charge.

operationId: PostTerminalRefunds

Request Body

application/x-www-form-urlencoded
Property Type Required
amount integer optional
charge string optional
expand array optional
reason string optional
metadata object optional
payment_intent string optional
reverse_transfer boolean optional
refund_application_fee boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/terminal/refunds

Testhelpers 41 endpoints

POST /v1/test_helpers/confirmation_tokens

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

operationId: PostTestHelpersConfirmationTokens

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
shipping object optional
└ name string required
└ phone object optional
└ address object required
└ city string optional
└ line1 string optional
└ line2 string optional
└ state string optional
└ country string optional
└ postal_code string optional
return_url string optional
payment_method string optional
setup_future_usage string optional
payment_method_data object optional
└ eps object optional
└ bank string optional
└ fpx object optional
└ bank string required
└ p24 object optional
└ bank string optional
└ pix object optional
└ upi object optional
└ mandate_options object optional
└ amount integer optional
└ end_date integer optional
└ amount_type string optional
└ description string optional
└ zip object optional
└ alma object optional
└ blik object optional
└ link object optional
└ oxxo object optional
└ type string required
└ ideal object optional
└ bank string optional
└ payco object optional
└ payto object optional
└ pay_id string optional
└ bsb_number string optional
└ account_number string optional
└ swish object optional
└ twint object optional
└ affirm object optional
└ alipay object optional
└ billie object optional
└ boleto object optional
└ tax_id string required
└ …37 more object optional
payment_method_options object optional
└ card object optional
└ installments object optional
└ plan object required

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/confirmation_tokens
POST /v1/test_helpers/customers/{customer}/fund_cash_balance

Create an incoming testmode bank transfer

operationId: PostTestHelpersCustomersCustomerFundCashBalance

Parameters

Name In Required Type Description
customer path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
currency string required
reference string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/customers/{customer}/fund_cash_balance
POST /v1/test_helpers/issuing/authorizations

Create a test-mode authorization.

operationId: PostTestHelpersIssuingAuthorizations

Request Body

required
application/x-www-form-urlencoded
Property Type Required
card string required
fuel object optional
└ type string optional
└ unit string optional
└ quantity_decimal string optional
└ unit_cost_decimal string optional
└ industry_product_code string optional
fleet object optional
└ service_type string optional
└ purchase_type string optional
└ reported_breakdown object optional
└ tax object optional
└ local_amount_decimal string optional
└ national_amount_decimal string optional
└ fuel object optional
└ gross_amount_decimal string optional
└ non_fuel object optional
└ gross_amount_decimal string optional
└ cardholder_prompt_data object optional
└ user_id string optional
└ odometer integer optional
└ driver_id string optional
└ unspecified_id string optional
└ vehicle_number string optional
amount integer optional
expand array optional
wallet string optional
currency string optional
network_data object optional
└ acquiring_institution_id string optional
merchant_data object optional
└ url string optional
└ city string optional
└ name string optional
└ state string optional
└ country string optional
└ category string optional
└ network_id string optional
└ postal_code string optional
└ terminal_id string optional
amount_details object optional
└ atm_fee integer optional
└ cashback_amount integer optional
merchant_amount integer optional
risk_assessment object optional
└ fraud_risk object optional
└ level string required
└ score number optional
└ card_testing_risk object optional
└ level string required
└ invalid_credentials_decline_rate_past_hour integer optional
└ invalid_account_number_decline_rate_past_hour integer optional
└ merchant_dispute_risk object optional
└ level string required
└ dispute_rate integer optional
merchant_currency string optional
verification_data object optional
└ cvc_check string optional
└ expiry_check string optional
└ three_d_secure object optional
└ result string required
└ address_line1_check string optional
└ authentication_exemption object optional
└ type string required
└ claimed_by string required
└ address_postal_code_check string optional
authorization_method string optional
is_amount_controllable boolean optional
fraud_disputability_likelihood string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/authorizations
POST /v1/test_helpers/issuing/authorizations/{authorization}/capture

Capture a test-mode authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationCapture

Parameters

Name In Required Type Description
authorization path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
capture_amount integer optional
purchase_details object optional
└ fuel object optional
└ type string optional
└ unit string optional
└ quantity_decimal string optional
└ unit_cost_decimal string optional
└ industry_product_code string optional
└ fleet object optional
└ service_type string optional
└ purchase_type string optional
└ reported_breakdown object optional
└ tax object optional
└ fuel object optional
└ non_fuel object optional
└ cardholder_prompt_data object optional
└ user_id string optional
└ odometer integer optional
└ driver_id string optional
└ unspecified_id string optional
└ vehicle_number string optional
└ flight object optional
└ segments array optional
└ carrier string optional
└ flight_number string optional
└ service_class string optional
└ stopover_allowed boolean optional
└ arrival_airport_code string optional
└ departure_airport_code string optional
└ refundable boolean optional
└ departure_at integer optional
└ travel_agency string optional
└ passenger_name string optional
└ lodging object optional
└ nights integer optional
└ check_in_at integer optional
└ receipt array optional
└ total integer optional
└ quantity string optional
└ unit_cost integer optional
└ description string optional
└ reference string optional
close_authorization boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/authorizations/{authorization}/capture
POST /v1/test_helpers/issuing/authorizations/{authorization}/expire

Expire a test-mode Authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationExpire

Parameters

Name In Required Type Description
authorization 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/test_helpers/issuing/authorizations/{authorization}/expire
POST /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount

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

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount

Parameters

Name In Required Type Description
authorization path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
fuel object optional
└ type string optional
└ unit string optional
└ quantity_decimal string optional
└ unit_cost_decimal string optional
└ industry_product_code string optional
fleet object optional
└ service_type string optional
└ purchase_type string optional
└ reported_breakdown object optional
└ tax object optional
└ local_amount_decimal string optional
└ national_amount_decimal string optional
└ fuel object optional
└ gross_amount_decimal string optional
└ non_fuel object optional
└ gross_amount_decimal string optional
└ cardholder_prompt_data object optional
└ user_id string optional
└ odometer integer optional
└ driver_id string optional
└ unspecified_id string optional
└ vehicle_number string optional
expand array optional
final_amount integer required

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount
POST /v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond

Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond

Parameters

Name In Required Type Description
authorization path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
confirmed boolean required

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond
POST /v1/test_helpers/issuing/authorizations/{authorization}/increment

Increment a test-mode Authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationIncrement

Parameters

Name In Required Type Description
authorization path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
increment_amount integer required
is_amount_controllable boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/authorizations/{authorization}/increment
POST /v1/test_helpers/issuing/authorizations/{authorization}/reverse

Reverse a test-mode Authorization.

operationId: PostTestHelpersIssuingAuthorizationsAuthorizationReverse

Parameters

Name In Required Type Description
authorization path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
reverse_amount integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/authorizations/{authorization}/reverse
POST /v1/test_helpers/issuing/cards/{card}/shipping/deliver

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

operationId: PostTestHelpersIssuingCardsCardShippingDeliver

Parameters

Name In Required Type Description
card 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/test_helpers/issuing/cards/{card}/shipping/deliver
POST /v1/test_helpers/issuing/cards/{card}/shipping/fail

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

operationId: PostTestHelpersIssuingCardsCardShippingFail

Parameters

Name In Required Type Description
card 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/test_helpers/issuing/cards/{card}/shipping/fail
POST /v1/test_helpers/issuing/cards/{card}/shipping/return

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

operationId: PostTestHelpersIssuingCardsCardShippingReturn

Parameters

Name In Required Type Description
card 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/test_helpers/issuing/cards/{card}/shipping/return
POST /v1/test_helpers/issuing/cards/{card}/shipping/ship

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

operationId: PostTestHelpersIssuingCardsCardShippingShip

Parameters

Name In Required Type Description
card 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/test_helpers/issuing/cards/{card}/shipping/ship
POST /v1/test_helpers/issuing/cards/{card}/shipping/submit

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

operationId: PostTestHelpersIssuingCardsCardShippingSubmit

Parameters

Name In Required Type Description
card 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/test_helpers/issuing/cards/{card}/shipping/submit
POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate

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

operationId: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate

Parameters

Name In Required Type Description
personalization_design 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/test_helpers/issuing/personalization_designs/{personalization_design}/activate
POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate

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

operationId: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate

Parameters

Name In Required Type Description
personalization_design 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/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate
POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject

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

operationId: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject

Parameters

Name In Required Type Description
personalization_design path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
rejection_reasons object required
└ card_logo array optional
└ carrier_text array optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject
POST /v1/test_helpers/issuing/settlements

Allows the user to create an Issuing settlement.

operationId: PostTestHelpersIssuingSettlements

Request Body

required
application/x-www-form-urlencoded
Property Type Required
bin string required
expand array optional
network string optional
currency string required
clearing_date integer required
net_total_amount integer required
transaction_count integer optional
transaction_amount integer optional
interchange_fees_amount integer optional
network_settlement_identifier string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/settlements
POST /v1/test_helpers/issuing/settlements/{settlement}/complete

Allows the user to mark an Issuing settlement as complete.

operationId: PostTestHelpersIssuingSettlementsSettlementComplete

Parameters

Name In Required Type Description
settlement path required string

The settlement token to mark as complete.

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/settlements/{settlement}/complete
POST /v1/test_helpers/issuing/transactions/create_force_capture

Allows the user to capture an arbitrary amount, also known as a forced capture.

operationId: PostTestHelpersIssuingTransactionsCreateForceCapture

Request Body

required
application/x-www-form-urlencoded
Property Type Required
card string required
amount integer required
expand array optional
currency string optional
merchant_data object optional
└ url string optional
└ city string optional
└ name string optional
└ state string optional
└ country string optional
└ category string optional
└ network_id string optional
└ postal_code string optional
└ terminal_id string optional
purchase_details object optional
└ fuel object optional
└ type string optional
└ unit string optional
└ quantity_decimal string optional
└ unit_cost_decimal string optional
└ industry_product_code string optional
└ fleet object optional
└ service_type string optional
└ purchase_type string optional
└ reported_breakdown object optional
└ tax object optional
└ fuel object optional
└ non_fuel object optional
└ cardholder_prompt_data object optional
└ user_id string optional
└ odometer integer optional
└ driver_id string optional
└ unspecified_id string optional
└ vehicle_number string optional
└ flight object optional
└ segments array optional
└ carrier string optional
└ flight_number string optional
└ service_class string optional
└ stopover_allowed boolean optional
└ arrival_airport_code string optional
└ departure_airport_code string optional
└ refundable boolean optional
└ departure_at integer optional
└ travel_agency string optional
└ passenger_name string optional
└ lodging object optional
└ nights integer optional
└ check_in_at integer optional
└ receipt array optional
└ total integer optional
└ quantity string optional
└ unit_cost integer optional
└ description string optional
└ reference string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/transactions/create_force_capture
POST /v1/test_helpers/issuing/transactions/create_unlinked_refund

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

operationId: PostTestHelpersIssuingTransactionsCreateUnlinkedRefund

Request Body

required
application/x-www-form-urlencoded
Property Type Required
card string required
amount integer required
expand array optional
currency string optional
merchant_data object optional
└ url string optional
└ city string optional
└ name string optional
└ state string optional
└ country string optional
└ category string optional
└ network_id string optional
└ postal_code string optional
└ terminal_id string optional
purchase_details object optional
└ fuel object optional
└ type string optional
└ unit string optional
└ quantity_decimal string optional
└ unit_cost_decimal string optional
└ industry_product_code string optional
└ fleet object optional
└ service_type string optional
└ purchase_type string optional
└ reported_breakdown object optional
└ tax object optional
└ fuel object optional
└ non_fuel object optional
└ cardholder_prompt_data object optional
└ user_id string optional
└ odometer integer optional
└ driver_id string optional
└ unspecified_id string optional
└ vehicle_number string optional
└ flight object optional
└ segments array optional
└ carrier string optional
└ flight_number string optional
└ service_class string optional
└ stopover_allowed boolean optional
└ arrival_airport_code string optional
└ departure_airport_code string optional
└ refundable boolean optional
└ departure_at integer optional
└ travel_agency string optional
└ passenger_name string optional
└ lodging object optional
└ nights integer optional
└ check_in_at integer optional
└ receipt array optional
└ total integer optional
└ quantity string optional
└ unit_cost integer optional
└ description string optional
└ reference string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/transactions/create_unlinked_refund
POST /v1/test_helpers/issuing/transactions/{transaction}/refund

Refund a test-mode Transaction.

operationId: PostTestHelpersIssuingTransactionsTransactionRefund

Parameters

Name In Required Type Description
transaction path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
refund_amount integer optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/issuing/transactions/{transaction}/refund
POST /v1/test_helpers/refunds/{refund}/expire

Expire a refund with a status of requires_action.

operationId: PostTestHelpersRefundsRefundExpire

Parameters

Name In Required Type Description
refund 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/test_helpers/refunds/{refund}/expire
POST /v1/test_helpers/terminal/readers/{reader}/present_payment_method

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

operationId: PostTestHelpersTerminalReadersReaderPresentPaymentMethod

Parameters

Name In Required Type Description
reader path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
card object optional
└ cvc string optional
└ number string required
└ exp_year integer required
└ exp_month integer required
type string optional
expand array optional
amount_tip integer optional
card_present object optional
└ number string optional
interac_present object optional
└ number string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/terminal/readers/{reader}/present_payment_method
POST /v1/test_helpers/terminal/readers/{reader}/succeed_input_collection

Use this endpoint to trigger a successful input collection on a simulated reader.

operationId: PostTestHelpersTerminalReadersReaderSucceedInputCollection

Parameters

Name In Required Type Description
reader path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
skip_non_required_inputs string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/terminal/readers/{reader}/succeed_input_collection
POST /v1/test_helpers/terminal/readers/{reader}/timeout_input_collection

Use this endpoint to complete an input collection with a timeout error on a simulated reader.

operationId: PostTestHelpersTerminalReadersReaderTimeoutInputCollection

Parameters

Name In Required Type Description
reader 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/test_helpers/terminal/readers/{reader}/timeout_input_collection
POST /v1/test_helpers/test_clocks

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

operationId: PostTestHelpersTestClocks

Request Body

required
application/x-www-form-urlencoded
Property Type Required
name string optional
expand array optional
frozen_time integer required

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/test_clocks
POST /v1/test_helpers/test_clocks/{test_clock}/advance

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

operationId: PostTestHelpersTestClocksTestClockAdvance

Parameters

Name In Required Type Description
test_clock path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
frozen_time integer required

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/test_clocks/{test_clock}/advance
POST /v1/test_helpers/treasury/inbound_transfers/{id}/fail

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

operationId: PostTestHelpersTreasuryInboundTransfersIdFail

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
failure_details object optional
└ code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/inbound_transfers/{id}/fail
POST /v1/test_helpers/treasury/inbound_transfers/{id}/return

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

operationId: PostTestHelpersTreasuryInboundTransfersIdReturn

Parameters

Name In Required Type Description
id 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/test_helpers/treasury/inbound_transfers/{id}/return
POST /v1/test_helpers/treasury/inbound_transfers/{id}/succeed

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

operationId: PostTestHelpersTreasuryInboundTransfersIdSucceed

Parameters

Name In Required Type Description
id 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/test_helpers/treasury/inbound_transfers/{id}/succeed
POST /v1/test_helpers/treasury/outbound_payments/{id}

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

operationId: PostTestHelpersTreasuryOutboundPaymentsId

Parameters

Name In Required Type Description
id path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
tracking_details object required
└ ach object optional
└ trace_id string required
└ type string required
└ us_domestic_wire object optional
└ imad string optional
└ omad string optional
└ chips string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/outbound_payments/{id}
POST /v1/test_helpers/treasury/outbound_payments/{id}/fail

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

operationId: PostTestHelpersTreasuryOutboundPaymentsIdFail

Parameters

Name In Required Type Description
id 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/test_helpers/treasury/outbound_payments/{id}/fail
POST /v1/test_helpers/treasury/outbound_payments/{id}/post

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

operationId: PostTestHelpersTreasuryOutboundPaymentsIdPost

Parameters

Name In Required Type Description
id 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/test_helpers/treasury/outbound_payments/{id}/post
POST /v1/test_helpers/treasury/outbound_payments/{id}/return

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

operationId: PostTestHelpersTreasuryOutboundPaymentsIdReturn

Parameters

Name In Required Type Description
id path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
returned_details object optional
└ code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/outbound_payments/{id}/return
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}

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

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransfer

Parameters

Name In Required Type Description
outbound_transfer path required string —

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
tracking_details object required
└ ach object optional
└ trace_id string required
└ type string required
└ us_domestic_wire object optional
└ imad string optional
└ omad string optional
└ chips string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail

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

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail

Parameters

Name In Required Type Description
outbound_transfer 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/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post

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

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost

Parameters

Name In Required Type Description
outbound_transfer 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/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return

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

operationId: PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn

Parameters

Name In Required Type Description
outbound_transfer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
returned_details object optional
└ code string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return
POST /v1/test_helpers/treasury/received_credits

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

operationId: PostTestHelpersTreasuryReceivedCredits

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
network string required
currency string required
description string optional
financial_account string required
initiating_payment_method_details object optional
└ type string required
└ us_bank_account object optional
└ account_number string optional
└ routing_number string optional
└ account_holder_name string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/received_credits
POST /v1/test_helpers/treasury/received_debits

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

operationId: PostTestHelpersTreasuryReceivedDebits

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
network string required
currency string required
description string optional
financial_account string required
initiating_payment_method_details object optional
└ type string required
└ us_bank_account object optional
└ account_number string optional
└ routing_number string optional
└ account_holder_name string optional

Responses

default

Error response.
200

Successful response.
POST /v1/test_helpers/treasury/received_debits

Tokens 1 endpoints

POST /v1/tokens

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

operationId: PostTokens

Request Body

application/x-www-form-urlencoded
Property Type Required
pii object optional
└ id_number string optional
card object optional
expand array optional
person 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
└ 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
└ 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
└ last_name_kana string optional
└ first_name_kana string optional
└ …7 more object optional
account 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
└ 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
└ …4 more object 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
└ additional_document object 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
└ business_type string optional
└ tos_shown_and_accepted boolean optional
customer string optional
cvc_update object optional
└ cvc string required
bank_account object optional
└ country string required
└ currency string optional
└ account_type string optional
└ account_number string required
└ payment_method string optional
└ routing_number string optional
└ account_holder_name string optional
└ account_holder_type string optional

Responses

default

Error response.
200

Successful response.
POST /v1/tokens

Topups 3 endpoints

POST /v1/topups

Top up the balance of an account

operationId: PostTopups

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
source string optional
currency string required
metadata object optional
description string optional
transfer_group string optional
statement_descriptor string optional

Responses

default

Error response.
200

Successful response.
POST /v1/topups
POST /v1/topups/{topup}

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

operationId: PostTopupsTopup

Parameters

Name In Required Type Description
topup path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
description string optional

Responses

default

Error response.
200

Successful response.
POST /v1/topups/{topup}
POST /v1/topups/{topup}/cancel

Cancels a top-up. Only pending top-ups can be canceled.

operationId: PostTopupsTopupCancel

Parameters

Name In Required Type Description
topup 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/topups/{topup}/cancel

Transfers 4 endpoints

POST /v1/transfers

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

operationId: PostTransfers

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer optional
expand array optional
currency string required
metadata object optional
description string optional
destination string required
source_type string optional
transfer_group string optional
source_transaction string optional

Responses

default

Error response.
200

Successful response.
POST /v1/transfers
POST /v1/transfers/{id}/reversals

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

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

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

operationId: PostTransfersIdReversals

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
description string optional
refund_application_fee boolean optional

Responses

default

Error response.
200

Successful response.
POST /v1/transfers/{id}/reversals
POST /v1/transfers/{transfer}

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

This request accepts only metadata as an argument.

operationId: PostTransfersTransfer

Parameters

Name In Required Type Description
transfer path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
description string optional

Responses

default

Error response.
200

Successful response.
POST /v1/transfers/{transfer}
POST /v1/transfers/{transfer}/reversals/{id}

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

This request only accepts metadata and description as arguments.

operationId: PostTransfersTransferReversalsId

Parameters

Name In Required Type Description
id path required string —
transfer 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/transfers/{transfer}/reversals/{id}

Treasury 12 endpoints

POST /v1/treasury/credit_reversals

Reverses a ReceivedCredit and creates a CreditReversal object.

operationId: PostTreasuryCreditReversals

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
received_credit string required

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/credit_reversals
POST /v1/treasury/debit_reversals

Reverses a ReceivedDebit and creates a DebitReversal object.

operationId: PostTreasuryDebitReversals

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
metadata object optional
received_debit string required

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/debit_reversals
POST /v1/treasury/financial_accounts

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

operationId: PostTreasuryFinancialAccounts

Request Body

required
application/x-www-form-urlencoded
Property Type Required
expand array optional
features object optional
└ card_issuing object optional
└ requested boolean required
└ deposit_insurance object optional
└ requested boolean required
└ inbound_transfers object optional
└ ach object optional
└ requested boolean required
└ outbound_payments object optional
└ ach object optional
└ requested boolean required
└ us_domestic_wire object optional
└ requested boolean required
└ intra_stripe_flows object optional
└ requested boolean required
└ outbound_transfers object optional
└ ach object optional
└ requested boolean required
└ us_domestic_wire object optional
└ requested boolean required
└ financial_addresses object optional
└ aba object optional
└ requested boolean required
metadata object optional
nickname object optional
supported_currencies array required
platform_restrictions object optional
└ inbound_flows string optional
└ outbound_flows string optional

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/financial_accounts
POST /v1/treasury/financial_accounts/{financial_account}

Updates the details of a FinancialAccount.

operationId: PostTreasuryFinancialAccountsFinancialAccount

Parameters

Name In Required Type Description
financial_account path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
features object optional
└ card_issuing object optional
└ requested boolean required
└ deposit_insurance object optional
└ requested boolean required
└ inbound_transfers object optional
└ ach object optional
└ requested boolean required
└ outbound_payments object optional
└ ach object optional
└ requested boolean required
└ us_domestic_wire object optional
└ requested boolean required
└ intra_stripe_flows object optional
└ requested boolean required
└ outbound_transfers object optional
└ ach object optional
└ requested boolean required
└ us_domestic_wire object optional
└ requested boolean required
└ financial_addresses object optional
└ aba object optional
└ requested boolean required
metadata object optional
nickname object optional
forwarding_settings object optional
└ type string required
└ payment_method string optional
└ financial_account string optional
platform_restrictions object optional
└ inbound_flows string optional
└ outbound_flows string optional

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/financial_accounts/{financial_account}
POST /v1/treasury/financial_accounts/{financial_account}/close

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

operationId: PostTreasuryFinancialAccountsFinancialAccountClose

Parameters

Name In Required Type Description
financial_account path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
forwarding_settings object optional
└ type string required
└ payment_method string optional
└ financial_account string optional

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/financial_accounts/{financial_account}/close
POST /v1/treasury/financial_accounts/{financial_account}/features

Updates the Features associated with a FinancialAccount.

operationId: PostTreasuryFinancialAccountsFinancialAccountFeatures

Parameters

Name In Required Type Description
financial_account path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
expand array optional
card_issuing object optional
└ requested boolean required
deposit_insurance object optional
└ requested boolean required
inbound_transfers object optional
└ ach object optional
└ requested boolean required
outbound_payments object optional
└ ach object optional
└ requested boolean required
└ us_domestic_wire object optional
└ requested boolean required
intra_stripe_flows object optional
└ requested boolean required
outbound_transfers object optional
└ ach object optional
└ requested boolean required
└ us_domestic_wire object optional
└ requested boolean required
financial_addresses object optional
└ aba object optional
└ requested boolean required

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/financial_accounts/{financial_account}/features
POST /v1/treasury/inbound_transfers

Creates an InboundTransfer.

operationId: PostTreasuryInboundTransfers

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
currency string required
metadata object optional
description string optional
financial_account string required
statement_descriptor string optional
origin_payment_method string required

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/inbound_transfers
POST /v1/treasury/inbound_transfers/{inbound_transfer}/cancel

Cancels an InboundTransfer.

operationId: PostTreasuryInboundTransfersInboundTransferCancel

Parameters

Name In Required Type Description
inbound_transfer 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/treasury/inbound_transfers/{inbound_transfer}/cancel
POST /v1/treasury/outbound_payments

Creates an OutboundPayment.

operationId: PostTreasuryOutboundPayments

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
currency string required
customer string optional
metadata object optional
description string optional
end_user_details object optional
└ present boolean required
└ ip_address string optional
financial_account string required
statement_descriptor string optional
destination_payment_method string optional
destination_payment_method_data object optional
└ type string required
└ metadata object optional
└ billing_details object optional
└ name object optional
└ email object optional
└ phone object optional
└ address object optional
└ us_bank_account object optional
└ account_type string optional
└ account_number string optional
└ routing_number string optional
└ account_holder_type string optional
└ financial_connections_account string optional
└ financial_account string optional
destination_payment_method_options object optional
└ us_bank_account object optional

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/outbound_payments
POST /v1/treasury/outbound_payments/{id}/cancel

Cancel an OutboundPayment.

operationId: PostTreasuryOutboundPaymentsIdCancel

Parameters

Name In Required Type Description
id 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/treasury/outbound_payments/{id}/cancel
POST /v1/treasury/outbound_transfers

Creates an OutboundTransfer.

operationId: PostTreasuryOutboundTransfers

Request Body

required
application/x-www-form-urlencoded
Property Type Required
amount integer required
expand array optional
currency string required
metadata object optional
description string optional
financial_account string required
statement_descriptor string optional
destination_payment_method string optional
destination_payment_method_data object optional
└ type string required
└ financial_account string optional
destination_payment_method_options object optional
└ us_bank_account object optional

Responses

default

Error response.
200

Successful response.
POST /v1/treasury/outbound_transfers
POST /v1/treasury/outbound_transfers/{outbound_transfer}/cancel

An OutboundTransfer can be canceled if the funds have not yet been paid out.

operationId: PostTreasuryOutboundTransfersOutboundTransferCancel

Parameters

Name In Required Type Description
outbound_transfer 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/treasury/outbound_transfers/{outbound_transfer}/cancel

Webhookendpoints 2 endpoints

POST /v1/webhook_endpoints

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

operationId: PostWebhookEndpoints

Request Body

required
application/x-www-form-urlencoded
Property Type Required
url string required
expand array optional
connect boolean optional
metadata object optional
api_version string optional
description object optional
enabled_events array required

Responses

default

Error response.
200

Successful response.
POST /v1/webhook_endpoints
POST /v1/webhook_endpoints/{webhook_endpoint}

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

operationId: PostWebhookEndpointsWebhookEndpoint

Parameters

Name In Required Type Description
webhook_endpoint path required string —

Request Body

application/x-www-form-urlencoded
Property Type Required
url string optional
expand array optional
disabled boolean optional
metadata object optional
description object optional
enabled_events array optional

Responses

default

Error response.
200

Successful response.
POST /v1/webhook_endpoints/{webhook_endpoint}
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