Membership Object

{
  "status": "active",
  "member_since": "2025-11-02T10:15:00+00:00",
  "points": {
    "balance": 650,
    "earned": 1200,
    "redeemed": 550
  },
  "current_tier": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Silver",
    "threshold_value": 500,
    "multiplier": 1,
    "icon": null,
    "benefits": [],
    "created_at": "2025-01-10T09:00:00+00:00"
  },
  "next_tier": {
    "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
    "name": "Gold",
    "threshold_value": 2000,
    "multiplier": 1.5,
    "icon": null,
    "benefits": [],
    "created_at": "2025-01-10T09:00:00+00:00"
  },
  "progress_to_next_tier": {
    "current_value": 1200,
    "required_value": 2000,
    "remaining_value": 800,
    "progress_percentage": 60,
    "threshold_type": "total_earned_points"
  }
}

{
  "status": "active",
  "member_since": "2025-11-02T10:15:00+00:00",
  "points": {
    "balance": 650,
    "earned": 1200,
    "redeemed": 550
  },
  "current_tier": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Silver",
    "threshold_value": 500,
    "multiplier": 1,
    "icon": null,
    "benefits": [],
    "created_at": "2025-01-10T09:00:00+00:00"
  },
  "next_tier": {
    "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
    "name": "Gold",
    "threshold_value": 2000,
    "multiplier": 1.5,
    "icon": null,
    "benefits": [],
    "created_at": "2025-01-10T09:00:00+00:00"
  },
  "progress_to_next_tier": {
    "current_value": 1200,
    "required_value": 2000,
    "remaining_value": 800,
    "progress_percentage": 60,
    "threshold_type": "total_earned_points"
  }
}

The membership object summarizes a customer’s standing in your loyalty program: points balance, current VIP tier, next tier and progress toward it. It’s returned by Get customer membership (GET /public/customers/memberships, requires the read:customers scope).

This object describes loyalty program membership. Paid membership plans (Membership → Plans) aren’t available through the REST API.

Properties

string

The customer’s membership status. Always active for a customer returned by this endpoint.

string<date-time>

When the customer was added to Yuko (ISO 8601).

object

The customer’s points summary.

Show points properties

integer

The customer’s spendable points balance. Always 0 for a customer who is banned or excluded from the loyalty program by a customer tag.

integer

Total points the customer has earned.

integer

Total points the customer has redeemed.

object | null

The customer’s current VIP tier, or null if VIP tiers are turned off or the customer hasn’t reached a tier.

Show tier properties

string<uuid>

The tier’s unique identifier.

string

The tier’s name.

integer

The value needed to reach the tier.

number

The tier’s points multiplier, 1 when none is set.

object | null

The tier’s icon.

object[]

The tier’s benefits.

Show benefit properties

string

The benefit’s name.

enum<string>

One of fixed, percentage, free_product, free_shipping, bonus_points, store_credit, custom.

object

The benefit’s value configuration. Its structure depends on benefit_type; see List VIP tiers.

string<date-time>

When the tier was created.

object | null

The next VIP tier the customer can reach, with the same fields as current_tier. null if VIP tiers are turned off, the customer hasn’t been evaluated for tiers yet, or the customer is already at the highest tier.

object | null

The customer’s progress toward next_tier, or null if VIP tiers are turned off or there’s no next tier.

Show progress properties

integer

The customer’s current qualifying value, rounded down.

integer

The value needed for the next tier.

integer

How much more is needed.

number

Progress as a percentage, rounded to 2 decimal places.

string | null

The metric used for tier progression (total_earned_points, total_amount_spents or total_orders). Can be null even when VIP tiers are set up.

{
  "status": "active",
  "member_since": "2025-11-02T10:15:00+00:00",
  "points": {
    "balance": 650,
    "earned": 1200,
    "redeemed": 550
  },
  "current_tier": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Silver",
    "threshold_value": 500,
    "multiplier": 1,
    "icon": null,
    "benefits": [],
    "created_at": "2025-01-10T09:00:00+00:00"
  },
  "next_tier": {
    "id": "7fb39c85-3a3f-4247-8333-2e05a9c8ae28",
    "name": "Gold",
    "threshold_value": 2000,
    "multiplier": 1.5,
    "icon": null,
    "benefits": [],
    "created_at": "2025-01-10T09:00:00+00:00"
  },
  "progress_to_next_tier": {
    "current_value": 1200,
    "required_value": 2000,
    "remaining_value": 800,
    "progress_percentage": 60,
    "threshold_type": "total_earned_points"
  }
}

Rest API

API References

Object Reference

Properties

​Properties

Properties