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

# Get usage

> Read today's organization usage with an inference key



## OpenAPI

````yaml api-reference/platform.json GET /api/v1/usage
openapi: 3.1.0
info:
  title: Subconscious platform API
  version: 1.0.0
  description: >-
    Management keys and organization usage on the Subconscious platform.
    Inference stays on https://api.subconscious.dev/v1.
servers:
  - url: https://platform.subconscious.dev
security: []
paths:
  /api/v1/usage:
    get:
      summary: Get usage
      description: >-
        Today's usage for the organization that owns the inference key: plan,
        credit balance, daily allowance, and tokens consumed today by model.
        Authenticate with an inference key (`Authorization: Bearer` or
        `X-API-Key`). Management keys are rejected. The allowance is a
        percentage of today's grant. The grant amount itself is not included.
      operationId: getUsage
      responses:
        '200':
          description: Organization usage snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
              example:
                billingMode: subscription
                plan:
                  label: Heavy
                  status: active
                  isUnlimitedComp: false
                  dailyAllowance:
                    basis: credit
                    percent: 5.5
                    resetAt: '2026-09-24T00:00:00.000Z'
                credits:
                  balanceDollars: 12.34
                  overageThisPeriodDollars: 0
                models:
                  - slug: subconscious/glm-5.3-marathon
                    consumedToday: 44500000
        '401':
          description: Missing, inactive, or non-inference API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The organization does not have closed-beta access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Closed-beta access is required
        '502':
          description: Usage could not be read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://platform.subconscious.dev/api/v1/usage \
              -H "Authorization: Bearer sk-gw-..."
components:
  schemas:
    Usage:
      type: object
      required:
        - billingMode
        - plan
        - credits
        - models
      properties:
        billingMode:
          type:
            - string
            - 'null'
          description: >-
            How the organization is billed, such as `subscription` or `prepaid`.
            Null when the organization has no plan.
        plan:
          type: object
          required:
            - label
            - status
            - isUnlimitedComp
            - dailyAllowance
          properties:
            label:
              type:
                - string
                - 'null'
              description: Plan name. Null when the organization has no plan.
            status:
              type:
                - string
                - 'null'
              description: Plan status, such as `active`.
            isUnlimitedComp:
              type: boolean
            dailyAllowance:
              description: >-
                Share of today's allowance. Null for unlimited plans and for
                organizations with no allowance. `percent` can exceed 100 when
                usage is past the allowance. `basis` is `credit` when the day is
                sized in credits, `tokens` when it is sized in tokens, and
                `unavailable` when a credit-billed read failed.
              oneOf:
                - $ref: '#/components/schemas/CreditOrTokenAllowance'
                - $ref: '#/components/schemas/UnavailableAllowance'
                - type: 'null'
        credits:
          type: object
          required:
            - balanceDollars
            - overageThisPeriodDollars
          properties:
            balanceDollars:
              type:
                - number
                - 'null'
              description: >-
                Spendable credit balance in dollars. Null when the balance
                cannot be read.
            overageThisPeriodDollars:
              type: number
              description: Overage for the current period, in dollars. Currently always 0.
        models:
          type: array
          description: >-
            Models with usage today. A model with no usage today is omitted,
            which means zero tokens so far.
          items:
            type: object
            required:
              - slug
              - consumedToday
            properties:
              slug:
                type: string
                example: subconscious/glm-5.3-marathon
              consumedToday:
                type: integer
                description: Tokens consumed by this model since UTC midnight.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    CreditOrTokenAllowance:
      type: object
      required:
        - basis
        - percent
        - resetAt
      properties:
        basis:
          type: string
          enum:
            - credit
            - tokens
        percent:
          type: number
          description: Percent of today's allowance already used. Can exceed 100.
        resetAt:
          type: string
          format: date-time
          description: When the daily counter resets (UTC midnight).
    UnavailableAllowance:
      type: object
      required:
        - basis
        - resetAt
      properties:
        basis:
          type: string
          enum:
            - unavailable
        resetAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in the Authorization header. Management endpoints require a
        management key (`sk-mgmt-...`). GET /api/v1/usage requires an inference
        key (`sk-gw-...`).
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Same key as bearer auth, passed in the X-API-Key header.

````