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

# Get usage

> Plan, period, and what is used and left. Works even when the workspace is out of ops.

Your plan, the current period, and what is used and left. Usage calls are never blocked by the ops limit, so you can always see where you stand.


## OpenAPI

````yaml GET /v2/usage
openapi: 3.1.0
info:
  title: OpenNous REST API
  version: 2.0.0
  description: >-
    Read and write the OpenNous revenue context graph over HTTP. Authenticate
    with a workspace API key.
servers:
  - url: https://api.opennous.cloud
    description: OpenNous Cloud
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: People
  - name: Accounts
  - name: Deals
  - name: Notes
  - name: Attention
  - name: Insights
  - name: Enrich & score
  - name: Organization
  - name: Workflows
  - name: Webhooks
    description: >-
      Subscribe to events and have them pushed to your own stack, with the
      account record attached.
  - name: Usage
paths:
  /v2/usage:
    get:
      tags:
        - Usage
      summary: Get usage
      description: >-
        Plan, period, and what is used and left. Works even when the workspace
        is out of ops.
      operationId: getUsage
      responses:
        '200':
          description: Usage this period.
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                  self_hosted:
                    type: boolean
                  subscription_status:
                    type:
                      - string
                      - 'null'
                  period:
                    type: object
                    properties:
                      start:
                        type: string
                      end:
                        type: string
                  ops:
                    $ref: '#/components/schemas/Meter'
                  credits:
                    type: object
                    properties:
                      used:
                        type: number
                      limit:
                        type:
                          - number
                          - 'null'
                      left:
                        type:
                          - number
                          - 'null'
                      percent_used:
                        type:
                          - number
                          - 'null'
                      state:
                        type:
                          - string
                          - 'null'
                      unlimited:
                        type: boolean
                  enrichments:
                    $ref: '#/components/schemas/Meter'
                  active_accounts:
                    type: object
                    properties:
                      used:
                        type: integer
                      limit:
                        type:
                          - integer
                          - 'null'
                      left:
                        type:
                          - integer
                          - 'null'
                      state:
                        type: string
              example:
                plan:
                  id: growth
                  name: Growth
                self_hosted: false
                subscription_status: active
                period:
                  start: '2026-09-01T00:00:00Z'
                  end: '2026-10-01T00:00:00Z'
                ops:
                  used: 1840
                  limit: 10000
                  left: 8160
                credits:
                  used: 188
                  limit: 500
                  left: 312
                  percent_used: 38
                  state: ok
                  unlimited: false
                enrichments:
                  used: 0
                  limit: 0
                  left: 0
                active_accounts:
                  used: 212
                  limit: 1000
                  left: 788
                  state: ok
        '400':
          description: A bad query parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unknown_query_param
                detail: 'unsupported query param(s): foo'
                supported: []
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Meter:
      type: object
      properties:
        used:
          type: integer
        limit:
          type:
            - integer
            - 'null'
        left:
          type:
            - integer
            - 'null'
          description: Null when unlimited.
    Error:
      type: object
      description: >-
        Every error response. `error` is a stable machine code. Some errors add
        fields such as `detail`, `supported`, `max`, or `reason`.
      required:
        - error
      properties:
        error:
          type: string
          description: Machine-readable error code.
        detail:
          type: string
          description: Human-readable explanation, when there is one.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, unknown, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: api_key_required
              value:
                error: api_key_required
            invalid:
              summary: invalid_api_key
              value:
                error: invalid_api_key
            expired:
              summary: api_key_expired
              value:
                error: api_key_expired
                detail: >-
                  This API key has expired. Create or rotate a key to get a
                  fresh one.
    RateLimited:
      description: More than 600 requests in a minute on this key.
      headers:
        RateLimit-Limit:
          schema:
            type: integer
          description: Requests allowed per window.
        RateLimit-Remaining:
          schema:
            type: integer
          description: Requests left in the window.
        RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limited
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace API key. Create one in **Settings → API keys**.
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: The same key, sent as a header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.