Tiers
Create, retrieve, update, delete, and list membership tiers in the VINR loyalty programme.
A tier represents a membership level in the loyalty programme (e.g. Bronze, Silver, Gold). Customers
are automatically promoted or demoted based on their points balance relative to each tier's
min_points threshold.
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 tier objectAsk
idstringUnique identifier for the tier, e.g. tier_gold.
namestringHuman-readable tier name displayed to customers, e.g. Gold.
min_pointsintegerMinimum points balance required to qualify for this tier.
benefitsarrayList of benefit descriptions shown to customers, e.g. ["Free shipping", "Early access"].
createdintegerUnix timestamp of when the tier was created.
Create a tierAsk
Define a new membership tier. Tiers are evaluated in ascending min_points order; a customer
qualifies for the highest tier whose min_points does not exceed their current balance.
Retrieve a tierAsk
Fetch a tier by its ID.
Update a tierAsk
Update the tier's name or points threshold. Changes take effect immediately; affected customers' tier assignments are re-evaluated on the next balance change.
Delete a tierAsk
Permanently deletes a tier. Loyalty accounts currently assigned to this tier fall back to the next qualifying tier automatically.
List tiersAsk
Returns a paginated list of all tiers, ordered by min_points ascending.
| Parameter | Type | Description |
|---|---|---|
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
tier.created and tier.updated. See Events.
