Retrieve

get https://{defaultHost}/v1/customers/{id}

Retrieves details of a specific customer.

Response

Response body

object

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.

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

object | null

The affiliation associated with this customer.

Has additional fields

balances

object | null

A list of this customer's balances.

Has additional fields

billing_address

string | null

The billing address for the customer.

default_payment_method

string | null

The default payment method for the customer.

licenses

object | null

A list of this customer's licenses.

Has additional fields

portal_url

string | null

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

purchases

object | null

A list of this customer's purchases.

Has additional fields

shipping_address

string | null

The shipping address for the customer.

tax_identifier

string | null

The associated tax identifier.

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.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.surecart.com/v1/customers/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success