Loyalty API
TypeTierStatus3
Describes a tier defined by the shop.
| Kind | Type |
|---|---|
| Used in | CustomerBalance3, LoggedOutBalance1 |
Properties
-
namestring requiredThe name of the tier.
-
Describes when and how the tier is going to expire. Null if never.
-
Describes how the tier can be reached.
For a current tier, these requirements are irrelevant but specified for consistency.
Note that because the requirements might have been updated after reaching the tier, a customer does not necessarily fulfil their current tier's requiremenets.
-
featuresarray of TierFeatureValue1 only present in the tiers array when include_full_program is enabledThe feature values available at this tier.
This field is only populated for tiers in the
tiersarray wheninclude_full_programis true.The
cur_tierandnext_tierfields will NOT include features. -
redemption_limitRedemptionLimitInfo1 only present in the tiers array when include_full_program is enabled and tier has a limitThe redemption limit configuration for this tier.
This field is only populated for tiers in the
tiersarray wheninclude_full_programis true and the tier has a redemption limit configured.When a tier has a redemption limit configured, it completely overrides the global limit for customers in that tier. This allows premium tiers to offer higher redemption limits as a benefit.
For the customer's current tier, the
remainingpoints value reflects their actual usage. For other tiers, it shows the full points limit that would be available if they were in that tier.