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.

Link to section

Properties

Link to section

string

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

Max Length

Link to section

status

string

Whether the program is currently active.

Show values

Link to section

reward_tiers

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

Show attributes

Link to section

expiration_policy

If present, details for how points expire.

Show attributes

Link to section

terminology

A cosmetic name for the “points” currency.

Show attributes

Link to section

location_ids

string [ ]

The locations at which the program is active.

Link to section

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

Link to section

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

Link to section

accrual_rules

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.

Show attributes