• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
LoyaltyProgram

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.

Properties

Name Description
id
string

Read only The Square-assigned ID of the loyalty program. Updates to the loyalty program do not modify the identifier.

Max Length 36
status
string

Read only Whether the program is currently active.

reward_tiers
LoyaltyProgramRewardTier [ ]

The list of rewards for buyers, sorted by ascending points.

expiration_policy
LoyaltyProgramExpirationPolicy

If present, details for how points expire.

terminology
LoyaltyProgramTerminology

A cosmetic name for the “points” currency.

location_ids
string [ ]

The locations at which the program is active.

created_at
string

Read only The timestamp when the program was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

updated_at
string

Read only The timestamp when the reward was last updated, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

accrual_rules
LoyaltyProgramAccrualRule [ ]

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.