Customer object

{
  "id": 304169228,
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@doe.com",
  "state": "member",
  "date_of_birth": "1004-05-27",
  "points_balance": 300,
  "referral_url": "http://i.refs.cc/9qr5Pw",
  "vip_tier_id": 426715794,
  "vip_status": {
    "vip_tier_id": 426715794,
    "vip_tier_expires_at": "2026-12-31T23:59:59.999Z",
    "progress_value": 300,
    "current_vip_period_end": "2025-12-31T23:59:59.999Z",
    "delta_to_retain_vip_tier": 123,
    "next_vip_tier_id": 426715799,
    "delta_to_next_vip_tier": 200
  },
  "created_at": "2024-04-04T15:10:42.030Z",
  "updated_at": "2025-04-04T15:10:42.030Z"
}

Customers represent individuals in the loyalty program. They have a points balance, can earn points by performing activities, and can redeem points for rewards.

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"

string

The customer's email address.

Example:

"jane@doe.com"

state

enum<string>

The customer's state in the loyalty program.

Available options:

candidate,

member,

disabled

Example:

"member"

date_of_birth

string<date>

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

Example:

"1004-05-27"

points_balance

integer

The customer's current points balance.

Example:

300

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_id

integer

deprecated

The ID of the customer's current VIP tier. This field is now deprecated, use the nested vip_status.vip_tier_id instead.

Example:

426715794

vip_status

object

An object containing details about the customer's status within the VIP program.

Show child attributes

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:

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

Create an activity

List customers

⌘I

REST API

API resources