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

# Get billing balance

> Returns wallet balance, reserved amount, lifetime totals, and top-up options.



## OpenAPI

````yaml /openapi.json get /dashboard/billing/balance
openapi: 3.0.3
info:
  title: AtlasFlux API
  description: >-
    Unified AI model routing API with intelligent model selection, web search,
    reasoning, and prepaid MYR billing.
  version: 1.0.0
  contact:
    name: Rainspeed Labs
    url: https://atlasflux.my
  license:
    name: Proprietary
servers:
  - url: https://api.atlasflux.my
    description: Production
security:
  - apiKeyAuth: []
paths:
  /dashboard/billing/balance:
    get:
      tags:
        - Dashboard — Billing
      summary: Get billing balance
      description: >-
        Returns wallet balance, reserved amount, lifetime totals, and top-up
        options.
      operationId: getBillingBalance
      responses:
        '200':
          description: Billing balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - clerkAuth: []
components:
  schemas:
    BalanceResponse:
      type: object
      properties:
        wallet:
          type: object
          nullable: true
          properties:
            availableMicroMyr:
              type: integer
            reservedMicroMyr:
              type: integer
            lifetimeTopupMicroMyr:
              type: integer
            lifetimeSpendMicroMyr:
              type: integer
        balance_myr:
          type: number
        reserved_myr:
          type: number
        lifetime_topup_myr:
          type: number
        lifetime_spend_myr:
          type: number
        topup_options_sen:
          type: array
          items:
            type: integer
    ErrorResponse:
      type: object
      required:
        - type
        - error
      properties:
        type:
          type: string
          enum:
            - error
        error:
          type: object
          required:
            - message
            - type
            - code
            - param
            - request_id
            - guidance
            - action_url
            - retryable
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
              enum:
                - invalid_request
                - authentication_error
                - invalid_api_key
                - expired_api_key
                - revoked_api_key
                - permission_denied
                - insufficient_balance
                - spend_limit_exceeded
                - rate_limit_exceeded
                - context_length_exceeded
                - unsupported_input
                - provider_unavailable
                - provider_timeout
                - search_error
                - billing_error
                - idempotency_conflict
                - not_implemented
                - internal_error
            param:
              type: string
              nullable: true
            request_id:
              type: string
            guidance:
              type: string
            action_url:
              type: string
              format: uri
              nullable: true
            retryable:
              type: boolean
            retry_after_seconds:
              type: integer
              minimum: 0
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: af_live_... or af_test_...
      description: AtlasFlux API key. Get yours from the Developer Dashboard.
    clerkAuth:
      type: http
      scheme: bearer
      bearerFormat: Clerk JWT
      description: Clerk session token. Used by the Developer Dashboard.

````

## Related topics

- [Get transaction history](/api-reference/dashboard-—-billing/get-transaction-history.md)
- [API Reference](/api-reference/overview.md)
- [Support](/resources/support.md)
- [Get usage data](/api-reference/dashboard-—-usage/get-usage-data.md)
- [Get dashboard overview](/api-reference/dashboard-—-overview/get-dashboard-overview.md)