| Attribute | Description |
|---|---|
id | The unique identifier for the points product. |
exchange_type | Indicates how points are exchanged for the reward. Either fixed or variable. If the customer must spend a fixed amount of points for a predetermined reward value, the exchange type is fixed. If the customer can spend a variable amount of points for a dynamic reward value, the exchange type is variable. |
exchange_description | A human readable description of how a customer spends points on this reward. It includes the points branding for the program. E.g. “500 Gold Points”. |
points_price | Number of points needed to purchase this reward. Only present when exchange_type is fixed. |
variable_points_step | 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. |
variable_points_step_reward_value | 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. |
variable_points_min | 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. |
variable_points_max | The maximum amount of points the customer can spend on this reward. Normally the maximum value of the points slider. Only present when exchange_type is variable. |
reward | The Reward given to the customer when they purchase this points product. |
created_at | Date and time at which the points product was created. |
updated_at | Date and time at which the points product was updated. |
Other objects
Points product object
Points products are rewards that customers can redeem points for. They can be fixed (1 off).