Create an account
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.
Parameters
- typeenumRequired
The type of Stripe account to create. May be one of
custom
,express
orstandard
. - business_
typeenum The business type. Once you create an Account Link or Account Session, this property can only be updated for Custom accounts.
- capabilitiesobjectRequired for custom accounts
Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
- companyobject
Information about the company or business. This field is available for any
business_type
. Once you create an Account Link or Account Session, this property can only be updated for Custom accounts. - countrystringdefault is your own country
The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you’re creating an account is legally represented in Canada, you would use
CA
as the country for the account being created. Available countries include Stripe’s global markets as well as countries where cross-border payouts are supported. - emailstring
The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.
- individualobject
Information about the person represented by the account. This field is null unless
business_type
is set toindividual
. Once you create an Account Link or Account Session, this property can only be updated for Custom accounts. - metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - tos_
acceptanceobject Details on the account’s acceptance of the Stripe Services Agreement This property can only be updated for Custom accounts.
More parameters
- account_
tokenstring - business_
profileobject - default_
currencyenum - documentsobject
- external_
accountstring - settingsobject
Returns
Returns an Account
object if the call succeeds.
Update an account
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.
For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link or Account Session, some properties can only be changed or updated for Custom accounts.
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
Parameters
- business_
typeenum The business type. Once you create an Account Link or Account Session, this property can only be updated for Custom accounts.
- capabilitiesobject
Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
- companyobject
Information about the company or business. This field is available for any
business_type
. Once you create an Account Link or Account Session, this property can only be updated for Custom accounts. - emailstring
The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.
- individualobject
Information about the person represented by the account. This field is null unless
business_type
is set toindividual
. Once you create an Account Link or Account Session, this property can only be updated for Custom accounts. - metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - tos_
acceptanceobject Details on the account’s acceptance of the Stripe Services Agreement This property can only be updated for Custom accounts.
More parameters
- account_
tokenstring - business_
profileobject - default_
currencyenum - documentsobject
- external_
accountstring - settingsobject
Retrieve account
List all connected accounts
Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
Parameters
No parameters.
More parameters
- createdobject
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
accounts, starting after account starting_after
. Each entry in the array is a separate Account
object. If no more accounts are available, the resulting array is empty.
Delete an account
With Connect, you can delete accounts you manage.
Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
Parameters
No parameters.
Returns
Returns an object with a deleted parameter if the call succeeds. If the account ID does not exist, this call raises an error.