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

# Retrieve an account balance for a usage source.

> Returns active, effective, non-expired grants for the requested metric or currency minus corrected all-time usage for that source.



## OpenAPI

````yaml /openapi/ledgerup-engine.json get /v2/accounts/{account_id}/balance
openapi: 3.1.0
info:
  title: LedgerUp API
  version: 0.1.0
  description: OpenAPI contract for the LedgerUp API.
servers: []
security: []
tags:
  - name: Health
  - name: Customers
  - name: Accounts
  - name: Grants
  - name: Currencies
    description: Currencies discovered from reported usage events.
  - name: Metrics
  - name: Refill Configurations
    description: Automatic balance refill thresholds and targets for an account and metric.
  - name: Events
    description: >-
      Individual usage events reported against an account and either a metric or
      currency.
  - name: Test
    description: Endpoints for test environment maintenance.
  - name: Products
    x-group: Billing
    description: Sellable catalog objects. Products can map to Stripe products.
  - name: Prices
    x-group: Billing
    description: >-
      Simple commercial terms for a product. Contract lines can reference a
      price or a rate card, but not both.
  - name: Rate Cards
    x-group: Billing
    description: Reusable rating policies that convert engine facts into billable amounts.
  - name: Contracts
    x-group: Billing
    description: >-
      Subscription-like commercial agreements. Contracts own contract lines and
      cancellation state.
  - name: Invoice Preview
    x-group: Billing
    description: Read-only preview of LedgerUp invoice lines before any Stripe write.
paths:
  /v2/accounts/{account_id}/balance:
    get:
      tags:
        - Accounts
      summary: Retrieve an account balance for a usage source.
      description: >-
        Returns active, effective, non-expired grants for the requested metric
        or currency minus corrected all-time usage for that source.
      operationId: getAccountBalance
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
            description: LedgerUp account identifier.
            example: account_0194f4e3a2b77c6aa91c4f6b4db2a980
            pattern: ^account_[0-9a-f]{32}$
          description: Resource identifier.
        - name: metric_id
          in: query
          required: false
          schema:
            type: string
            description: LedgerUp metric identifier.
            example: metric_0194f4e3a2b77c6aa91c4f6b4db2a980
            pattern: ^metric_[0-9a-f]{32}$
          description: >-
            Metric whose usage is subtracted from the account grants. Exactly
            one of metric_id or currency is required.
        - name: currency
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Za-z]{3}$
            example: usd
          description: >-
            Currency whose usage is subtracted from currency grants. Exactly one
            of metric_id or currency is required.
      responses:
        '200':
          description: Account balance for the requested metric or currency.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalance'
        '400':
          $ref: '#/components/responses/BadRequestText'
        '401':
          $ref: '#/components/responses/UnauthorizedText'
        '403':
          $ref: '#/components/responses/ForbiddenText'
        '404':
          $ref: '#/components/responses/NotFoundText'
        '408':
          $ref: '#/components/responses/RequestTimeoutText'
        '429':
          $ref: '#/components/responses/RateLimitedText'
        '500':
          $ref: '#/components/responses/InternalServerErrorText'
      security:
        - LedgerUpApiKey: []
components:
  schemas:
    AccountBalance:
      type: object
      additionalProperties: false
      properties:
        account_id:
          type: string
          description: LedgerUp account identifier.
          example: account_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^account_[0-9a-f]{32}$
        metric_id:
          type:
            - string
            - 'null'
          description: LedgerUp metric identifier. Null for a currency balance.
          example: metric_0194f4e3a2b77c6aa91c4f6b4db2a980
          pattern: ^metric_[0-9a-f]{32}$
        currency:
          type:
            - string
            - 'null'
          description: Lowercase currency code. Null for a metric balance.
          example: usd
          pattern: ^[a-z]{3}$
        grant_total:
          type: string
          description: Sum of all grants for the account, serialized as a string.
          example: '1000'
          pattern: ^-?\d+(\.\d+)?$
        usage_total:
          type: string
          description: >-
            Sum of corrected usage events for the metric, serialized as a
            string.
          example: '275.5'
          pattern: ^-?\d+(\.\d+)?$
        balance:
          type: string
          description: grant_total minus usage_total, serialized as a string.
          example: '724.5'
          pattern: ^-?\d+(\.\d+)?$
      required:
        - account_id
        - metric_id
        - currency
        - grant_total
        - usage_total
        - balance
  responses:
    BadRequestText:
      description: >-
        Bad request, invalid header, invalid amount/quantity/currency, or text
        validation failure.
      content:
        text/plain:
          schema:
            type: string
    UnauthorizedText:
      description: Missing or invalid API key.
      content:
        text/plain:
          schema:
            type: string
            example: Invalid API key
    ForbiddenText:
      description: >-
        API key lacks the required permission, or reset was attempted outside
        the test namespace.
      content:
        text/plain:
          schema:
            type: string
    NotFoundText:
      description: Referenced or requested resource was not found.
      content:
        text/plain:
          schema:
            type: string
            example: not found
    RequestTimeoutText:
      description: Request exceeded the 30 second timeout.
      content:
        text/plain:
          schema:
            type: string
    RateLimitedText:
      description: Rate limit exceeded.
      content:
        text/plain:
          schema:
            type: string
            example: rate limit exceeded
    InternalServerErrorText:
      description: Internal server error or queue failure.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    LedgerUpApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: LedgerUp API Key.
      x-displayName: LedgerUp API Key

````