loyalty-program-reward-tier.md

Loyalty Program Reward Tier

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.

Structure

Loyalty Program Reward Tier

Fields

Name	Type	Tags	Description
id	str	Optional	The Square-assigned ID of the reward tier. Constraints: Maximum Length: 36
points	int	Required	The points exchanged for the reward tier. Constraints: >= 1
name	str	Optional	The name of the reward tier.
definition	Loyalty Program Reward Definition	Optional	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.
created_at	str	Optional	The timestamp when the reward tier was created, in RFC 3339 format.
pricing_rule_reference	Catalog Object Reference	Required	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.

Example (as JSON)

{
  "id": "id2",
  "points": 94,
  "name": "name2",
  "definition": {
    "scope": "ORDER",
    "discount_type": "FIXED_AMOUNT",
    "percentage_discount": "percentage_discount2",
    "catalog_object_ids": [
      "catalog_object_ids6"
    ],
    "fixed_discount_money": {
      "amount": 36,
      "currency": "TTD"
    },
    "max_discount_money": {
      "amount": 84,
      "currency": "STD"
    }
  },
  "created_at": "created_at0",
  "pricing_rule_reference": {
    "object_id": "object_id0",
    "catalog_version": 218
  }
}