Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt

Use this file to discover all available pages before exploring further.

The customer metafield contains the individual loyalty data for a single customer. Access it in Liquid at: 
{{ customer.metafields.mage.loyalty.value }}
Since the metafield type is json, you access nested properties through .value in Liquid. This metafield is only available on pages where the customer object exists (i.e. the customer is logged in).

​
Full object shape

{
  "points_balance": 1250,
  "lifetime_points": 3400,
  "redeemed_points": 2150,
  "vip_tier": "Gold",
  "status": "member"
}

​
Field reference

FieldTypeDescription
points_balancenumberCurrent available points the customer can spend
lifetime_pointsnumberTotal points earned since joining the program
redeemed_pointsnumberTotal points spent on rewards
vip_tierstringName of the customer’s current VIP tier
statusstring"member" or "excluded"

​
Status values

ValueDescription
memberActive loyalty program member
excludedCustomer has been excluded from the loyalty program by the merchant