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

Object Index

You are viewing an old version of the API
LoyaltyAccount BETA

Describes a loyalty account.

For more information, see Loyalty Overview.

Properties

Name Description
id
string

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

Max Length 36
mappings
LoyaltyAccountMapping [ ]

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.

program_id
string

Required

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

Max Length 36 Min Length 1
balance
integer

Read only The available point balance in the loyalty account.

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.

lifetime_points
integer

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

customer_id
string

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

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

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

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

Share Feedback

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