eligibility returns everything the app needs to gate a member’s experience in a
single call: their tier and their wallet. It is a convenient first call when a
screen loads, before listing offers or redeeming.
These are member-mode calls: they use the member token, not the
Org-API-Key. See Authentication. Whether you read sandbox or
live data is selected by the key the token was minted from - see
Environments.
Get eligibility
eligibility(externalUserID?) calls GET /v1/eligibility and returns a
MemberEligibility. The snippet below reads the tier and balance, then fetches
the full wallet:
curl
externalUserID query parameter is optional. Omit it and the call resolves
to the member the token was minted for; pass it when a machine token acts on a
specific member’s behalf.
Response
The member’s tier. This is client-set on the member profile and flows
through here - see Members.
The member’s wallet, embedded so you can gate offers and show a balance without
a second call.
Wallet has these fields:
| Field | Type | Description |
|---|---|---|
balance | number | Spendable points available now. |
amountReceived | number | Lifetime points received. |
amountSpent | number | Lifetime points spent. |
currency.name | string | The points-currency name. |
currency.symbol | string | The points-currency symbol. |
Next steps
Wallet
Read the wallet directly, with lifetime totals and currency.
Members
How a member’s tier is set and flows into eligibility.