> ## 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.

# Customer Object

> Reference for the customer.metafields.mage.loyalty JSON object.

The customer metafield contains the individual loyalty data for a single customer. Access it in Liquid at:

```liquid theme={null}
{{ customer.metafields.mage.loyalty.value }}
```

<Note>
  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).
</Note>

## Full object shape

```json theme={null}
{
  "points_balance": 1250,
  "lifetime_points": 3400,
  "redeemed_points": 2150,
  "vip_tier": "Gold",
  "status": "member",
  "points_next_expiry_at": "2026-12-31T00:00:00.000Z"
}
```

## Field reference

| Field | Type | Description |
| - | - | - |
| `points_balance` | number | Current available points the customer can spend |
| `lifetime_points` | number | Total points earned since joining the program |
| `redeemed_points` | number | Total points spent on rewards |
| `vip_tier` | string | Name of the customer's current VIP tier, or an empty string if they have no tier |
| `status` | string | `"member"` or `"excluded"` |
| `points_next_expiry_at` | string \| null | ISO 8601 date when the customer's next points expire. Populated only when the shop uses `last_purchase_date` expiry and the customer has made a purchase; otherwise `null` |

## Status values

| Value | Description |
| - | - |
| `member` | Active loyalty program member |
| `excluded` | Customer has been excluded from the loyalty program by the merchant |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.