Stripe: Account sessions schemas

← Account sessions operations · All schemas

Create an Account Session — response body

Field	Type	Presence	Description and constraints
$	object	Root	An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components. We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once. Related guide: [Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components)
account	string	Required within parent	The ID of the account the AccountSession was created for Maximum length: 5000
client_secret	string	Required within parent	The client secret of this AccountSession. Used on the client to set up secure access to the given `account`. The 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. Refer 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. Maximum length: 5000
components	Model	Required within parent	Expand Create an Account Session — response body — components
expires_at	JSON	Required within parent
expires_at (anyOf 1)	integer	Alternative	The timestamp at which this AccountSession will expire. Format: unix-time
expires_at (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: account_session

Referenced models: Create an Account Session — response body — components

Create an Account Session — response body — components

Field	Type	Presence	Description and constraints
$	object	Root
account_management	Model	Required within parent	Expand Create an Account Session — response body — components account management
account_onboarding	Model	Required within parent	Expand Create an Account Session — response body — components account management
balance_report	Model	Required within parent	Expand Create an Account Session — response body — components documents
balances	Model	Required within parent	Expand Create an Account Session — response body — components payouts
disputes_list	Model	Required within parent	Expand Create an Account Session — response body — components payments
documents	Model	Required within parent	Expand Create an Account Session — response body — components documents
financial_account	Model	Required within parent	Expand Create an Account Session — response body — components financial account
financial_account_transactions	Model	Required within parent	Expand Create an Account Session — response body — components financial account transactions
instant_payouts_promotion	Model	Required within parent	Expand Create an Account Session — response body — components instant payouts promotion
issuing_card	Model	Required within parent	Expand Create an Account Session — response body — components issuing card
issuing_cards_list	Model	Required within parent	Expand Create an Account Session — response body — components issuing cards list
notification_banner	Model	Required within parent	Expand Create an Account Session — response body — components account management
payment_details	Model	Required within parent	Expand Create an Account Session — response body — components payments
payment_disputes	Model	Required within parent	Expand Create an Account Session — response body — components payment disputes
payment_method_settings	Model	Required within parent	Expand Create an Account Session — response body — components payment method settings
payments	Model	Required within parent	Expand Create an Account Session — response body — components payments
payout_details	Model	Required within parent	Expand Create an Account Session — response body — components documents
payout_reconciliation_report	Model	Required within parent	Expand Create an Account Session — response body — components documents
payouts	Model	Required within parent	Expand Create an Account Session — response body — components payouts
payouts_list	Model	Required within parent	Expand Create an Account Session — response body — components documents
tax_registrations	Model	Required within parent	Expand Create an Account Session — response body — components documents
tax_settings	Model	Required within parent	Expand Create an Account Session — response body — components documents

Referenced models: Create an Account Session — response body — components account management, Create an Account Session — response body — components documents, Create an Account Session — response body — components payments, Create an Account Session — response body — components financial account, Create an Account Session — response body — components financial account transactions, Create an Account Session — response body — components instant payouts promotion, Create an Account Session — response body — components issuing card, Create an Account Session — response body — components issuing cards list, Create an Account Session — response body — components payment disputes, Create an Account Session — response body — components payment method settings, Create an Account Session — response body — components payouts

Create an Account Session — response body — components account management

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components account management features

Referenced models: Create an Account Session — response body — components account management features

Create an Account Session — response body — components account management features

Field	Type	Presence	Description and constraints
$	object	Root
disable_stripe_user_authentication	boolean	Required within parent	Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
external_account_collection	boolean	Required within parent	Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.

Create an Account Session — response body — components documents

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create a Payment Method — response body — zip

Referenced models: Create a Payment Method — response body — zip

Create an Account Session — response body — components financial account

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components financial account features

Referenced models: Create an Account Session — response body — components financial account features

Create an Account Session — response body — components financial account features

Field	Type	Presence	Description and constraints
$	object	Root
disable_stripe_user_authentication	boolean	Required within parent	Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
external_account_collection	boolean	Required within parent	Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
send_money	boolean	Required within parent	Whether to allow sending money.
transfer_balance	boolean	Required within parent	Whether to allow transferring balance.

Create an Account Session — response body — components financial account transactions

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components financial account transactions features

Referenced models: Create an Account Session — response body — components financial account transactions features

Create an Account Session — response body — components financial account transactions features

Field	Type	Presence	Description and constraints
$	object	Root
card_spend_dispute_management	boolean	Required within parent	Whether to allow card spend dispute management features.

Create an Account Session — response body — components instant payouts promotion

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components instant payouts promotion features

Referenced models: Create an Account Session — response body — components instant payouts promotion features

Create an Account Session — response body — components instant payouts promotion features

Field	Type	Presence	Description and constraints
$	object	Root
disable_stripe_user_authentication	boolean	Required within parent	Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
external_account_collection	boolean	Required within parent	Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
instant_payouts	boolean	Required within parent	Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise.

Create an Account Session — response body — components issuing card

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components issuing card features

Referenced models: Create an Account Session — response body — components issuing card features

Create an Account Session — response body — components issuing card features

Field	Type	Presence	Description and constraints
$	object	Root
card_management	boolean	Required within parent	Whether to allow card management features.
card_spend_dispute_management	boolean	Required within parent	Whether to allow card spend dispute management features.
cardholder_management	boolean	Required within parent	Whether to allow cardholder management features.
spend_control_management	boolean	Required within parent	Whether to allow spend control management features.

Create an Account Session — response body — components issuing cards list

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components issuing cards list features

Referenced models: Create an Account Session — response body — components issuing cards list features

Create an Account Session — response body — components issuing cards list features

Field	Type	Presence	Description and constraints
$	object	Root
card_management	boolean	Required within parent	Whether to allow card management features.
card_spend_dispute_management	boolean	Required within parent	Whether to allow card spend dispute management features.
cardholder_management	boolean	Required within parent	Whether to allow cardholder management features.
disable_stripe_user_authentication	boolean	Required within parent	Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
spend_control_management	boolean	Required within parent	Whether to allow spend control management features.

Create an Account Session — response body — components payment disputes

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components payment disputes features

Referenced models: Create an Account Session — response body — components payment disputes features

Create an Account Session — response body — components payment disputes features

Field	Type	Presence	Description and constraints
$	object	Root
destination_on_behalf_of_charge_management	boolean	Required within parent	Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
dispute_management	boolean	Required within parent	Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
refund_management	boolean	Required within parent	Whether sending refunds is enabled. This is `true` by default.
smart_disputes_management	boolean	Required within parent	Whether to allow connected accounts to submit disputes using Smart Disputes. Defaults to the value of `dispute_management`.

Create an Account Session — response body — components payment method settings

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components payment method settings features

Referenced models: Create an Account Session — response body — components payment method settings features

Create an Account Session — response body — components payment method settings features

Field	Type	Presence	Description and constraints
$	object	Root
disable_stripe_user_authentication	boolean	Required within parent	Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. This is `false` by default.

Create an Account Session — response body — components payments

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components payments features

Referenced models: Create an Account Session — response body — components payments features

Create an Account Session — response body — components payments features

Field	Type	Presence	Description and constraints
$	object	Root
capture_payments	boolean	Required within parent	Whether to allow capturing and cancelling payment intents. This is `true` by default.
destination_on_behalf_of_charge_management	boolean	Required within parent	Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
dispute_management	boolean	Required within parent	Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
refund_management	boolean	Required within parent	Whether sending refunds is enabled. This is `true` by default.
smart_disputes_management	boolean	Required within parent	Whether to allow connected accounts to submit disputes using Smart Disputes. Defaults to the value of `dispute_management`.

Create an Account Session — response body — components payouts

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether the embedded component is enabled.
features	Model	Required within parent	Expand Create an Account Session — response body — components payouts features

Referenced models: Create an Account Session — response body — components payouts features

Create an Account Session — response body — components payouts features

Field	Type	Presence	Description and constraints
$	object	Root
disable_stripe_user_authentication	boolean	Required within parent	Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
edit_payout_schedule	boolean	Required within parent	Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
external_account_collection	boolean	Required within parent	Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
instant_payouts	boolean	Required within parent	Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise.
standard_payouts	boolean	Required within parent	Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.