curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/tiers" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const response = await fetch(
"https://api.yukoapp.com/api/v1/public/tiers",
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/tiers");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
"name": "Silver",
"threshold_value": 500,
"multiplier": 1.5,
"icon": null,
"benefits": [
{
"name": "5% Discount on every order",
"benefit_type": "percentage",
"benefit_value": { "reward_type": "percentage", "method": "automatic", "discount_value": 5 }
}
],
"created_at": "2025-09-12T15:44:44+00:00"
},
{
"id": "8ac40d96-4b4e-5358-9444-3f16bab9bf39",
"name": "Gold",
"threshold_value": 1000,
"multiplier": 2.0,
"icon": { "source": "custom", "slug": null, "id": "12", "url": "https://example.com/gold-icon.png" },
"benefits": [
{
"name": "10% Discount on every order",
"benefit_type": "percentage",
"benefit_value": { "reward_type": "percentage", "method": "automatic", "discount_value": 10 }
},
{
"name": "Free Shipping",
"benefit_type": "free_shipping",
"benefit_value": { "method": "automatic", "coupon_prefix": "VIPSHIP", "min_requirement": { "type": "none" } }
}
],
"created_at": "2025-09-12T15:44:44+00:00"
}
]
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
VIP Tiers
List VIP tiers
Retrieves all VIP tiers configured for your organisation, with their benefits.
GET
/
public
/
tiers
curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/tiers" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const response = await fetch(
"https://api.yukoapp.com/api/v1/public/tiers",
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/tiers");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
"name": "Silver",
"threshold_value": 500,
"multiplier": 1.5,
"icon": null,
"benefits": [
{
"name": "5% Discount on every order",
"benefit_type": "percentage",
"benefit_value": { "reward_type": "percentage", "method": "automatic", "discount_value": 5 }
}
],
"created_at": "2025-09-12T15:44:44+00:00"
},
{
"id": "8ac40d96-4b4e-5358-9444-3f16bab9bf39",
"name": "Gold",
"threshold_value": 1000,
"multiplier": 2.0,
"icon": { "source": "custom", "slug": null, "id": "12", "url": "https://example.com/gold-icon.png" },
"benefits": [
{
"name": "10% Discount on every order",
"benefit_type": "percentage",
"benefit_value": { "reward_type": "percentage", "method": "automatic", "discount_value": 10 }
},
{
"name": "Free Shipping",
"benefit_type": "free_shipping",
"benefit_value": { "method": "automatic", "coupon_prefix": "VIPSHIP", "min_requirement": { "type": "none" } }
}
],
"created_at": "2025-09-12T15:44:44+00:00"
}
]
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}
Tiers are sorted by
threshold_value in ascending order. Each tier includes its associated benefits.
Requires the
read:tiers scope. See Scopes.Response
object[]
The VIP tiers, lowest threshold first.
Show tier properties
Show tier properties
string<uuid>
Unique UUID identifier for the VIP tier.
string
The display name of the VIP tier.
integer
The value a customer must reach to qualify for this tier, measured in the program’s tier metric: amount spent (default), points earned or orders placed, as configured in your VIP settings.
number
The points earning multiplier applied to customers in this tier.
object | null
The tier icon, or
null if none is set. Always has four keys: source (default or custom), slug (built-in icons, otherwise null), id (custom uploads, otherwise null) and url (the custom upload URL, or the hosted SVG for a built-in icon).object[]
A list of benefits associated with this tier.
Show benefit properties
Show benefit properties
string
The display name of the benefit.
enum<string>
The type of benefit issued to the customer. One of
fixed, percentage, free_product, free_shipping, bonus_points, store_credit, custom.object
The stored value configuration for this benefit, returned as-is. Structure varies by
benefit_type. For example, fixed/percentage benefits include reward_type, method (automatic or one_time), discount_value, coupon_prefix and min_requirement; bonus_points and store_credit include method, reward_type and discount_value; custom benefits may be empty.string<date-time> | null
When the tier was created (ISO 8601).
Errors
| Status | Code | When |
|---|---|---|
401 | missing_token, invalid_token | The API key is missing, wrong or revoked. |
403 | insufficient_scope | The key doesn’t have read:tiers. |
429 | The key exceeded the rate limit. |
curl --request GET \
--url "https://api.yukoapp.com/api/v1/public/tiers" \
--header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
const response = await fetch(
"https://api.yukoapp.com/api/v1/public/tiers",
{
method: "GET",
headers: {
Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
},
}
);
const data = await response.json();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/tiers");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
{
"data": [
{
"id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
"name": "Silver",
"threshold_value": 500,
"multiplier": 1.5,
"icon": null,
"benefits": [
{
"name": "5% Discount on every order",
"benefit_type": "percentage",
"benefit_value": { "reward_type": "percentage", "method": "automatic", "discount_value": 5 }
}
],
"created_at": "2025-09-12T15:44:44+00:00"
},
{
"id": "8ac40d96-4b4e-5358-9444-3f16bab9bf39",
"name": "Gold",
"threshold_value": 1000,
"multiplier": 2.0,
"icon": { "source": "custom", "slug": null, "id": "12", "url": "https://example.com/gold-icon.png" },
"benefits": [
{
"name": "10% Discount on every order",
"benefit_type": "percentage",
"benefit_value": { "reward_type": "percentage", "method": "automatic", "discount_value": 10 }
},
{
"name": "Free Shipping",
"benefit_type": "free_shipping",
"benefit_value": { "method": "automatic", "coupon_prefix": "VIPSHIP", "min_requirement": { "type": "none" } }
}
],
"created_at": "2025-09-12T15:44:44+00:00"
}
]
}
{
"error": {
"code": "invalid_token",
"message": "Invalid or revoked API token"
}
}