Customer points product object - Smile.io Developer Documentation

{
  "name": "$5 off coupon",
  "points_price": "500",
  "points_product": {
    "id": 123,
    "exchange_type": "variable",
    "exchange_description": "100 Points = $1 off",
    "points_price": null,
    "variable_points_step": 100,
    "variable_points_step_reward_value": 1,
    "variable_points_min": 100,
    "variable_points_max": 5000,
    "reward": {
      "id": 924565472,
      "name": "Order discount",
      "description": "Applies to one-time purchases.",
      "image_url": "https://platform-images.smilecdn.co/3755938.png",
      "created_at": "2024-04-04T15:10:42.030Z",
      "updated_at": "2024-04-04T15:10:42.030Z"
    },
    "created_at": "2024-04-04T15:10:42.030Z",
    "updated_at": "2024-04-04T15:10:42.030Z"
  }
}

A customer points product is a version of a points product that is specific to the currently logged-in customer. It handles the logic of dealing with fixed vs. variable reward types and represents a specific reward that the customer can redeem their points for.

name

string

Name of the reward that the customer will receive when their points are redeemed.

Example:

"$5 off coupon"

points_price

integer

Number of points needed to purchase this reward.

Example:

"500"

points_product

object

A nested Points Product object representing the points product that this reward is based on.

Show child attributes

Customer object

Points product object

⌘I

Documentation Index