Skip to content

VIP tiers

Your program’s VIP tiers and their milestones.

GET /tiers

[
{
"id": "3",
"name": "Gold",
"milestone": 500,
"multiplier": 2,
"iconUrl": "https://...",
"benefits": "...",
"rewards": [
{
"id": "44",
"name": "$5 off",
"price": 10,
"exchangeType": "stamps",
"iconUrl": "https://..."
}
]
}
]

Both the list and single-tier endpoints return objects with these fields.

FieldTypeDescription
idstringUnique identifier.
namestringDisplay name.
milestoneintegerStamps required to reach the tier.
multipliernumberStamp-earning multiplier for members.
iconUrlstringIcon URL if set (omitted otherwise).
benefitsstringDescription of the tier’s benefits.
rewardsarrayReward products granted by this tier. Each object has id, name, price, exchangeType, and iconUrl.

GET /tiers/{id}

Returns a single tier (see Tier fields), or 404 TIER_NOT_FOUND.