LoyaltyTierProgress

Gives information on how many Points are needed to advance to higher Tiers.

  • current_tier
    Type: object

    The tier the enrollment currently holds. Absent when the enrollment is not associated with any active tier

    • id
      Type: integer
      required

      The unique identifier of the tier the enrollment currently holds

    • name
      Type: string
      required

      The display name of the tier the enrollment currently holds

    • end_date
      Type: string Format: date

      The date through which the enrollment's current tier is granted. Absent when the current tier doesn't end (e.g. the enrollment holds the tier permanently, or no end date applies)

  • qualifying_points
    Type: integer

    Total number of points earned by the enrollment that count towards tier progress. This is calculated based on the program's tier system configuration (e.g. total historical points, points earned within calendar years, or points earned within relative days).

  • tier_progress
    Type: array object[]
    • point_threshold
      Type: integer

      the grant rule's point threshold required to achieve this tier

    • points_remaining
      Type: integer

      the amount of points needed to advance to that tier

    • tier_id
      Type: integer

      the unique identifier for the tier

    • tier_name
      Type: string

      short identifier for the tier