loyalty-program.md

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
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	Required	Indicates whether the program is currently active.
rewardTiers	LoyaltyProgramRewardTier[]	Required	The list of rewards for buyers, sorted by ascending points.
expirationPolicy	LoyaltyProgramExpirationPolicy | undefined	Optional	Describes when the loyalty program expires.
terminology	LoyaltyProgramTerminology	Required	Represents the naming used for loyalty points.
locationIds	string[] | undefined	Optional	The locations at which the program is active.
createdAt	string	Required	The timestamp when the program was created, in RFC 3339 format. Constraints: Minimum Length: 1
updatedAt	string	Required	The timestamp when the reward was last updated, in RFC 3339 format. Constraints: Minimum Length: 1
accrualRules	LoyaltyProgramAccrualRule[]	Required	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)

{
  "status": "INACTIVE",
  "expiration_policy": null,
  "terminology": {}
}