Mayson Monorepo Documentation
    Preparing search index...

    Interface CustomerCreateParams

    interface CustomerCreateParams {
        address?: Emptyable<AddressParam>;
        balance?: number;
        business_name?: string;
        cash_balance?: Stripe.CustomerCreateParams.CashBalance;
        description?: string;
        email?: string;
        expand?: string[];
        individual_name?: string;
        invoice_prefix?: string;
        invoice_settings?: Stripe.CustomerCreateParams.InvoiceSettings;
        metadata?: Emptyable<MetadataParam>;
        name?: string;
        next_invoice_sequence?: number;
        payment_method?: string;
        phone?: string;
        preferred_locales?: string[];
        shipping?: Emptyable<Stripe.CustomerCreateParams.Shipping>;
        source?: string;
        tax?: Stripe.CustomerCreateParams.Tax;
        tax_exempt?: Emptyable<Stripe.CustomerCreateParams.TaxExempt>;
        tax_id_data?: Stripe.CustomerCreateParams.TaxIdDatum[];
        test_clock?: string;
        validate?: boolean;
    }
    Index

    Properties

    The customer's address. Learn about country-specific requirements for calculating tax.

    balance?: number

    An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.

    business_name?: string

    The customer's business name. This may be up to 150 characters.

    Balance information and default balance settings for this customer.

    description?: string

    An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

    email?: string

    Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    individual_name?: string

    The customer's full name. This may be up to 150 characters.

    invoice_prefix?: string

    The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

    Default invoice settings for this customer.

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    name?: string

    The customer's full name or business name.

    next_invoice_sequence?: number

    The sequence to be used on the customer's next invoice. Defaults to 1.

    payment_method?: string
    phone?: string

    The customer's phone number.

    preferred_locales?: string[]

    Customer's preferred languages, ordered by preference.

    The customer's shipping information. Appears on invoices emailed to this customer.

    source?: string

    Tax details about the customer.

    The customer's tax exemption. One of none, exempt, or reverse.

    The customer's tax IDs.

    test_clock?: string

    ID of the test clock to attach to the customer.

    validate?: boolean