Skip to main content
Customers represent individuals in the loyalty program. They have a points balance, can earn points by performing activities, and can redeem points for rewards.
​
id
integer

Unique identifier for the customer in Smile.

Example:

304169228

​
first_name
string

The customer's first name.

Example:

"Jane"

​
last_name
string

The customer's last name.

Example:

"Doe"

​
email
string

The customer's email address.

Example:

"[email protected]"

​
state
string

The customer's state in the loyalty program. Possible values:

  • candidate - An individual that has not yet joined the loyalty program. Depending on program settings, they may or may not earn points.
  • member - An active loyalty program participant.
  • disabled - An individual that has been excluded from the program and cannot earn or redeem rewards.
Example:

"member"

​
date_of_birth
string

The customer's birthday. A year value of 1004 means only the customer's birth day and month is available.

Example:

"1004-05-27"

​
points_balance
integer

The customer's current points balance.

Example:

100

​
referral_url
string

The customer's unique referral URL. Used to share with friends as part of the referral program.

Example:

"http://i.refs.cc/9qr5Pw"

​
vip_tier
object

A nested VIP Tier object representing the customer's current VIP tier.

Note: This object is not included by default and must be explicitly requested using the include parameter when reloading the customer.

​
created_at
string<date-time>

The date and time when the customer was created.

Example:

"2024-04-04T15:10:42.030Z"

​
updated_at
string<date-time>

The date and time when the customer was last updated.

Example:

"2024-04-04T15:10:42.030Z"