Skip to main content
GET
Get the customer loyalty account, tier, membership, and wallet

Authorizations

Authorization
string
header
required

Merchant-bound opaque customer access capability returned by fresh code verification or refresh.

Path Parameters

locationId
string
required
Required string length: 1 - 128

Response

Customer loyalty account.

enabled
boolean
required
authority
enum<string>
Available options:
SQUARE,
LIP
enrollmentRequired
boolean
program
object
member
object
balances
object[]
metrics
object[]
expiringBalances
object[]
tier
object
membership
object
membershipPlans
object[]
rewardCatalog
object[]
issuedRewards
object[]