Skip to main content

Update customer

POST 
/customers/:id

Update customer.

Authorization Action:

pay:customers:update

Request​

Path Parameters

    id stringrequired

Body

required
    address object
    city string
    country string

    Two-letter country code (ISO 3166-1 alpha-2).

    line1 string

    Address line 1 (e.g., street, block, PO Box, or company name).

    line2 string

    Address line 2 (e.g., apartment, suite, unit, or building).

    postal_code string

    ZIP or postal code.

    state string

    State, county, province, prefecture, or region.

    description string
    email string
    invoice_prefix string

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

    next_invoice_sequence number

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

    name string
    phone string
    preferred_locales string[]
    tax_exempt string

    Possible values: [exempt, none, reverse]

    expand string[]

    Specifies which fields in the response should be expanded.

Responses​

Schema
    address object
    city string
    country string

    Two-letter country code (ISO 3166-1 alpha-2).

    line1 string

    Address line 1 (e.g., street, block, PO Box, or company name).

    line2 string

    Address line 2 (e.g., apartment, suite, unit, or building).

    postal_code string

    ZIP or postal code.

    state string

    State, county, province, prefecture, or region.

    delinquent booleanrequired

    When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice isn't paid by its due date.

    email string

    The customer's email address.

    name string

    The customer's full name or business name.

    phone string

    The customer's phone number.

    subscriptions object

    The customer's current subscriptions, if any.

    id stringrequired

    Unique identifier for the object.

    created numberrequired

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

Loading...