LoyaltyReward

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 Manage loyalty rewards.

Link to section

Properties

Link to section

string

Read only The Square-assigned ID of the loyalty reward.

Max Length

Link to section

status

string

Read only The status of a loyalty reward.

Link to section

loyalty_account_id

string

Required

The Square-assigned ID of the loyalty account to which the reward belongs.

Min Length

Max Length

Link to section

reward_tier_id

string

Required

The Square-assigned ID of the reward tier used to create the reward.

Min Length

Max Length

Link to section

points

integer(32-bit)

Read only The number of loyalty points used for the reward.

Min

Link to section

order_id

string

The Square-assigned ID of the order to which the reward is attached.

Link to section

created_at

string

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

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

redeemed_at

string

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