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

# Get Credit Balance

> Returns your account's credit balance: the total allowance, credits consumed and credits remaining.

<Info>**No API key yet?** [Sign up via Agent Auth](/agent-primitives/authentication) to get your `X-API-Key` - the only required header for this endpoint.</Info>



## OpenAPI

````yaml agent-primitives/openapi.json GET /api/v1/credits/balance
openapi: 3.1.0
info:
  title: OpenFunnel Agent Primitives
  version: 1.0.0
servers:
  - url: https://api.openfunnel.dev
security: []
paths:
  /api/v1/credits/balance:
    get:
      tags:
        - Credits
      summary: Get Credit Balance
      description: >-
        Returns your account's credit balance: the total allowance, credits
        consumed and credits remaining.


        <Info>**No API key yet?** [Sign up via Agent
        Auth](/agent-primitives/authentication) to get your `X-API-Key` - the
        only required header for this endpoint.</Info>
      operationId: credits_balance
      parameters:
        - name: X-API-Key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalanceResponse'
              example:
                total_credits: 200
                credits_used: 37.5
                credits_left: 162.5
      x-codeSamples:
        - lang: bash
          label: Get credit balance
          source: |-
            curl -sS "https://api.openfunnel.dev/api/v1/credits/balance" \
              -H "X-API-Key: YOUR_API_KEY"
components:
  schemas:
    CreditBalanceResponse:
      type: object
      title: CreditBalanceResponse
      description: Your account's credit balance
      required:
        - total_credits
        - credits_used
        - credits_left
      properties:
        total_credits:
          type: number
          title: Total Credits
          description: The credit allowance for your billing account.
        credits_used:
          type: number
          title: Credits Used
          description: Credits consumed
        credits_left:
          type: number
          title: Credits Left
          description: Remaining credits

````