Loyalty Accounts
Create, retrieve, update, and list loyalty accounts that link customers to the VINR loyalty programme.
A loyalty account links a customer to the loyalty programme and tracks their current points balance and tier membership. One account is created per customer per programme.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The loyalty account objectAsk
idstringUnique identifier for the loyalty account, e.g. la_4Kp9bQ.
customerobjectExpandableThe customer this loyalty account belongs to. Expand to retrieve the full object.
points_balanceintegerCurrent points balance. Never goes below zero.
tierobjectExpandableThe tier this account currently qualifies for. Expand to retrieve the full tier object.
programme_idstringThe loyalty programme this account belongs to.
createdintegerUnix timestamp of when the account was created.
Create a loyalty accountAsk
Enrolls a customer in the loyalty programme. Pass the customer ID and an optional programme ID (the default programme is used when omitted).
Retrieve a loyalty accountAsk
Fetch a loyalty account by its ID. Pass expand[]=customer or expand[]=tier to inline the full
linked objects.
Update a loyalty accountAsk
Update mutable fields on a loyalty account. Currently supports overriding the tier for manual
tier assignments outside the automatic promotion rules.
List loyalty accountsAsk
Returns a paginated list of loyalty accounts, newest first. Use customer to scope results to a
single customer.
| Parameter | Type | Description |
|---|---|---|
customer | string | Filter accounts by customer ID. |
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
loyalty_account.created and loyalty_account.updated. See Events.
