Mayson Monorepo Documentation
    Preparing search index...

    A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products.

    interface Account {
        id: string;
        object: "v2.core.account";
        applied_configurations: Stripe.V2.Core.Account.AppliedConfiguration[];
        closed?: boolean;
        configuration?: Stripe.V2.Core.Account.Configuration;
        contact_email?: string;
        contact_phone?: string;
        created: string;
        dashboard?: Stripe.V2.Core.Account.Dashboard;
        defaults?: Stripe.V2.Core.Account.Defaults;
        display_name?: string;
        future_requirements?: Stripe.V2.Core.Account.FutureRequirements;
        identity?: Stripe.V2.Core.Account.Identity;
        livemode: boolean;
        metadata?: Metadata;
        requirements?: Stripe.V2.Core.Account.Requirements;
    }
    Index

    Properties

    id: string

    Unique identifier for the Account.

    object: "v2.core.account"

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

    applied_configurations: Stripe.V2.Core.Account.AppliedConfiguration[]

    The configurations that have been applied to this account.

    closed?: boolean

    Indicates whether the account has been closed.

    An Account represents a company, individual, or other entity that a user interacts with. Accounts store identity information and one or more configurations that enable product-specific capabilities. You can assign configurations at creation or add them later.

    contact_email?: string

    The default contact email address for the Account. Required when configuring the account as a merchant or recipient.

    contact_phone?: string

    The default contact phone for the Account.

    created: string

    Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

    A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.

    Default values for settings shared across Account configurations.

    display_name?: string

    A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.

    future_requirements?: Stripe.V2.Core.Account.FutureRequirements

    Information about the future requirements for the Account that will eventually come into effect, including what information needs to be collected, and by when.

    Information about the company, individual, and business represented by the Account.

    livemode: boolean

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

    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.

    Information about the active requirements for the Account, including what information needs to be collected, and by when.