Account Balance Attributes (Object)
- bankedType: numberFormat: double
_rewards Banked rewards value of the current account
- expiredType: string | null
_membership _level Expired membership level (if any) of the current account
- giftedType: string | null
_tier The user's currently active gifted tier, such as "Gold Level".
Note:
- When in the Program Meta API,
membership_tier_boostis set toenabledordisable_keep_active, the response includesgifted_tierandmembership_tier_expiry_at. - The
gifted_tierandmembership_tier_expiry_atare 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_boostis set todisabled,gifted_tierandmembership_tier_expiry_atare omitted from the response.
- When in the Program Meta API,
- initialType: integer
_visits Visits registered before migration
- membershipType: string
_level Membership level of the current account
- membershipType: integer
_level _id ID of membership level
- membershipType: integer
_qualification _points 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.
- membershipType: string | nullFormat: date-time
_tier _expiry _at The date and time when the gifted tier expires, in ISO 8601 format.
Note:
- When in the Program Meta API,
membership_tier_boostis set toenabledordisable_keep_active, the response includesgifted_tierandmembership_tier_expiry_at. - The
gifted_tierandmembership_tier_expiry_atare 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_boostis set todisabled,gifted_tierandmembership_tier_expiry_atare omitted from the response.
- When in the Program Meta API,
- netType: numberFormat: double
_balance Net balance of the current account
- netType: numberFormat: double
_debits Net debits of the current account
- pendingType: integer
_points Pending points of the current account
- pointsType: numberFormat: double
_balance Points balance of the current account
- signupType: string
_anniversary _day Sign-up anniversary day of the current account
- totalType: numberFormat: double
_credits Total credits of the current account
- totalType: numberFormat: double
_debits Total debits of the current account
- totalType: numberFormat: double
_point _credits Total point credits of the current account
- totalType: integer
_redeemable _visits Total redeemable visits of the current account
- totalType: integer
_visits Total number of loyalty visits
- unredeemedType: integer
_cards Number of unredeemed cards of the user
