LoyaltyTier

Get tier group

Returns tier group information.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID
gidstringRequiredformat: "uuid"
Tier group ID

Query parameters

versionenumOptionalDefaults to draft
Select active to retrieve active version of tier group. Select draft to retrieve latest changes in tier group.
Allowed values:

Response

Tier group information successfully retrieved
createdAtdatetime or null
Timestamp when the tier group was created
downgradeStrategyenum or nullDefaults to real_time

Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.

Allowed values:
idstring or nullformat: "uuid"
Tier group unique identifier
loyaltyProgramIdstring or nullformat: "uuid"
Associated loyalty program Id
namestring or null
Tier group name
tierOrderlist of strings or null
Order of the tiers in the group in ascending order
updatedAtdatetime or null
Timestamp when the tier group was last updated
upgradeStrategyenum or nullDefaults to real_time

Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.

Allowed values:

Errors