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).
​
id
integer

Unique identifier for the points product.

Example:

132456921

​
exchange_type
enum<string>

How points are exchanged for the reward.

Available options:
fixed,
variable
Example:

"variable"

​
exchange_description
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"

​
points_price
integer

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

​
variable_points_step
integer

Imagine there's a points slider your customers can drag to spend more or less points on a reward. The variable_points_step 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 exchange_type is variable.

Example:

100

​
variable_points_step_reward_value
integer

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

Example:

1

​
variable_points_min
integer

The minimum amount of points the customer must spend to get this reward. Normally the minimum value of the points slider. Only present when exchange_type is variable.

Example:

100

​
variable_points_max
integer

The maximum amount of points the customer must spend to get this reward. Normally the maximum value of the points slider. Only present when exchange_type is variable.

Example:

5000

​
reward
object

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

​
created_at
string<date-time>

The date and time when the points product was created.

Example:

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

​
updated_at
string<date-time>

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

Example:

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