Object Index
You are viewing an old version of the API
LoyaltyAccount
Object Index
Describes a loyalty account in a loyalty program.
For more information, see Create and Retrieve Loyalty Accounts.
Properties
Name | Description |
---|---|
id
|
Read only The Square-assigned ID of the loyalty account. |
program_
Required
|
The Square-assigned ID of the loyalty program to which the account belongs. |
balance
|
Read only The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the Your application should be able to handle loyalty accounts that have a negative point balance ( |
lifetime_
|
Read only The total points accrued during the lifetime of the account. |
customer_
|
The Square-assigned ID of the customer that is associated with the account. |
enrolled_
|
The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the Enrolled On or Member Since date in first-party Square products. If this field is not set in a This field is typically specified in a 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 |
created_
|
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 |
updated_
|
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 |
mapping
|
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 |
expiring_
|
The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire. The total number of points in this field equals the number of points in the |