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.

Returns the customer’s loyalty membership summary including points balance, current VIP tier, and progress toward the next tier. GET /public/customers/memberships

​
Authorizations

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

​
Required Scope

customers:read This endpoint requires the customers scope with Read Access. Configure token scopes in Settings → Integrations → REST API.

​
Query Parameters

customer_id string required The platform customer ID (e.g. Shopify customer ID) Example: "9049402769586"

​
Response

200 - application/json data object Hide child attributes data.status string The customer’s loyalty membership status. Always "active". Example: "active" data.member_since string<date-time> The date and time the customer joined the loyalty programme. Example: "2024-06-01T10:00:00.000Z" data.points object The customer’s current points summary. Hide child attributes data.points.balance integer The customer’s current redeemable points balance. Example: 350 data.points.earned integer Total points ever earned by the customer. Example: 500 data.points.redeemed integer Total points redeemed by the customer. Example: 150 data.current_tier object | null The customer’s current VIP tier. null if the customer has not reached any tier threshold. Hide child attributes data.current_tier.id string<uuid> Example: "7fb39c85-3a3f-4247-8333-2e05a9c8ae28" data.current_tier.name string Example: "Silver" data.current_tier.threshold_value integer Example: 500 data.current_tier.multiplier number Example: 1.5 data.current_tier.icon_url string | null Example: null data.current_tier.benefits object[] The benefits associated with this tier. data.next_tier object | null The next VIP tier the customer can reach. null if the customer is already at the highest tier. Hide child attributes data.next_tier.id string<uuid> Example: "8ac40d96-4b4e-5358-9444-3f16bab9bf39" data.next_tier.name string Example: "Gold" data.next_tier.threshold_value integer Example: 1000 data.next_tier.multiplier number Example: 2.0 data.next_tier.benefits object[] The benefits associated with the next tier. data.progress_to_next_tier object | null The customer’s progress toward the next tier. null if the customer is at the highest tier. Hide child attributes data.progress_to_next_tier.current_value integer The customer’s current qualifying value (points earned, spend, etc.). Example: 650 data.progress_to_next_tier.required_value integer The value required to reach the next tier. Example: 1000 data.progress_to_next_tier.remaining_value integer The remaining value needed to reach the next tier. Example: 350 data.progress_to_next_tier.progress_percentage number The percentage of the way to the next tier, capped at 100. Example: 65.0 data.progress_to_next_tier.threshold_type string The metric used to determine tier progression. Available options: total_earned_points, total_amount_spents Example: "total_earned_points" 
curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers/memberships?customer_id=9049402769586" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "data": {
    "status": "active",
    "member_since": "2024-06-01T10:00:00.000Z",
    "points": {
      "balance": 350,
      "earned": 500,
      "redeemed": 150
    },
    "current_tier": {
      "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"
    },
    "next_tier": {
      "id": "8ac40d96-4b4e-5358-9444-3f16bab9bf39",
      "name": "Gold",
      "threshold_value": 1000,
      "multiplier": 2.0,
      "icon_url": null,
      "benefits": [
        {
          "name": "10% Discount on every order",
          "benefit_type": "percentage_discount",
          "benefit_value": { "value": 10 }
        }
      ],
      "created_at": "2025-09-12T15:44:44.000Z"
    },
    "progress_to_next_tier": {
      "current_value": 650,
      "required_value": 1000,
      "remaining_value": 350,
      "progress_percentage": 65.0,
      "threshold_type": "total_earned_points"
    }
  }
}