Authorizations
Authorization string header required Bearer authentication header of the formBearer <token>, where <token> is your REST API token.
Required Scope
tiers:read
This endpoint requires the tiers 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.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"