Skip to content

Latest commit

 

History

History
95 lines (86 loc) · 4.17 KB

loyalty-program.md

File metadata and controls

95 lines (86 loc) · 4.17 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

LoyaltyProgram

Fields

Name Type Tags Description Getter Setter
id ?string Optional The Square-assigned ID of the loyalty program. Updates to
the loyalty program do not modify the identifier.
Constraints: Maximum Length: 36		 getId(): ?string setId(?string id): void
status ?string(LoyaltyProgramStatus) Optional Indicates whether the program is currently active. getStatus(): ?string setStatus(?string status): void
rewardTiers ?(LoyaltyProgramRewardTier[]) Optional The list of rewards for buyers, sorted by ascending points. getRewardTiers(): ?array setRewardTiers(?array rewardTiers): void
expirationPolicy ?LoyaltyProgramExpirationPolicy Optional Describes when the loyalty program expires. getExpirationPolicy(): ?LoyaltyProgramExpirationPolicy setExpirationPolicy(?LoyaltyProgramExpirationPolicy expirationPolicy): void
terminology ?LoyaltyProgramTerminology Optional Represents the naming used for loyalty points. getTerminology(): ?LoyaltyProgramTerminology setTerminology(?LoyaltyProgramTerminology terminology): void
locationIds ?(string[]) Optional The locations at which the program is active. getLocationIds(): ?array setLocationIds(?array locationIds): void
createdAt ?string Optional The timestamp when the program was created, in RFC 3339 format. getCreatedAt(): ?string setCreatedAt(?string createdAt): void
updatedAt ?string Optional The timestamp when the reward was last updated, in RFC 3339 format. getUpdatedAt(): ?string setUpdatedAt(?string updatedAt): void
accrualRules ?(LoyaltyProgramAccrualRule[]) 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.		 getAccrualRules(): ?array setAccrualRules(?array accrualRules): void

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"
  }
}