Skip to main content
Points products are rewards that customers can redeem points for. They can be fixed (a specific dollar amount off) or variable (imagine a slider where every 100 Points is an additional dollar off). Points products can be preloaded.
​
id
integer

Unique identifier for the points product.

​
exchangeType
enum<string>

How points are exchanged for the reward. Possible values:

  • fixed - Customer must spend a fixed amount of points for a predetermined reward value.
  • variable - Customer can spend a variable amount of points for a dynamic reward value.
Available options:
fixed,
variable
Example:

"variable"

​
exchangeDescription
string

A human readable description of how a customer spends points on this reward. It includes the points branding for the program.

Example:

"100 Points = $1 off"

​
pointsPrice
integer | null

Number of points needed to purchase this reward. Only present when exchangeType is fixed.

Example:

null

​
variablePointsStep
integer | null

Imagine there's a points slider your customers can drag to spend more or less points on a reward. The variablePointsStep represents the number of points between each notch on the slider. E.g. If this value is set to 100, it means customers can spend their points in increments of 100. They will drag the slider from 100, 200, 300, etc. Only present when exchangeType is variable.

Example:

100

​
variablePointsStepRewardValue
integer | null

Imagine there's a points slider your customers can drag to spend more or less points on a reward. The variablePointsStepRewardValue represents the corresponding reward value for each step increment on the slider. E.g. if this value is set to 1, and the variablePointsStep is set to 100, the customer will get $1 off for every 100 points they spend. Only present when exchangeType is variable.

Example:

1

​
variablePointsMin
integer | null

The minimum amount of points the customer must spend to get this reward. Only present when exchangeType is variable.

Example:

100

​
variablePointsMax
integer | null

The maximum amount of points the customer can spend on this reward. Only present when exchangeType is variable.

Example:

5000

​
reward
object

A nested Reward object representing the reward issued to the customer when they purchase the points product.

​
createdAt
string<date-time>

The date and time when the points product was created.

Example:

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

​
updatedAt
string<date-time>

The date and time when the points product was last updated.

Example:

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