Account Balance Details (Object)

Value of the currency that a user has available. A "null" value indicates that the business does not support banking of points into currency.

If a business is configured to support expiring banked currency, this returns the date on which it will expire. A "null" value indicates that the business is not configured to support expiring banked currency.

A card gets completed after a user does a configured number of check-ins. For example, if a business configuration requires 7 check-ins to complete a card, and a user does only 3 check-ins, the value of this parameter will be 3.

If a business has a rolling expiry of membership levels, a particular membership level will expire after a period that is configured in the Punchh platform. A "null" value indicates that the business does not have a rolling expiry of membership levels.

Unique ID of the current membership level of a user

Current membership level of the user

If a business has expiring banked currency configured in the Punchh platform, the banked currency will expire in a FIFO (first-in, first-out) pattern. This returns the value of the banked currency that will expire. A "null" value indicates that the business is not configured to support expiring banked currency.

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 disabled_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.

Sum of all loyalty points earned by a user from the time the user signed up

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 disabled_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.

Points of a user that are in the pending state after a check-in. They are not added to the user's account before finalization. See Pending Points Feature Overview for details.

The total of all loyalty points earned by a user that satisfy all of the following conditions:

• approved
• non-pending
• unexpired

The number of cards that a user has redeemed in the user's lifetime

Total of the visits that a user has earned by doing loyalty check-ins and those visits that were migrated from an older loyalty program (if a business had an older loyalty program and wants to migrate its users to Punchh's loyalty program)

For a business that allows banking of points, this value represents the number of points the user has and has not banked yet. For example, if a business configuration requires 100 points to be banked to $10, and a user has accumulated 55 points, this value will be 55. When the user earns another 45 points, the user will be banked to $10 and this value will then become 0.

Total unredeemed cards available to a user