Skip to content

Latest commit

 

History

History
95 lines (86 loc) · 3.47 KB

loyalty-program.md

File metadata and controls

95 lines (86 loc) · 3.47 KB
Raw

Loyalty Program

Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see Loyalty Program Overview.

Structure

Loyalty Program

Fields

Name Type Tags Description
id str Optional The Square-assigned ID of the loyalty program. Updates to
the loyalty program do not modify the identifier.
Constraints: Maximum Length: 36
status str (Loyalty Program Status) Optional Indicates whether the program is currently active.
reward_tiers List Loyalty Program Reward Tier Optional The list of rewards for buyers, sorted by ascending points.
expiration_policy Loyalty Program Expiration Policy Optional Describes when the loyalty program expires.
terminology Loyalty Program Terminology Optional Represents the naming used for loyalty points.
location_ids List[str] Optional The locations at which the program is active.
created_at str Optional The timestamp when the program was created, in RFC 3339 format.
updated_at str Optional The timestamp when the reward was last updated, in RFC 3339 format.
accrual_rules List Loyalty Program Accrual Rule Optional Defines how buyers can earn loyalty points from the base loyalty program.
To check for associated loyalty promotions that enable
buyers to earn extra points, call ListLoyaltyPromotions.

Example (as JSON)

{
  "id": "id2",
  "status": "INACTIVE",
  "reward_tiers": [
    {
      "id": "id8",
      "points": 250,
      "name": "name8",
      "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_at6",
      "pricing_rule_reference": {
        "object_id": "object_id0",
        "catalog_version": 218
      }
    },
    {
      "id": "id8",
      "points": 250,
      "name": "name8",
      "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_at6",
      "pricing_rule_reference": {
        "object_id": "object_id0",
        "catalog_version": 218
      }
    }
  ],
  "expiration_policy": {
    "expiration_duration": "expiration_duration0"
  },
  "terminology": {
    "one": "one0",
    "other": "other6"
  }
}