Object Index
You are viewing an old version of the API
LoyaltyProgram
BETA
Object Index
Properties
| Name | Description |
|---|---|
id
Required
|
Read only The Square-assigned ID of the loyalty program. Updates to the loyalty program do not modify the identifier. |
status
Required
|
Read only Whether the program is currently active. |
reward_tiers
Required
|
Read only The list of rewards for buyers, sorted by ascending points. |
expiration_policy
|
Read only If present, details for how points expire. |
terminology
Required
|
Read only A cosmetic name for the “points” currency. |
location_ids
Required
|
Read only The locations at which the program is active. |
created_at
Required
|
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
Required
|
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
Required
|
Read only Defines how buyers can earn loyalty points. |