Customer object
The customer object contains basic information (e.g. first name), loyalty program information (e.g. points balance), and if applicable, VIP program information (e.g. current VIP tier).| Attribute | Description |
|---|---|
email | The customer’s email address. |
first_name | The customer’s first name. |
next_vip_tier | A VIP Tier object. The next VIP tier the customer will achieve after meeting required criteria, if any. |
points_balance | The number of points the customer currently has. (e.g. 250) |
points_balance_formatted | The number of points and the points currency. (e.g. 250 Points) |
referral_url | The customer’s unique referral URL. |
vip_milestone_description | An explanation of what the customer needs to accomplish to move into the next VIP tier. (e.g. Earn 250 Points by Dec 31, 2020 to reach Gold.) |
vip_tier | A VIP Tier object. The customer’s current VIP tier, if any. |
Reward object
The reward object contains basic details about a reward.| Attribute | Description |
|---|---|
name | The name of the reward. |
Reward fulfillment object
The reward fulfillment object contains information about the reward a customer has just unlocked.| Attribute | Description |
|---|---|
action_text | The action text associated with using a reward, if any. (e.g. Use your reward) |
action_url | The action URL associated with using a reward, if any. |
code | The code required for the customer to use this reward, if any. |
expires_at_formatted | The human readable date for when a reward will expire, if any. (e.g. Dec 31, 2020) |
name | The name of the reward given to the customer. (e.g. $10 Off Coupon) |
source_description | What the customer did to achieve this reward. (e.g. Spent 100 Points) |
usage_instructions | Instructions that describe how to use the reward, if any. |
terms_and_conditions | The terms and conditions associated with the reward fulfillment. |
VIP tier object
The VIP tier object contains information about a customers current or future VIP tier status.| Attribute | Description |
|---|---|
id | The ID of the VIP tier. |
name | The name of the VIP tier. (e.g. Gold) |