Get Customer Balance

The total number of points the customer has, including pending points.

The total monetary value of the customer's points, including pending points.

The number of points that are currently active and available for use (excludes pending points).

The monetary value of the points that are currently active and available for use (excludes pending points).

The points earned by the customer that are temporarily on hold during the return window configured for your account. These points will remain in a pending status until the return period expires, ensuring that the points are not used or redeemed until it is confirmed that the transaction is final and not subject to returns or cancellations. Example: If a customer places an order and earns 100 points, and your account is configured with a 14-day return window, these 100 points will remain pending for 14 days. During this time, the customer cannot use or redeem the points. After the 14-day window expires and the order is confirmed as final, the 100 points will become available for the customer to use.

The monetary value of the pending points.

The currency in which the points value is calculated.

The name of the points used in your loyalty program that appears to customers. This is the term your customers will see when they earn or redeem points. Example: If your loyalty program rewards customers with "Stars" instead of generic "Points", the value of pointsName could be "Stars".

The amount of points that are set to expire next. Points expire when the configured point expiry duration has passed, and the points have not been used within that time frame.

The monetary value of the points that are set to expire next. Points expire when the configured point expiry duration has passed, and the points have not been used within that time frame.

The date when the next set of points will expire. Points expire when the configured point expiry duration has passed, and the points have not been used within that time frame.

The total number of points that the customer has earned over their entire lifetime within the Gameball program. This includes all points accumulated from various activities like cashback rewards, referrals, or rewards campaigns.