Get Customer Tier

Retrieves tier details of a customer for a single program or across all programs of the org.

This is a light API.

Important Note

When

fetchDataForAllPrograms

is true

fetchDataForAllPrograms

is false

programId is passed

You will still see tier details of the customer across all programs

You will still see tier details of the customer for that particular program.

programId is not passed

You will still see tier details of the customer across all programs

You will still see tier details of the customer for the default program.

Response Parameters

Parameter

Datatype

Description

entityId

long

Unique ID of the customer.

currentTierSerialNumber

int

Serial number of the current tier. For highest tier, this value is shown as -1 meaning no next tier is available.

nextTierSerialNumber

int

Serial number of the next tier. For highest tier, this value is shown as -1 meaning no next tier is available.

tierExpiryDate

int

Indicates the creation date and time of the target cycle in the server time zone in YYYY-MM-DD- format. Note: This field will be deprecated in the future and is being replaced by tierExpiryDateISO.

tierExpiryDateISO

int

Indicates the creation date and time of the target cycle in ISO 8601 format, returned in the server time zone.

EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC)

India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST)

Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.

Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!