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

# Get metered usage

> Get immutable usage records and their current billing eligibility.



## OpenAPI

````yaml /openapi/v1.yaml get /projections/meter-usage
openapi: 3.1.0
info:
  title: OrgX REST API v1
  version: '1'
  description: >-
    Build accountable work into your product with OrgX REST API v1.


    Create work with one field, attach evidence when it is complete, and keep
    the receipt. Every authenticated request is scoped to the workspace resolved
    from your credential.


    Start with `POST /work`. Human guide:
    https://docs.useorgx.com/docs/api/quickstart
  contact:
    name: OrgX Support
    url: https://useorgx.com/support
    email: support@useorgx.com
  license:
    name: Proprietary
    url: https://useorgx.com/terms
servers:
  - url: https://useorgx.com/api/v1
    description: Production
security: []
tags:
  - name: Work
    description: Create accountable work and complete it with evidence
  - name: Initiatives
    description: Organize related work around an outcome
  - name: Operating processes
    description: Evidence-backed company workflow/process lifecycle
  - name: Operating map
    description: Derived, rebuildable Operating Map projection over the process ledger
  - name: Discovery runs
    description: Wizard and deep-search workflow discovery over connected company sources
  - name: Handoffs
    description: Ledger-backed stage handoffs between operating-process stages
  - name: Events
    description: Replayable, workspace-scoped accepted ledger events
  - name: Projections
    description: Workspace-scoped, rebuildable read projections over OrgX sources
  - name: Episodes
    description: Mission-compatible Episode read adapters
  - name: Receipt validation
    description: Account-free Agent Work Receipt schema discovery and conformance
  - name: Receipt import
    description: Authenticated, workspace-scoped import into the hosted receipt ledger
  - name: Workload diagnosis
    description: >-
      Account-free evaluation of time, agents, systems, authority, and
      accountability boundaries
  - name: Content Studio
    description: >-
      Estimate, showcase, checkout, and payment event operations for Content
      Studio
  - name: Decisions
    description: Raise decisions for human ruling and read their state
  - name: Artifacts
    description: Register produced work against the entity it belongs to
  - name: Launches
    description: Preview and run an initiative launch through its spend gates
  - name: Runs
    description: Control agent runs with pause, resume, cancel, and rollback
  - name: Lifecycle
    description: Pause, resume, retry, or cancel work hierarchy nodes and runs
  - name: Deduplication
    description: Claim durable event fingerprints so duplicate triggers fire once
  - name: Credential
    description: >-
      Resolve the calling credential, the workspaces it reaches, and what it may
      do
  - name: API discovery
    description: Account-free error codes, request schemas, and closed vocabularies for v1
externalDocs:
  description: Human-readable OrgX REST API v1 reference
  url: https://docs.useorgx.com/docs/api/public-api
paths:
  /projections/meter-usage:
    get:
      tags:
        - Projections
      summary: Get metered usage
      description: Get immutable usage records and their current billing eligibility.
      operationId: getMeterUsageProjection
      parameters:
        - $ref: '#/components/parameters/WorkspaceIdQuery'
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Derived immutable meter usage evidence
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeterUsageProjectionResponse'
              example:
                data:
                  schemaVersion: 1.0.0
                  projectionId: projection_id
                  workspaceId: 09707fa5-aaae-4493-8a23-827111000f89
                  from: '2026-08-18T18:30:00.000Z'
                  to: '2026-08-18T18:30:00.000Z'
                  eventCount: 0
                  rawEventCount: 0
                  correctionCount: 0
                  totalQuantity: 0
                  actualQuantity: 0
                  estimatedQuantity: 0
                  unavailableEventCount: 0
                  actualEventCount: 0
                  estimatedEventCount: 0
                  providerUsageEventCount: 0
                  buckets:
                    - meter: accepted_work
                      unit: count
                      eventCount: 0
                      totalQuantity: 0
                      actualQuantity: 0
                      estimatedQuantity: 0
                      unavailableEventCount: 0
                  sourceCursor: evt_01J5Y8R4K2
                  freshnessWatermark: '2026-08-18T18:30:00.000Z'
                  evidenceStatus: measured
                  billingReady: false
                  limitations:
                    - No limitations reported.
                  refreshedAt: '2026-08-18T18:30:00.000Z'
                meta: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
        - cookieAuth: []
components:
  parameters:
    WorkspaceIdQuery:
      name: workspace_id
      in: query
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    MeterUsageProjectionResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          $ref: '#/components/schemas/MeterUsageProjection'
        meta:
          $ref: '#/components/schemas/MeterUsageProjectionMeta'
    MeterUsageProjection:
      type: object
      additionalProperties: false
      required:
        - schemaVersion
        - projectionId
        - workspaceId
        - from
        - to
        - eventCount
        - rawEventCount
        - correctionCount
        - totalQuantity
        - actualQuantity
        - estimatedQuantity
        - unavailableEventCount
        - actualEventCount
        - estimatedEventCount
        - providerUsageEventCount
        - buckets
        - sourceCursor
        - freshnessWatermark
        - evidenceStatus
        - billingReady
        - limitations
        - refreshedAt
      properties:
        schemaVersion:
          type: string
          const: 1.0.0
        projectionId:
          type: string
          pattern: ^meter_usage:sha256:[a-f0-9]{64}$
        workspaceId:
          type: string
          format: uuid
        from:
          type:
            - string
            - 'null'
          format: date-time
        to:
          type:
            - string
            - 'null'
          format: date-time
        eventCount:
          type: integer
          minimum: 0
        rawEventCount:
          type: integer
          minimum: 0
        correctionCount:
          type: integer
          minimum: 0
        totalQuantity:
          type: number
          minimum: 0
        actualQuantity:
          type: number
          minimum: 0
        estimatedQuantity:
          type: number
          minimum: 0
        unavailableEventCount:
          type: integer
          minimum: 0
        actualEventCount:
          type: integer
          minimum: 0
        estimatedEventCount:
          type: integer
          minimum: 0
        providerUsageEventCount:
          type: integer
          minimum: 0
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/MeterUsageBucket'
        sourceCursor:
          type:
            - string
            - 'null'
        freshnessWatermark:
          type:
            - string
            - 'null'
          format: date-time
        evidenceStatus:
          type: string
          enum:
            - measured
            - estimated
            - insufficient_evidence
        billingReady:
          type: boolean
          const: false
        limitations:
          type: array
          items:
            type: string
            minLength: 1
        refreshedAt:
          type: string
          format: date-time
    MeterUsageProjectionMeta:
      allOf:
        - $ref: '#/components/schemas/ContractMeta'
        - type: object
          required:
            - projectionStatus
            - evidenceStatus
            - billingReady
            - sourceCursor
            - freshnessWatermark
          properties:
            projectionStatus:
              type: string
              const: derived_from_meter_events
            evidenceStatus:
              type: string
              enum:
                - measured
                - estimated
                - insufficient_evidence
            billingReady:
              type: boolean
              const: false
            sourceCursor:
              type:
                - string
                - 'null'
            freshnessWatermark:
              type:
                - string
                - 'null'
              format: date-time
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
            requestId:
              type: string
            timestamp:
              type: string
              format: date-time
            docsUrl:
              type: string
              format: uri
            retryAfter:
              type: integer
              description: Seconds until rate limit resets
    MeterUsageBucket:
      type: object
      additionalProperties: false
      required:
        - meter
        - unit
        - eventCount
        - totalQuantity
        - actualQuantity
        - estimatedQuantity
        - unavailableEventCount
      properties:
        meter:
          type: string
          minLength: 1
        unit:
          type: string
          minLength: 1
        eventCount:
          type: integer
          minimum: 0
        totalQuantity:
          type: number
          minimum: 0
        actualQuantity:
          type: number
          minimum: 0
        estimatedQuantity:
          type: number
          minimum: 0
        unavailableEventCount:
          type: integer
          minimum: 0
    ContractMeta:
      type: object
      additionalProperties: false
      required:
        - apiVersion
        - workspaceId
      properties:
        apiVersion:
          type: string
          const: '1'
        workspaceId:
          type: string
          format: uuid
        count:
          type: integer
          minimum: 0
  responses:
    BadRequest:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Ledger or workspace authorization is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'OrgX API key, sent as `Authorization: Bearer oxk_...`'
    cookieAuth:
      type: apiKey
      in: cookie
      name: __session
      description: Session cookie from web authentication

````