The Account Session object

Connect

Account Session

Attributes

accountstring
The ID of the account the AccountSession was created for

client_secretstring
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 and learn about how client_secret should be handled.

componentsobject
Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
- components.account_managementobject
  Configuration for the account management embedded component.
  components.account_management.enabledboolean
  Whether the embedded component is enabled.
  components.account_management.featuresobject
  The list of features enabled in the embedded component.
  components.account_management.features.external_account_collectionboolean
  Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is true.
- components.account_onboardingobject
  Configuration for the account onboarding embedded component.
  components.account_onboarding.enabledboolean
  Whether the embedded component is enabled.
  components.account_onboarding.featuresobject
  The list of features enabled in the embedded component.
  components.account_onboarding.features.external_account_collectionboolean
  Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is true.
- components.balancesobject
  Configuration for the balances embedded component.
  components.balances.enabledboolean
  Whether the embedded component is enabled.
  components.balances.featuresobject
  The list of features enabled in the embedded component.
  components.balances.features.edit_payout_scheduleboolean
  Whether to allow payout schedule to be changed. Default true when Stripe owns Loss Liability, default false otherwise.
  components.balances.features.external_account_collectionboolean
  Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is true.
  components.balances.features.instant_payoutsboolean
  Whether to allow creation of instant payouts. Default true when Stripe owns Loss Liability, default false otherwise.
  components.balances.features.standard_payoutsboolean
  Whether to allow creation of standard payouts. Default true when Stripe owns Loss Liability, default false otherwise.
- components.documentsobject
  Configuration for the documents embedded component.
  components.documents.enabledboolean
  Whether the embedded component is enabled.
  components.documents.featuresobject
  The list of features enabled in the embedded component.
- components.notification_bannerobject
  Configuration for the notification banner embedded component.
  components.notification_banner.enabledboolean
  Whether the embedded component is enabled.
  components.notification_banner.featuresobject
  The list of features enabled in the embedded component.
  components.notification_banner.features.external_account_collectionboolean
  Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is true.
- components.payment_detailsobject
  Configuration for the payment details embedded component.
  components.payment_details.enabledboolean
  Whether the embedded component is enabled.
  components.payment_details.featuresobject
  The list of features enabled in the embedded component.
  components.payment_details.features.capture_paymentsboolean
  Whether to allow capturing and cancelling payment intents. This is true by default.
  components.payment_details.features.destination_on_behalf_of_charge_managementboolean
  Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is false by default.
  components.payment_details.features.dispute_managementboolean
  Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is true by default.
  components.payment_details.features.refund_managementboolean
  Whether to allow sending refunds. This is true by default.
- components.paymentsobject
  Configuration for the payments embedded component.
  components.payments.enabledboolean
  Whether the embedded component is enabled.
  components.payments.featuresobject
  The list of features enabled in the embedded component.
  components.payments.features.capture_paymentsboolean
  Whether to allow capturing and cancelling payment intents. This is true by default.
  components.payments.features.destination_on_behalf_of_charge_managementboolean
  Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is false by default.
  components.payments.features.dispute_managementboolean
  Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is true by default.
  components.payments.features.refund_managementboolean
  Whether to allow sending refunds. This is true by default.
- components.payoutsobject
  Configuration for the payouts embedded component.
  components.payouts.enabledboolean
  Whether the embedded component is enabled.
  components.payouts.featuresobject
  The list of features enabled in the embedded component.
  components.payouts.features.edit_payout_scheduleboolean
  Whether to allow payout schedule to be changed. Default true when Stripe owns Loss Liability, default false otherwise.
  components.payouts.features.external_account_collectionboolean
  Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is true.
  components.payouts.features.instant_payoutsboolean
  Whether to allow creation of instant payouts. Default true when Stripe owns Loss Liability, default false otherwise.
  components.payouts.features.standard_payoutsboolean
  Whether to allow creation of standard payouts. Default true when Stripe owns Loss Liability, default false otherwise.
- components.payouts_listobject
  Configuration for the payouts list embedded component.
  components.payouts_list.enabledboolean
  Whether the embedded component is enabled.
  components.payouts_list.featuresobject
  The list of features enabled in the embedded component.
- components.tax_registrationsobject
  Configuration for the tax registrations embedded component.
  components.tax_registrations.enabledboolean
  Whether the embedded component is enabled.
  components.tax_registrations.featuresobject
  The list of features enabled in the embedded component.
- components.tax_settingsobject
  Configuration for the tax settings embedded component.
  components.tax_settings.enabledboolean
  Whether the embedded component is enabled.
  components.tax_settings.featuresobject
  The list of features enabled in the embedded component.

expires_attimestamp
The timestamp at which this AccountSession will expire.

More attributes

objectstring
String representing the object’s type. Objects of the same type share the same value.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

The Account Session object

{
  "object": "account_session",
  "account": "acct_1NkDjjJyhOZfPCWt",
  "client_secret": "_OXIKXxEihJokDBnDoe2sgG5OGSO2Q12shKvbeboxpALZGng",
  "expires_at": 1693261123,
  "livemode": false,
  "components": {
    "account_management": {
      "enabled": false,
      "features": {
        "external_account_collection": true
      }
    },
    "account_onboarding": {
      "enabled": true,
      "features": {
        "external_account_collection": true
      }
    },
    "balances": {
      "enabled": true,
      "features": {
        "edit_payout_schedule": false,
        "instant_payouts": false,
        "standard_payouts": false,
        "external_account_collection": true
      }
    },
    "documents": {
      "enabled": false,
      "features": {}
    },
    "notification_banner": {
      "enabled": false,
      "features": {
        "external_account_collection": true
      }
    },
    "payment_details": {
      "enabled": false,
      "features": {
        "capture_payments": true,
        "destination_on_behalf_of_charge_management": false,
        "dispute_management": true,
        "refund_management": true
      }
    },
    "payments": {
      "enabled": true,
      "features": {
        "capture_payments": true,
        "destination_on_behalf_of_charge_management": false,
        "dispute_management": true,
        "refund_management": true
      }
    },
    "payouts": {
      "enabled": true,
      "features": {
        "edit_payout_schedule": false,
        "instant_payouts": false,
        "standard_payouts": false,
        "external_account_collection": true
      }
    },
    "payouts_list": {
      "enabled": false,
      "features": {}
    },
    "tax_registrations": {
      "enabled": false,
      "features": {}
    },
    "tax_settings": {
      "enabled": false,
      "features": {}
    }
  }
}

The Account Session object

Attributes

accountstring

client_secretstring

componentsobject

components.account_managementobject

components.account_management.enabledboolean

components.account_management.featuresobject

components.account_management.features.external_account_collectionboolean

components.account_onboardingobject

components.account_onboarding.enabledboolean

components.account_onboarding.featuresobject

components.account_onboarding.features.external_account_collectionboolean

components.balancesobject

components.balances.enabledboolean

components.balances.featuresobject

components.balances.features.edit_payout_scheduleboolean

components.balances.features.external_account_collectionboolean

components.balances.features.instant_payoutsboolean

components.balances.features.standard_payoutsboolean

components.documentsobject

components.documents.enabledboolean

components.documents.featuresobject

components.notification_bannerobject

components.notification_banner.enabledboolean

components.notification_banner.featuresobject

components.notification_banner.features.external_account_collectionboolean

components.payment_detailsobject

components.payment_details.enabledboolean

components.payment_details.featuresobject

components.payment_details.features.capture_paymentsboolean

components.payment_details.features.destination_on_behalf_of_charge_managementboolean

components.payment_details.features.dispute_managementboolean

components.payment_details.features.refund_managementboolean

components.paymentsobject

components.payments.enabledboolean

components.payments.featuresobject

components.payments.features.capture_paymentsboolean

components.payments.features.destination_on_behalf_of_charge_managementboolean

components.payments.features.dispute_managementboolean

components.payments.features.refund_managementboolean

components.payoutsobject

components.payouts.enabledboolean

components.payouts.featuresobject

components.payouts.features.edit_payout_scheduleboolean

components.payouts.features.external_account_collectionboolean

components.payouts.features.instant_payoutsboolean

components.payouts.features.standard_payoutsboolean

components.payouts_listobject

components.payouts_list.enabledboolean

components.payouts_list.featuresobject

components.tax_registrationsobject

components.tax_registrations.enabledboolean

components.tax_registrations.featuresobject

components.tax_settingsobject

components.tax_settings.enabledboolean

components.tax_settings.featuresobject

expires_attimestamp

More attributesCollapse all

objectstring

livemodeboolean

More attributes