Skip to main content
Deprecated. The creditBalanceSummary query is deprecated. Use the Entitlements API with a credit entitlement instead — credits were moved onto the same entitlements response shape as every other entitlement type, to get the low-latency, availability, and caching benefits of the Entitlements API.A CreditEntitlement doesn’t return a balance field directly. Instead it returns:
  • currentUsage — the amount of credits consumed
  • usageLimit — the total amount of credits granted
Calculate the balance on your end as usageLimit - currentUsage.
Retrieves the credit balance summary for a specific customer.

Query

Parameters

CreditBalanceSummaryInput
required
Input parameters for credit balance query

Return Type

Returns a CreditBalanceSummary object with:

Common Use Cases

Show customers their current credit balance in your app.
Verify sufficient credits before allowing credit-based actions.
Monitor balance to trigger auto-recharge or alerts.