Skip to main content
Retrieves the credit balance summary for a specific customer.

​
Query

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

​
Parameters

​
input
CreditBalanceSummaryInput
required
Input parameters for credit balance query

​
Return Type

Returns a CreditBalanceSummary object with:
FieldTypeDescription
balanceFloatTotal credit balance
effectiveBalanceFloatAvailable credits after reservations
currencyStringCredit currency type
customerIdStringCustomer reference ID

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