Get Loyalty Balance
GET/api/customers/:customer/loyalty
The customer's current loyalty points balance and its dollar redemption value, plus whether the loyalty program is enabled.
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (PAT). Permission: authenticated user (no extra permission required for read).
Returns 200 with { data: { customer_id, points_balance, redemption_value, program_enabled } }:
points_balance(integer) — the running sum of the customer's loyalty ledger.redemption_value(float) — the dollar value of that balance at the current redemption rate.program_enabled(boolean) — whether the loyalty program is active for the tenant.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.