Mayson Monorepo Documentation
    Preparing search index...

    This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

    For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned.

    For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

    interface Account {
        id: string;
        object: "account";
        business_profile?: Stripe.Account.BusinessProfile;
        business_type?: Stripe.Account.BusinessType;
        capabilities?: Stripe.Account.Capabilities;
        charges_enabled: boolean;
        company?: Stripe.Account.Company;
        controller?: Stripe.Account.Controller;
        country?: string;
        created?: number;
        default_currency?: string;
        deleted?: void;
        details_submitted: boolean;
        email: string;
        external_accounts?: ApiList<Stripe.ExternalAccount>;
        future_requirements?: Stripe.Account.FutureRequirements;
        groups?: Stripe.Account.Groups;
        individual?: Stripe.Person;
        metadata?: Metadata;
        payouts_enabled: boolean;
        requirements?: Stripe.Account.Requirements;
        settings?: Stripe.Account.Settings;
        tos_acceptance?: Stripe.Account.TosAcceptance;
        type: Stripe.Account.Type;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "account"

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

    business_profile?: Stripe.Account.BusinessProfile

    Business information about the account.

    business_type?: Stripe.Account.BusinessType

    The business type.

    capabilities?: Stripe.Account.Capabilities
    charges_enabled: boolean

    Whether the account can process charges.

    country?: string

    The account's country.

    created?: number

    Time at which the account was connected. Measured in seconds since the Unix epoch.

    default_currency?: string

    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.

    deleted?: void

    Always true for a deleted object

    details_submitted: boolean

    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 to finish submitting account details.

    email: string

    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.

    external_accounts?: ApiList<Stripe.ExternalAccount>

    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.

    future_requirements?: Stripe.Account.FutureRequirements

    The groups associated with the account.

    individual?: Stripe.Person

    This is an object representing a person associated with a Stripe account.

    A platform can only access a subset of data in a person for an account where account.controller.requirement_collection is stripe, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

    See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.

    metadata?: Metadata

    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.

    payouts_enabled: boolean

    Whether the funds in this account can be paid out.

    requirements?: Stripe.Account.Requirements

    Options for customizing how the account functions within Stripe.

    tos_acceptance?: Stripe.Account.TosAcceptance

    The Stripe account type. Can be standard, express, custom, or none.