Skip to main content
An earning rule represents an action that can be completed by a customer to earn a reward. Common examples include earning a dynamic number of points per dollar spent for placing an order, or earning a fixed number of points for following or liking a social media account.
​
id
integer

Unique identifier for the earning rule.

Example:

739246764

​
name
string

The display name of the earning rule.

Example:

"Place an order"

​
image_url
string

The image of the earning rule.

Example:

"https://platform.smile.io/images/earning/order-online.svg"

​
action_text
string

The label for a clickable element (e.g. a call to action) that allows the customer to complete the rewardable action. When null, no clickable element should be displayed.

Example:

null

​
action_url
string

The destination URL for a clickable element (e.g. a call to action) that allows the customer to complete the rewardable action. When null, no clickable element should be displayed.

Example:

null

​
restricted_to_vip_tier_ids
object[]

A list of VIP tier IDs. When present, the earning rule only applies to customers who currently belong to at least one of the specified VIP tiers. If empty, the earning rule applies to all VIP tiers.

​
reward
object

The reward that will be issued to the customer when the rewardable action is completed.

​
reward_value
object

The value of the reward that will be issued to the customer when the rewardable action is completed.

​
earning_limit
object

A restriction on the number of times the rewardable action can be completed. If no limit exists, will be null.