Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 3.57 KB

loyalty-account.md

File metadata and controls

42 lines (33 loc) · 3.57 KB
Raw

Loyalty Account

Describes a loyalty account in a loyalty program. For more information, see Create and Retrieve Loyalty Accounts.

Structure

LoyaltyAccount

Fields

Name Type Tags Description
id string | undefined Optional The Square-assigned ID of the loyalty account.
Constraints: Maximum Length: 36
programId string Required The Square-assigned ID of the loyalty program to which the account belongs.
Constraints: Minimum Length: 1, Maximum Length: 36
balance number | undefined Optional 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.
lifetimePoints number | undefined Optional The total points accrued during the lifetime of the account.
customerId string | undefined Optional The Square-assigned ID of the customer that is associated with the account.
enrolledAt string | undefined Optional 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 CreateLoyaltyAccount request, Square populates it after the buyer's first action on their account
(when AccumulateLoyaltyPoints or CreateLoyaltyReward is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale.

This field is typically specified in a CreateLoyaltyAccount request when creating a loyalty account for a buyer who already interacted with their account.
For example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future.
createdAt string | undefined Optional The timestamp when the loyalty account was created, in RFC 3339 format.
updatedAt string | undefined Optional The timestamp when the loyalty account was last updated, in RFC 3339 format.
mapping LoyaltyAccountMapping | undefined Optional Represents the mapping that associates a loyalty account with a buyer.

Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see
Loyalty Overview.
expiringPointDeadlines LoyaltyAccountExpiringPointDeadline[] | undefined Optional 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 balance field.

Example (as JSON)

{
  "id": null,
  "program_id": "program_id0",
  "balance": null,
  "lifetime_points": null,
  "customer_id": null,
  "enrolled_at": null,
  "created_at": null,
  "updated_at": null,
  "mapping": null,
  "expiring_point_deadlines": null
}