Customer Points Product object - Smile.io Developer Documentation

{
  "name": "$5 off coupon",
  "pointsPrice": "500",
  "pointsProduct": {
    "id": 123,
    "exchangeType": "variable",
    "exchangeDescription": "100 Points = $1 off",
    "pointsPrice": null,
    "variablePointsStep": 100,
    "variablePointsStepRewardValue": 1,
    "variablePointsMin": 100,
    "variablePointsMax": 5000,
    "reward": {
      "id": 924565472,
      "name": "Order discount",
      "description": "Applies to one-time purchases.",
      "imageUrl": "https://platform-images.smilecdn.co/3755938.png",
      "createdAt": "2024-04-04T15:10:42.030Z",
      "updatedAt": "2024-04-04T15:10:42.030Z"
    },
    "createdAt": "2024-04-04T15:10:42.030Z",
    "updatedAt": "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. Customer points products can be preloaded.

name

string

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

Example:

"$5 off coupon"

pointsPrice

integer

Number of points needed to purchase this reward.

Example:

"500"

pointsProduct

object

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

Show child attributes

Logout the customer

Get customer points products

⌘I