Loyalty API

Type

TierStatus3

Describes a tier defined by the shop.

Kind Type
Used in Cart2, CustomerBalance3, ListCustomers3, LoggedOutBalance1

Properties

  • name string required

    The name of the tier.

  • code string required

    The tier's API code.

  • start_time time required but can be null

    When the customer reached this tier.

    Only set for the customer's current tier (cur_tier and its entry in tiers); null for other tiers and when unknown.

  • start_day date required but can be empty

    The shop-local day the customer reached this tier.

    Only set for the customer's current tier (cur_tier and its entry in tiers); an empty string for other tiers and when unknown.

  • expiration TierExpirationStatus3 optional

    Describes when and how the tier is going to expire. Null if never.

    Only set for the customer's current tier; always null on next_tier.

  • reqs TierRequirements3 required

    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.

  • features array of TierFeatureValue1 only present in the tiers array when include_full_program is enabled

    The feature values available at this tier.

    This field is only populated for tiers in the tiers array when include_full_program is true.

    The cur_tier and next_tier fields will NOT include features.

  • redemption_limit RedemptionLimitInfo1 only present in the tiers array when include_full_program is enabled and tier has a limit

    The redemption limit configuration for this tier.

    This field is only populated for tiers in the tiers array when include_full_program is 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 remaining points value reflects their actual usage. For other tiers, it shows the full points limit that would be available if they were in that tier.

Previous
TierRequirements3