Account Balance Attributes (Object)

  • Banked rewards value of the current account

  • Expired membership level (if any) of the current account

  • The user's currently active gifted tier, such as "Gold Level".

    Note:

    • When in the Program Meta API, membership_tier_boost is set to enabled or disable_keep_active, the response includes gifted_tier and membership_tier_expiry_at.
    • The gifted_tier and membership_tier_expiry_at are returned with null values when the gifted tier is lower than the user's current operative tier, the gifted tier has expired, or the gifted tier is the same as the user's current operative tier.
    • When membership_tier_boost is set to disabled, gifted_tier and membership_tier_expiry_at are omitted from the response.
  • Visits registered before migration

  • Membership level of the current account

  • ID of membership level

  • The value of points earned toward progress across membership tiers. This is related to the migration strategy that allows businesses to "Consider Only Initial Points for Tier Migration". Currently, support for this parameter is limited to program type Points Unlock Redeemables, Membership Re-evaluation Strategy: Reset Based on Points Earned and Account Re-evaluation Strategy of Guest Inactivity.

  • The date and time when the gifted tier expires, in ISO 8601 format.

    Note:

    • When in the Program Meta API, membership_tier_boost is set to enabled or disable_keep_active, the response includes gifted_tier and membership_tier_expiry_at.
    • The gifted_tier and membership_tier_expiry_at are returned with null values when the gifted tier is lower than the user's current operative tier, the gifted tier has expired, or the gifted tier is the same as the user's current operative tier.
    • When membership_tier_boost is set to disabled, gifted_tier and membership_tier_expiry_at are omitted from the response.
  • Net balance of the current account

  • Net debits of the current account

  • Pending points of the current account

  • Points balance of the current account

  • Sign-up anniversary day of the current account

  • Total credits of the current account

  • Total debits of the current account

  • Total point credits of the current account

  • Total redeemable visits of the current account

  • Total number of loyalty visits

  • Number of unredeemed cards of the user