Object Index
You are viewing an old version of the API
LoyaltyReward
BETA
Object Index
Represents a contract to redeem loyalty points for a reward tier discount.
Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state. For more information, see Redeem loyalty rewards.
Properties
| Name | Description |
|---|---|
id
|
Read only The Square-assigned ID of the loyalty reward. |
status
|
Read only The status of a loyalty reward. |
loyalty_
Required
|
The Square-assigned ID of the loyalty account to which the reward belongs. |
reward_
Required
|
The Square-assigned ID of the reward tier used to create the reward. |
points
|
Read only The number of loyalty points used for the reward. |
order_
|
The Square-assigned ID of the order to which the reward is attached. |
created_
|
Read only The timestamp when the reward 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_
|
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 |
redeemed_
|
Read only The timestamp when the reward was redeemed, 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 |