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

# Read plan limits and usage

> Read the API key owner's current plan, along with active connection counts and run usage against the plan's limits, so you can track quota before it bites.



## OpenAPI

````yaml /openapi/public-api.json get /usage
openapi: 3.1.0
info:
  title: ChargerDojo public API
  version: 1.0.0
  description: >-
    Automate ChargerDojo with a cdojo_ API key: register partner endpoints, run
    conformance suites and charging journeys, and read the graded reports.
servers:
  - url: https://chargerdojo.com/api/v1
security:
  - apiKey: []
tags:
  - name: Connections
  - name: Testing
  - name: Reports
  - name: Usage
  - name: Journeys
paths:
  /usage:
    get:
      tags:
        - Usage
      summary: Read the key owner's plan limits and current usage
      description: >-
        Read the API key owner's current plan, along with active connection
        counts and run usage against the plan's limits, so you can track quota
        before it bites.
      operationId: usage_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Usage:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          type: object
          required:
            - tier
            - plan
            - connections
            - apiKeys
            - runs
            - reportRetentionDays
          properties:
            tier:
              type: string
              enum:
                - anon
                - free
                - paid
            plan:
              type:
                - string
                - 'null'
            connections:
              type: object
              required:
                - active
                - cap
              properties:
                active:
                  type: integer
                cap:
                  type:
                    - integer
                    - 'null'
                  description: >-
                    How many partner endpoints this plan allows. Null on a plan
                    priced on a quote, which publishes no ceiling: endpoints
                    there are fair use.
            apiKeys:
              type: object
              required:
                - active
                - cap
              properties:
                active:
                  type: integer
                cap:
                  type: integer
            runs:
              type: object
              required:
                - inflight
                - inflightCap
                - perMinuteCap
                - thisMonth
              properties:
                inflight:
                  type: integer
                inflightCap:
                  type: integer
                perMinuteCap:
                  type: integer
                thisMonth:
                  type: integer
            members:
              type: object
              required:
                - active
              properties:
                active:
                  type: integer
              description: >-
                How many people are in this organisation, counting invitations
                still open. Reported, never a ceiling: nothing here refuses a
                request for having too many members.
            reportRetentionDays:
              type: integer
              description: >-
                How long a report is kept. Three guides tell a reader to read it
                from here.
        meta:
          type: object
          description: Paging, on the operations that return a list.
          properties:
            limit:
              type: integer
            skip:
              type: integer
            nextCursor:
              type: string
          additionalProperties: true
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        status:
          type: string
          enum:
            - error
        code:
          type: string
        timestamp:
          type: string
          format: date-time
        capability:
          type: string
          enum:
            - external-endpoints
            - ci-handoff
            - saved-presets
            - load-testing
            - direct-payment
            - bookings
            - scheduled-runs
        limit:
          type: object
          required:
            - id
            - used
            - cap
          properties:
            id:
              type: string
              enum:
                - connections
                - run-concurrency
            used:
              type: integer
            cap:
              type: integer
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: A cdojo_... API key created in the app under Settings.

````