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

# Get a customer's agent balance

> The mode-shaped live balance: the wallet shadow balance (wallet minus unsettled, correct the instant a consume commits), the credit pot, or every rolling window's remaining allowance with its reset instant — decided by the scope's mode. `agents` lists each agent with a pool of its own. This is the operator's read of what the runtime `snapshot` endpoint answers the customer's integration.



## OpenAPI

````yaml get /v1/agents/customers/{customer_id}/balance
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/agents/customers/{customer_id}/balance:
    get:
      tags:
        - Agents
      summary: Get a customer's agent balance
      description: >-
        The mode-shaped live balance: the wallet shadow balance (wallet minus
        unsettled, correct the instant a consume commits), the credit pot, or
        every rolling window's remaining allowance with its reset instant —
        decided by the scope's mode. `agents` lists each agent with a pool of
        its own. This is the operator's read of what the runtime `snapshot`
        endpoint answers the customer's integration.
      operationId: getAgentCustomerBalance
      parameters:
        - schema:
            type: string
          required: true
          name: customer_id
          in: path
        - schema:
            type: string
            minLength: 1
            maxLength: 128
          required: false
          name: agent
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  agent:
                    type:
                      - string
                      - 'null'
                  mode:
                    type:
                      - string
                      - 'null'
                    enum:
                      - wallet
                      - credits
                      - windows
                  balance:
                    type: object
                    properties:
                      denomination:
                        type: string
                        enum:
                          - minor_units
                          - credits
                          - units
                      wallet:
                        type: string
                      unsettled:
                        type: string
                      available:
                        type: string
                    required:
                      - denomination
                      - wallet
                      - unsettled
                      - available
                  blocked:
                    type: boolean
                  policy:
                    type:
                      - object
                      - 'null'
                    properties:
                      markup_percent:
                        type: string
                      floor:
                        type: string
                      plan_name:
                        type:
                          - string
                          - 'null'
                      settlement_interval_minutes:
                        type:
                          - number
                          - 'null'
                    required:
                      - markup_percent
                      - floor
                      - plan_name
                      - settlement_interval_minutes
                  meters:
                    type:
                      - array
                      - 'null'
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        included_units:
                          type: string
                        used_units:
                          type: string
                        remaining_units:
                          type: string
                        window_started_at:
                          type:
                            - string
                            - 'null'
                        resets_at:
                          type:
                            - string
                            - 'null'
                      required:
                        - key
                        - included_units
                        - used_units
                        - remaining_units
                        - window_started_at
                        - resets_at
                  credits:
                    type:
                      - object
                      - 'null'
                    properties:
                      balance:
                        type: string
                      currency:
                        type: 'null'
                      product_id:
                        type: string
                      aggregator_on_customer_id:
                        type: string
                      low_balance_threshold:
                        type:
                          - string
                          - 'null'
                      expiring_soon:
                        type: array
                        items:
                          type: object
                          properties:
                            amount:
                              type: string
                            expires_at:
                              type: string
                          required:
                            - amount
                            - expires_at
                      rate_card_summary:
                        type: object
                        properties:
                          llm_rows:
                            type: number
                          item_rows:
                            type: number
                          has_default_llm_row:
                            type: boolean
                          fallback_credits_per_usd:
                            type:
                              - string
                              - 'null'
                        required:
                          - llm_rows
                          - item_rows
                          - has_default_llm_row
                          - fallback_credits_per_usd
                    required:
                      - balance
                      - currency
                      - product_id
                      - aggregator_on_customer_id
                      - low_balance_threshold
                      - expiring_soon
                      - rate_card_summary
                  overage:
                    type:
                      - object
                      - 'null'
                    properties:
                      mode:
                        type: string
                        enum:
                          - refuse
                          - metered
                      active:
                        type: boolean
                      unsettled:
                        type: string
                    required:
                      - mode
                      - active
                      - unsettled
                  last_settled_at:
                    type:
                      - string
                      - 'null'
                  agents:
                    type: array
                    items:
                      type: object
                      properties:
                        agent:
                          type: string
                        mode:
                          type: string
                          enum:
                            - wallet
                            - credits
                            - windows
                        balance:
                          type: object
                          properties:
                            denomination:
                              type: string
                              enum:
                                - minor_units
                                - credits
                                - units
                            wallet:
                              type: string
                            unsettled:
                              type: string
                            available:
                              type: string
                          required:
                            - denomination
                            - wallet
                            - unsettled
                            - available
                        blocked:
                          type: boolean
                        meters:
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              included_units:
                                type: string
                              used_units:
                                type: string
                              remaining_units:
                                type: string
                              window_started_at:
                                type:
                                  - string
                                  - 'null'
                              resets_at:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - key
                              - included_units
                              - used_units
                              - remaining_units
                              - window_started_at
                              - resets_at
                        overage:
                          type:
                            - object
                            - 'null'
                          properties:
                            mode:
                              type: string
                              enum:
                                - refuse
                                - metered
                            active:
                              type: boolean
                            unsettled:
                              type: string
                          required:
                            - mode
                            - active
                            - unsettled
                      required:
                        - agent
                        - mode
                        - balance
                        - blocked
                        - meters
                        - overage
                required:
                  - agent
                  - mode
                  - balance
                  - blocked
                  - policy
                  - meters
                  - credits
                  - overage
                  - last_settled_at
                  - agents
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````