> ## Documentation Index
> Fetch the complete documentation index at: https://evsim.synergyboat.com/docs/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: EV Roaming Tester public API
  version: 1.0.0
  description: >-
    Automate EV Roaming Tester with an evrt_ API key: register partner
    connections, run conformance suites and charging journeys, and read the
    graded reports.
servers:
  - url: https://evsim.synergyboat.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'
      security:
        - apiKey: []
components:
  schemas:
    Usage:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            plan:
              type: string
            connections:
              type: object
              properties:
                active:
                  type: integer
                cap:
                  type: integer
            runs:
              type: object
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: An evrt_... API key created in the app under Settings.

````