Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yuko.so/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves all VIP tiers configured for your organisation, sorted by threshold_value in ascending order. Each tier includes its associated benefits. GET /public/tiers

​
Authorizations

Authorization string header required Bearer authentication header of the form Bearer <token>, where <token> is your REST API token.

​
Response

200 - application/json data object[] Hide child attributes data.id string<uuid> Unique UUID identifier for the VIP tier. Example: "7fb39c85-3a3f-4247-8333-2e05a9c8ae28" data.name string The display name of the VIP tier. Example: "Gold" data.threshold_value integer The points value a customer must accumulate to reach this tier. Example: 1000 data.multiplier number The points earning multiplier applied to customers in this tier. Example: 2.0 data.icon_url string | null URL of the tier icon image. Example: "https://cdn.yukoapp.com/tiers/gold-icon.png" data.benefits object[] A list of benefits associated with this tier. Hide child attributes data.benefits.name string The display name of the benefit. Example: "10% Discount on every order" data.benefits.benefit_type string The type of benefit issued to the customer. Available options: fixed_discount, percentage_discount, free_shipping, multiplier Example: "percentage_discount" data.benefits.benefit_value object The value configuration for this benefit. Structure varies by benefit_type. Example: { "value": 10 } data.created_at string<date-time> Example: "2025-09-12T15:44:44.000Z" 
curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/tiers" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "data": [
    {
      "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
      "name": "Silver",
      "threshold_value": 500,
      "multiplier": 1.5,
      "icon_url": null,
      "benefits": [
        {
          "name": "5% Discount on every order",
          "benefit_type": "percentage_discount",
          "benefit_value": { "value": 5 }
        }
      ],
      "created_at": "2025-09-12T15:44:44.000Z"
    },
    {
      "id": "8ac40d96-4b4e-5358-9444-3f16ba d9bf39",
      "name": "Gold",
      "threshold_value": 1000,
      "multiplier": 2.0,
      "icon_url": "https://cdn.yukoapp.com/tiers/gold-icon.png",
      "benefits": [
        {
          "name": "10% Discount on every order",
          "benefit_type": "percentage_discount",
          "benefit_value": { "value": 10 }
        },
        {
          "name": "Free Shipping",
          "benefit_type": "free_shipping",
          "benefit_value": {}
        }
      ],
      "created_at": "2025-09-12T15:44:44.000Z"
    }
  ]
}