Mayson Monorepo Documentation
    Preparing search index...

    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

    interface AccountSession {
        object: "account_session";
        account: string;
        client_secret: string;
        components: Stripe.AccountSession.Components;
        expires_at: number;
        livemode: boolean;
    }
    Index

    Properties

    object: "account_session"

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

    account: string

    The ID of the account the AccountSession was created for

    client_secret: string

    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.

    expires_at: number

    The timestamp at which this AccountSession will expire.

    livemode: boolean

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