Describes a loyalty account.
<- Object
Object
Describes a loyalty account.
For more information, see Manage Loyalty Accounts Using the Loyalty API.
The Square-assigned ID of the loyalty program to which the account belongs.
Read only The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the expiring_point_deadlines field.
Your application should be able to handle loyalty accounts that have a negative point balance (balance is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange.
Read only The total points accrued during the lifetime of the account.
The Square-assigned ID of the customer that is associated with the account.
Read only The timestamp when enrollment occurred, 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
Read only The timestamp when the loyalty account 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
Read only The timestamp when the loyalty account 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
The mapping that associates the loyalty account with a buyer. Currently, a loyalty account can only be mapped to a buyer by phone number.
To create a loyalty account, you must specify the mapping field, with the buyer's phone number in the phone_number field.