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

Object Index

You are viewing an old version of the API
LoyaltyReward BETA

Properties

Name Description
id
string

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

Max Length 36
status
string

Read only The status of a loyalty reward.

loyalty_account_id
string

Required

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

Max Length 36 Min Length 1
reward_tier_id
string

Required

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

Max Length 36 Min Length 1
points
integer

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

Min 1
order_id
string

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

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

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

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

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?