Skip to main content
The customer VIP status contains details about the customer’s achievements and progression within the VIP program.
​
progressValue
number<float>

The amount the customer has already spent or earned within the current VIP period.

Example:

300

​
vipTier
object

A partial representation of the customer's current VIP tier. A null value indicates that the customer is not in a VIP tier.

​
vipTierExpiresAt
string<date-time> | null

The date the customer's current VIP tier expires. For all-time VIP programs, this will be null because tiers do not expire.

Example:

"2026-12-31T23:59:59.999Z"

​
deltaToRetainVipTier
number<float> | null

The additional amount the customer must spend or earn before the end of the current VIP period to retain their VIP tier until the end of the next VIP period. For all-time VIP programs or if the customer has already spent or earned enough this period to retain their current VIP tier, this will be null.

Example:

123

​
currentVipPeriodEnd
string<date-time> | null

The end date for the current VIP period. For calendar-year VIP programs, this will be the end of the current calendar year. For all-time VIP programs, this will be null.

Example:

"2025-12-31T23:59:59.999Z"

​
nextVipTier
object

A partial representation of the next VIP tier that the customer will move into if they meet the minimum spending or earning requirement. If the customer is already in the highest tier, this will be null.

​
deltaToNextVipTier
number | null

The amount the customer must spend or earn within the current VIP period to reach the next VIP tier. If the customer is already in the highest tier, this will be null.

Example:

200