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

# Get account balance

> Returns the balance for the account associated with the authenticated API key. No account ID or currency parameter is required. The account is determined by the key.

The response is an approximate snapshot, not a guarantee of request admission. The service may reuse a snapshot for about two seconds. `as_of` is the UTC time the snapshot was generated. Responses include `Cache-Control: no-store`; clients and intermediaries should not cache them. Monetary values are decimal strings; use a decimal or fixed-point type for calculations.



## OpenAPI

````yaml /openapi/credits/_balance.yaml get /billing/account/balance
openapi: 3.0.3
info:
  title: Get account balance
  version: 1.0.0
  description: Get account balance
servers:
  - url: https://api.linkmodel.ai/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: credits
paths:
  /billing/account/balance:
    get:
      tags:
        - credits
      summary: Get account balance
      description: >-
        Returns the balance for the account associated with the authenticated
        API key. No account ID or currency parameter is required. The account is
        determined by the key.


        The response is an approximate snapshot, not a guarantee of request
        admission. The service may reuse a snapshot for about two seconds.
        `as_of` is the UTC time the snapshot was generated. Responses include
        `Cache-Control: no-store`; clients and intermediaries should not cache
        them. Monetary values are decimal strings; use a decimal or fixed-point
        type for calculations.
      operationId: get-account-balance
      responses:
        '200':
          description: Snapshot returned successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - currency
                  - wallet_balance
                  - usable_credit
                  - available_total
                  - credit_status
                  - as_of
                properties:
                  currency:
                    type: string
                    description: >-
                      Settlement currency configured by the service. The current
                      production default is USD.
                    example: USD
                  wallet_balance:
                    type: string
                    description: Wallet balance, with six decimal places.
                    example: '10.000000'
                  usable_credit:
                    type: string
                    description: >-
                      Available credit: credit limit minus used and frozen
                      credit, with a minimum of zero. Zero when credit is
                      absent, disabled, or restricted.
                    example: '5.000000'
                  available_total:
                    type: string
                    description: Sum of wallet_balance and usable_credit.
                    example: '15.000000'
                  credit_status:
                    type: string
                    enum:
                      - none
                      - active
                      - disabled
                      - restricted
                    description: >-
                      Credit account status. `none` means no credit account;
                      `restricted` indicates a risk restriction.
                    example: active
                  as_of:
                    type: string
                    format: date-time
                    description: UTC snapshot time.
                    example: '2026-11-10T10:00:00Z'
        '401':
          description: Missing, invalid, or unavailable API key identity.
        '429':
          description: >-
            Gateway rate limit reached. Reduce request frequency and retry with
            backoff.
        '503':
          description: >-
            Authentication or billing dependency temporarily unavailable, or
            quota querying is disabled. Retry later with backoff.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.