> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stigg.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit Balance

<Warning>
  **Deprecated.** The `creditBalanceSummary` query is deprecated. Use the [Entitlements API](/api-and-sdks/api-reference/overview) with a credit entitlement instead — the entitlement response includes the same data (`currentBalance`, `totalConsumed`, `totalGranted`, `currency`).
</Warning>

Retrieves the credit balance summary for a specific customer.

## Query

<CodeGroup>
  ```graphql Query theme={null}
  query GetCreditBalance($input: CreditBalanceSummaryInput!) {
    creditBalanceSummary(input: $input) {
      balance
      effectiveBalance
      currency
      customerId
    }
  }
  ```

  ```json Variables theme={null}
  {
    "input": {
      "customerId": "customer-123"
    }
  }
  ```

  ```json Response theme={null}
  {
    "data": {
      "creditBalanceSummary": {
        "balance": 5000,
        "effectiveBalance": 4500,
        "currency": "CREDITS",
        "customerId": "customer-123"
      }
    }
  }
  ```
</CodeGroup>

## Parameters

<ParamField body="input" type="CreditBalanceSummaryInput" required>
  Input parameters for credit balance query

  <Expandable title="properties">
    <ParamField body="customerId" type="String" required>
      The customer's reference ID
    </ParamField>

    <ParamField body="resourceId" type="String">
      Resource ID for multi-resource customers
    </ParamField>

    <ParamField body="environmentId" type="UUID">
      Environment ID
    </ParamField>
  </Expandable>
</ParamField>

## 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

<AccordionGroup>
  <Accordion title="Display balance">
    Show customers their current credit balance in your app.
  </Accordion>

  <Accordion title="Check before purchase">
    Verify sufficient credits before allowing credit-based actions.
  </Accordion>

  <Accordion title="Low balance alerts">
    Monitor balance to trigger auto-recharge or alerts.
  </Accordion>
</AccordionGroup>

## Related Operations

* [Credit Grants](/api-and-sdks/api-reference/queries/credit-grants) - List grants
* [Credit Ledger](/api-and-sdks/api-reference/queries/credit-ledger) - Transaction history
* [Create Credit Grant](/api-and-sdks/api-reference/mutations/create-credit-grant) - Grant credits