LoyaltyTierGrant

When an Enrollment (automatically or manually) reaches a Tier, it is awarded a new Tier Grant that expires after a period of time (as determined by the Tier System Configuration and applicable Tier Grant Rules). Enrollments can have multiple active grants, varying in Tier and term (e.g. an automatically earned "Gold" grant that expires in a year, and a temporary, manually awarded "Platinum" grant given for 30 days).

Which Tier an Enrollment is "in" (i.e. which Reward Catalogs and Point Accrual Rules they will have access to) is determined exclusively by the "highest" active Tier (as determined by the Tier order) that they have an active (non-voided) Grant for.

When an Enrollment has no active Grants, they will be given access to the lowest Tier by default.

  • tier_id
    Type: integer
    required

    Sparkfly ID of the Tier

  • created_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • end_date
    Type: stringFormat: date

    defines the end of the grant’s term, based on grant_term_type/length settings in the Tier System Configuration for automatic grants

  • enrollment_id
    Type: integer
    read-only

    Sparkfly ID of the Enrollment

  • id
    Type: integer
    read-only

    Unique ID generated by Sparkfly

  • type
    Type: stringenum
    read-only
    • automatic - automatically awarded through point earn activity
    • manual - assigned manually
    values
    • automatic
    • manual
  • updated_at
    Type: stringFormat: date-time
    read-only

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • voided_at
    Type: stringFormat: date-time
    read-only

    when set, denotes that, and when, the Tier Grant was expired or manually voided