Credit Balance

Deprecated. The creditBalanceSummary query is deprecated. Use the Entitlements API with a credit entitlement instead — the entitlement response includes the same data (currentBalance, totalConsumed, totalGranted, currency).

Retrieves the credit balance summary for a specific customer.

Query

Query

query GetCreditBalance($input: CreditBalanceSummaryInput!) {
  creditBalanceSummary(input: $input) {
    balance
    effectiveBalance
    currency
    customerId
  }
}

{
  "input": {
    "customerId": "customer-123"
  }
}

{
  "data": {
    "creditBalanceSummary": {
      "balance": 5000,
      "effectiveBalance": 4500,
      "currency": "CREDITS",
      "customerId": "customer-123"
    }
  }
}

Parameters

input · CreditBalanceSummaryInput · required

Input parameters for credit balance query

Show properties

customerId · String · required

The customer’s reference ID

resourceId · String

Resource ID for multi-resource customers

environmentId · UUID

Environment ID

Return Type

Returns a CreditBalanceSummary object with:

Field	Type	Description
balance	Float	Total credit balance
effectiveBalance	Float	Available credits after reservations
currency	String	Credit currency type
customerId	String	Customer reference ID

Common Use Cases

Display balance

Show customers their current credit balance in your app.

Check before purchase

Verify sufficient credits before allowing credit-based actions.

Low balance alerts

Monitor balance to trigger auto-recharge or alerts.

Related Operations

• Credit Grants - List grants
• Credit Ledger - Transaction history
• Create Credit Grant - Grant credits