loyalty-program.md

Loyalty Program

Structure

Loyalty Program

Fields

Name	Type	Tags	Description
id	String	Required	The Square-assigned ID of the loyalty program. Updates to the loyalty program do not modify the identifier. Constraints: Minimum Length: 1, Maximum Length: 36
status	String (Loyalty Program Status)	Required	Indicates whether the program is currently active.
reward_tiers	Array<Loyalty Program Reward Tier Hash>	Required	The list of rewards for buyers, sorted by ascending points.
expiration_policy	Loyalty Program Expiration Policy Hash	Optional	Describes when the loyalty program expires.
terminology	Loyalty Program Terminology Hash	Required	-
location_ids	Array<String>	Required	The locations at which the program is active.
created_at	String	Required	The timestamp when the program was created, in RFC 3339 format. Constraints: Minimum Length: 1
updated_at	String	Required	The timestamp when the reward was last updated, in RFC 3339 format. Constraints: Minimum Length: 1
accrual_rules	Array<Loyalty Program Accrual Rule Hash>	Required	Defines how buyers can earn loyalty points.

Example (as JSON)

{
  "id": "id0",
  "status": "INACTIVE",
  "reward_tiers": [
    {
      "id": "id9",
      "points": 249,
      "name": "name9",
      "definition": {
        "scope": "CATEGORY",
        "discount_type": "FIXED_PERCENTAGE",
        "percentage_discount": "percentage_discount1",
        "catalog_object_ids": [
          "catalog_object_ids3",
          "catalog_object_ids4",
          "catalog_object_ids5"
        ],
        "fixed_discount_money": {
          "amount": 119,
          "currency": "CUC"
        },
        "max_discount_money": {
          "amount": 163,
          "currency": "ZMK"
        }
      },
      "created_at": "created_at7",
      "pricing_rule_reference": {
        "object_id": "object_id9",
        "catalog_version": 205
      }
    },
    {
      "id": "id0",
      "points": 248,
      "name": "name0",
      "definition": {
        "scope": "ORDER",
        "discount_type": "FIXED_AMOUNT",
        "percentage_discount": "percentage_discount2",
        "catalog_object_ids": [
          "catalog_object_ids4"
        ],
        "fixed_discount_money": {
          "amount": 120,
          "currency": "CUP"
        },
        "max_discount_money": {
          "amount": 164,
          "currency": "ZMW"
        }
      },
      "created_at": "created_at8",
      "pricing_rule_reference": {
        "object_id": "object_id0",
        "catalog_version": 206
      }
    }
  ],
  "expiration_policy": {
    "expiration_duration": "expiration_duration0"
  },
  "terminology": {
    "one": "one0",
    "other": "other6"
  },
  "location_ids": [
    "location_ids0"
  ],
  "created_at": "created_at2",
  "updated_at": "updated_at4",
  "accrual_rules": [
    {
      "accrual_type": "ITEM_VARIATION",
      "points": 100,
      "visit_minimum_amount_money": {
        "amount": 238,
        "currency": "ISK"
      },
      "spend_amount_money": {
        "amount": 98,
        "currency": "UGX"
      },
      "catalog_object_id": "catalog_object_id8"
    },
    {
      "accrual_type": "SPEND",
      "points": 99,
      "visit_minimum_amount_money": {
        "amount": 237,
        "currency": "JMD"
      },
      "spend_amount_money": {
        "amount": 99,
        "currency": "USD"
      },
      "catalog_object_id": "catalog_object_id7"
    }
  ]
}