Skip to main content

Create

Creates a new customer.

Model Attributes

billing_matches_shipping boolean

If set to `true` the shipping address will be used for the billing address.

email string

The customer’s email address.

live_mode boolean

Set to `true` if this customer is in live mode, and set to `false` if it is in test mode.

name string

The customer’s full name or business name.

phone string

The customer’s phone number.

unsubscribed boolean

Set to `true` if this customer has unsubscribed from from opt-in emails (i.e. abandoned cart emails).

billing_address

The billing address for the customer.

default_payment_method string

The UUID of the default payment method.

shipping_address

The shipping address for the customer.

tax_identifier

The tax identifier to set for this customer.

Response Attributes

id string

The UUID of the specific object.

object string

A string describing the object type returned.

billing_matches_shipping boolean

If set to `true` the shipping address will be used for the billing address.

email string

The customer’s email address.

live_mode boolean

Set to `true` if this customer is in live mode, and set to `false` if it is in test mode.

name string

The customer’s full name or business name.

phone string

The customer’s phone number.

unsubscribed boolean

Set to `true` if this customer has unsubscribed from from opt-in emails (i.e. abandoned cart emails).

indexed boolean

Whether or not this customer is included in the `/customers` list endpoint. Only customers that have been manually created or have a purchase are indexed.

balances expandable

A list of this customer's balances.

billing_address expandable

The billing address for the customer.

default_payment_method expandable

The default payment method for the customer.

licenses expandable

A list of this customer's licenses.

purchases expandable

A list of this customer's purchases.

shipping_address expandable

The shipping address for the customer.

tax_identifier expandable

The associated tax identifier.

created_at integer

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

updated_at integer

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