LoyaltyTierSystemsConfig

Determines how optional Loyalty Enrollment Tiering will work within a Loyalty Program, specifically how point earning activity is determined as qualifying (or not) toward meeting Tier requirements, and how long Enrollments are granted access to Tiers.

Specific criteria (e.g. how many lifetime points are needed) for earning into each Tier is configured at the Tier level (see Loyalty Tier Grant Rule).

  • align_renewal_with_tier_term_end
    Type: boolean
    required

    Enrollments are automatically evaluated for tiers whenever they earn points. By default, evaluation uses point threshold lookback windows and calculates the end of grant terms based on that evaluation date for both advancement (moving to a higher tier) and renewal (qualifying for the same or lower tier for an extended period).

    When this setting is true, renewal evaluations consider qualifying points as those earned during an enrollment's current "Tier Term" (see tier_term_start_time and tier_term_end_date on the Loyalty Enrollment). Renewal tier grants end a full grant term after the current Tier Term ends. "Tier Terms" typically (re)start when enrollments automatically advance tiers, end on the same date as the corresponding tier grants, and are extended a full grant term if they lapse.

    Example with anniversary-based renewal: An enrollment advances to "Silver" on June 1, 2025, making the end of their tier term June 1, 2026 (a 365-day grant term later). Throughout that year, renewal evaluation checks if they qualify for "Silver" based only on points earned during that time. If they do, a renewal grant is issued that ends on June 1, 2027 (365 days from their upcoming anniversary/term end). If the enrollment does not advance to "Gold" by June 1, 2026, their tier term would reset to end on June 1, 2027.

    Note: Advancement always uses the current date for evaluation. This setting only affects renewal behavior.

  • grant_term_type
    Type: stringenum
    required

    determines if and if so how long an enrollment gets to remain in a tier (assuming inactivity) once they are granted access.

    • permanent - when automatically granted access to a tier, an enrollment's access does not expire.
    • calendar_years - when automatically granted access to a tier, an enrollment retains access for n calendar years, inclusive of the current year (e.g. if "Gold Tier" is earned in June 2024, and a program configures a term type/length of "2 calendar years", the enrollment would remain at least in "Gold Tier" through December 31st, 2025).
    • relative_days - when automatically granted access to a tier, access is retained for the following n days.
    values
    • permanent
    • calendar_years
    • relative_days
  • point_threshold_length
    Type: integer
    required

    quantifies point_threshold_type if applicable (e.g. 2 calendar years).

  • point_threshold_type
    Type: stringenum
    required

    determines which point values contribute toward meeting tier thresholds.

    • total_historical - enrollments are granted access to tiers upon reaching a lifetime earned point total. Since tiers would not be based on recency or frequency of activity, programs using this setting would generally be expected to award tiers permanently (grant_term_type set to permanent).
    • calendar_years - enrollments are granted access to tiers based on how many points they have earned over the course of the past n calendar years, inclusive of the current year.
    • relative_days - enrollments are granted access to tiers based on how many points they have earned over the course of the past n relative days.
    values
    • total_historical
    • calendar_years
    • relative_days
  • enabled
    Type: boolean

    determines whether tiering is enabled for the program.

  • grant_term_length
    Type: integer

    quantifies grant_term_type if applicable. If grant_term_type is permanent, this will be set to 0.