LoyaltyEnrollment

A Sparkfly Member's enrollment into a Sparkfly Loyalty Program.

When updating, already existing fields omitted from the payload will generally not be deleted unless otherwise specified.

  • member_id
    Type: integer
    required

    ID of the backing Sparkfly Member being enrolled.

  • 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

  • external_id
    Type: string
  • fraud_risk_level
    Type: stringenum

    The assessed fraud risk level for this enrollment. Used to flag potentially suspicious enrollments for review.

    values
    • none
    • low
    • medium
    • high
  • historical_points
    Type: integer
    read-only

    Total amount of points credited to a Member since they were first enrolled.

  • id
    Type: integer
    read-only

    Unique identifier for the Enrollment.

  • point_balance
    Type: integer
    read-only

    Current balance of non-expired points available for use.

  • program_id
    Type: integer
    read-only

    ID of the Loyalty Program the enrollment is for.

  • source
    Type: string

    General purpose field available to track how Members signed up (e.g. "app", "referral", "in-person", etc.)

  • status
    Type: stringenum
    read-only

    Status of the Member's enrollment.

    values
    • active
    • suspended
    • archived
  • tier_id
    Type: integer
    read-only

    This will get returned on all enrollment endpoints except for the Get Enrollments route.

  • tier_term_end_date
    Type: stringFormat: date
    read-only

    The last day of an Enrollment's current "Tier Term". Each Tier Term spans one full grant term (see grant_term_type), whether it originated from an automatic tier advancement or was extended after a previous term lapsed. This is a fully inclusive UTC date (a Tier Term ends at midnight of the following date if they don't advance before). This field is only used by tiered Programs that are configured to align renewals with tier term end dates (see align_renewal_with_tier_term_end).

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

    The start of the Enrollment's current "Tier Term". This is a UTC timestamp representing either the moment an enrollment last automatically advanced tiers (see LoyaltyTierGrant type) or immediately following the end_date of a previous, lapsed tier term. This field is only used by tiered Programs that are configured to align renewals with tier term end dates (see align_renewal_with_tier_term_end).

  • 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