<- Object

Object

All versions ->

LoyaltyAccountBeta

Describes a loyalty account.

Link to section

Properties

Link to section

id

string

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

Max Length
36
Link to section

mappings

Required

The list of mappings that the account is associated with. Currently, a buyer can only be mapped to a loyalty account using a phone number. Therefore, the list can only have one mapping.

Link to section

program_id

string

Required

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

Min Length
1
Max Length
36
Link to section

balance

integer(32-bit)

Read only The available point balance in the loyalty account.

Link to section

lifetime_points

integer(32-bit)

Read only The total points accrued during the lifetime of the account.

Link to section

customer_id

string

The Square-assigned ID of the customer that is associated with the account.

Link to section

enrolled_at

string

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

Link to section

created_at

string

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

Link to section

updated_at

string

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