Mayson Monorepo Documentation
    Preparing search index...

    This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

    interface Customer {
        id: string;
        object: "customer";
        address?: Stripe.Address;
        balance: number;
        business_name?: string;
        cash_balance?: Stripe.CashBalance;
        created: number;
        currency?: string;
        customer_account?: string;
        default_source: string | CustomerSource;
        deleted?: void;
        delinquent?: boolean;
        description: string;
        discount?: Stripe.Discount;
        email: string;
        individual_name?: string;
        invoice_credit_balance?: { [key: string]: number };
        invoice_prefix?: string;
        invoice_settings: Stripe.Customer.InvoiceSettings;
        livemode: boolean;
        metadata: Metadata;
        name?: string;
        next_invoice_sequence?: number;
        phone?: string;
        preferred_locales?: string[];
        shipping: Stripe.Customer.Shipping;
        sources?: ApiList<CustomerSource>;
        subscriptions?: ApiList<Stripe.Subscription>;
        tax?: Stripe.Customer.Tax;
        tax_exempt?: Stripe.Customer.TaxExempt;
        tax_ids?: ApiList<Stripe.TaxId>;
        test_clock?: string | Stripe.TestHelpers.TestClock;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "customer"

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

    address?: Stripe.Address

    The customer's address.

    balance: number

    The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see invoice_credit_balance.

    business_name?: string

    The customer's business name.

    cash_balance?: Stripe.CashBalance

    The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The settings[reconciliation_mode] field describes if these funds apply to these payment intents manually or automatically.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    currency?: string

    Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

    customer_account?: string

    The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.

    default_source: string | CustomerSource

    ID of the default payment source for the customer.

    If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

    deleted?: void

    Always true for a deleted object

    delinquent?: boolean

    Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the invoice.due_date will set this field to true.

    If an invoice becomes uncollectible by dunning, delinquent doesn't reset to false.

    If you care whether the customer has paid their most recent subscription invoice, use subscription.status instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to false.

    description: string

    An arbitrary string attached to the object. Often useful for displaying to users.

    discount?: Stripe.Discount

    Describes the current discount active on the customer, if there is one.

    email: string

    The customer's email address.

    individual_name?: string

    The customer's individual name.

    invoice_credit_balance?: { [key: string]: number }

    The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.

    invoice_prefix?: string

    The prefix for the customer used to generate unique invoice numbers.

    invoice_settings: Stripe.Customer.InvoiceSettings
    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.

    name?: string

    The customer's full name or business name.

    next_invoice_sequence?: number

    The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.

    phone?: string

    The customer's phone number.

    preferred_locales?: string[]

    The customer's preferred locales (languages), ordered by preference.

    Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

    The customer's payment sources, if any.

    subscriptions?: ApiList<Stripe.Subscription>

    The customer's current subscriptions, if any.

    Describes the customer's tax exemption status, which is none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the following text: "Reverse charge".

    tax_ids?: ApiList<Stripe.TaxId>

    The customer's tax IDs.

    test_clock?: string | Stripe.TestHelpers.TestClock

    ID of the test clock that this customer belongs to.