Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

affiliation_expires_at
integer | null

Time at which the affiliation will expire.

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.

first_name
string | null

The customer’s first name.

live_mode
boolean

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

last_name
string | null

The customer’s last name.

name
string | null

The customer’s full name or business name. If set, this will take precedence over the separate first_name and last_name attributes.

phone
string | null

The customer’s phone number.

tax_enabled
boolean

Whether or not tax should be calculated for checkouts associated with this customer.

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.

affiliation

Expandable – The associated affiliation ID.

balances

Expandable – Property not returned unless expanded.

billing_address

Expandable – The associated address ID.

default_payment_method

Expandable – The associated payment method ID.

licenses

Expandable – Property not returned unless expanded.

portal_url
string | null

A URL that will redirect to this customer's correct portal page (hosted or external).

purchases

Expandable – Property not returned unless expanded.

shipping_address

Expandable – The associated address ID.

tax_identifier

Expandable – The associated tax identifier ID.

reviews

Expandable – Property not returned unless expanded.

created_at
integer | null

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

updated_at
integer | null

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