Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers.
LoyaltyProgramRewardTier
Name | Type | Tags | Description |
---|---|---|---|
id |
string |
Required | The Square-assigned ID of the reward tier. Constraints: Minimum Length: 1 , Maximum Length: 36 |
points |
number |
Required | The points exchanged for the reward tier. Constraints: >= 1 |
name |
string |
Required | The name of the reward tier. Constraints: Minimum Length: 1 |
definition |
LoyaltyProgramRewardDefinition |
Required | Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see Getting discount details for a reward tier. |
createdAt |
string |
Required | The timestamp when the reward tier was created, in RFC 3339 format. |
pricingRuleReference |
CatalogObjectReference | undefined |
Optional | A reference to a Catalog object at a specific version. In general this is used as an entry point into a graph of catalog objects, where the objects exist at a specific version. |
{
"definition": {
"scope": "ORDER",
"discount_type": "FIXED_AMOUNT",
"fixed_discount_money": null,
"max_discount_money": null
},
"pricing_rule_reference": null
}