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

# Get current monthly usage

> Returns the authenticated customer's current UTC calendar-month usage for supported operations together with the configured monthly limit and remaining units. Reading usage does not consume usage units.




## OpenAPI

````yaml /openapi/operational-evidence-v1.yaml get /v1/usage/current
openapi: 3.1.0
info:
  title: The Wo Operational Evidence API
  version: 1.0.0
  description: >
    Public API contract for transforming operational evidence into structured
    operational reports and exposing customer-scoped usage visibility.
servers:
  - url: https://api.thewo.io
    description: Canonical The Wo production API origin.
security:
  - ApiKeyAuth: []
tags:
  - name: Operational Evidence
    description: Transform submitted operational evidence into structured reports.
  - name: Usage
    description: Read customer-scoped usage and monthly quota information.
paths:
  /v1/usage/current:
    get:
      tags:
        - Usage
      summary: Get current monthly usage
      description: >
        Returns the authenticated customer's current UTC calendar-month usage
        for supported operations together with the configured monthly limit and
        remaining units. Reading usage does not consume usage units.
      operationId: getCurrentUsage
      responses:
        '200':
          description: Current monthly usage returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUsageResponse'
              examples:
                currentUsage:
                  $ref: '#/components/examples/CurrentUsage'
        '401':
          description: >
            The x-api-key header is missing or the provided credential is
            invalid, inactive, or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                missingApiKey:
                  $ref: '#/components/examples/MissingApiKey'
        '403':
          description: >
            Current usage is not available because the authenticated customer
            does not have a valid active customer and Plan relationship for the
            supported operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                currentUsageAccessDenied:
                  $ref: '#/components/examples/CurrentUsageAccessDenied'
        '500':
          description: An unexpected internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unexpectedError:
                  $ref: '#/components/examples/UnexpectedError'
        '503':
          description: >
            API key authentication or current usage information is temporarily
            unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                currentUsageUnavailable:
                  $ref: '#/components/examples/CurrentUsageUnavailable'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CurrentUsageResponse:
      type: object
      additionalProperties: false
      required:
        - period
        - usage
      properties:
        period:
          $ref: '#/components/schemas/CurrentUsagePeriod'
        usage:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/CurrentUsageItem'
    ApiErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
              minLength: 1
              description: Stable public error identifier.
            message:
              type: string
              minLength: 1
              description: Human-readable public error message.
            requestId:
              type: string
              minLength: 1
              description: Request correlation identifier.
            details:
              type: object
              description: |
                Optional safe public metadata associated with the error.
              additionalProperties:
                oneOf:
                  - type: string
                  - type: number
                  - type: boolean
                  - type: 'null'
    CurrentUsagePeriod:
      type: object
      additionalProperties: false
      required:
        - startsAt
        - endsAt
      properties:
        startsAt:
          type: string
          format: date-time
          description: Inclusive UTC start of the current calendar-month period.
        endsAt:
          type: string
          format: date-time
          description: >
            Exclusive UTC end of the current calendar-month period and the
            beginning of the next quota period.
    CurrentUsageItem:
      type: object
      additionalProperties: false
      required:
        - operation
        - used
        - limit
        - remaining
      properties:
        operation:
          type: string
          enum:
            - evidence_report
          description: Usage operation represented by this item.
        used:
          type: integer
          minimum: 0
          description: Units recorded for the operation during the current period.
        limit:
          type: integer
          minimum: 0
          description: Configured monthly limit for the operation.
        remaining:
          type: integer
          minimum: 0
          description: |
            Remaining units calculated as max(limit - used, 0).
  examples:
    CurrentUsage:
      summary: Current Operational Evidence monthly usage
      value:
        period:
          startsAt: '2026-08-01T00:00:00.000Z'
          endsAt: '2026-09-01T00:00:00.000Z'
        usage:
          - operation: evidence_report
            used: 120
            limit: 500
            remaining: 380
    MissingApiKey:
      summary: Missing API key
      value:
        error:
          code: missing_api_key
          message: The x-api-key header is required.
          requestId: req_123
    CurrentUsageAccessDenied:
      summary: Current usage unavailable for the customer
      value:
        error:
          code: current_usage_access_denied
          message: Current usage is not available for this customer.
          requestId: req_123
    UnexpectedError:
      summary: Unexpected internal error
      value:
        error:
          code: internal_error
          message: An unexpected error occurred.
          requestId: req_123
    CurrentUsageUnavailable:
      summary: Current usage temporarily unavailable
      value:
        error:
          code: current_usage_unavailable
          message: Current usage information is temporarily unavailable.
          requestId: req_123
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        Secret API credential for trusted server-to-server integrations. Never
        expose this value in public frontend or mobile application code.

````