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

# Balance and plan

> Creates the account on first call and applies the monthly free grant if this is the first request of a new calendar month.



## OpenAPI

````yaml /api-reference/billing.json get /api/billing/account
openapi: 3.1.0
info:
  title: truscan billing
  version: 1.0.0
  description: >-
    Credits, metering and top-ups. Money is counted in MICRO-DOLLARS (millionths
    of a dollar) as integers everywhere, so $7.00 per 1,000 requests is exactly
    7,000 micros per request. Floats drift, and a billing system that drifts
    gets disputed. Every amount is accompanied by a pre-formatted display string
    so no client reimplements money formatting. All responses use the {success,
    result, message} envelope except health and the webhook.
servers:
  - url: https://api.truscan.co
    description: Production
security: []
paths:
  /api/billing/account:
    get:
      summary: Balance and plan
      description: >-
        Creates the account on first call and applies the monthly free grant if
        this is the first request of a new calendar month.
      responses:
        '200':
          description: The caller's billing state
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  result:
                    $ref: '#/components/schemas/Account'
        '401':
          $ref: '#/components/responses/Failure'
components:
  schemas:
    Account:
      type: object
      properties:
        user_id:
          type: string
        balance_micros:
          type: integer
          description: Millionths of a dollar.
        balance_display:
          type: string
          example: $30.00
        lifetime_spent_micros:
          type: integer
        free_grant_micros:
          type: integer
          example: 10000000
        granted_period:
          type: string
          example: 2026-09
        created_at:
          type: string
          format: date-time
    Failure:
      type: object
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          description: Written for a person.
        result:
          type: object
          properties:
            code:
              type: string
              enum:
                - insufficient_credits
                - payments_unavailable
                - invalid_amount
                - unauthorized
                - validation_failed
                - internal_error
                - upstream_unavailable
  responses:
    Failure:
      description: >-
        The envelope with success false. result carries the machine-readable
        code and nothing else.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'

````