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

# Get print usage for this period

> Returns the plan, the live prints it includes this monthly period and the live print jobs created so far. Test mode jobs never count, so a test key sees the same live usage.



## OpenAPI

````yaml /openapi/openapi.json get /v1/usage
openapi: 3.1.0
info:
  contact:
    name: PrintEasy
    url: https://docs.printeasy.adfinite.com
  description: >-
    Cloud printing API: send PDFs and raw jobs to printers attached to computers
    running the PrintEasy agent.
  title: PrintEasy API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.printeasy.adfinite.com
security:
  - ApiKeyAuth: []
  - BasicAuth: []
tags:
  - description: Who you are, your plan and usage
    name: Account
  - description: Machines running the PrintEasy agent
    name: Computers
  - description: Printers reported by agents
    name: Printers
  - description: Submit and track print jobs
    name: Print jobs
  - description: Signed event delivery to your HTTPS endpoints
    name: Webhooks
  - description: Cursor based event feed
    name: Events
  - description: Prints used this period
    name: Usage
paths:
  /v1/usage:
    get:
      tags:
        - Usage
      summary: Get print usage for this period
      description: >-
        Returns the plan, the live prints it includes this monthly period and
        the live print jobs created so far. Test mode jobs never count, so a
        test key sees the same live usage.
      operationId: getUsage
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
          description: Usage of the current period
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid API key or session
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The key scope or member role does not allow this
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Rate limit or test mode cap reached; retry after the Retry-After
            header
      security:
        - ApiKeyAuth: []
        - BasicAuth: []
components:
  schemas:
    Usage:
      example:
        history: []
        period:
          end: '2026-11-01T00:00:00.000Z'
          includedPrints: 5000
          start: '2026-10-01T00:00:00.000Z'
          usedPrints: 1234
        plan: essential
      properties:
        history:
          description: Earlier periods, newest first; empty until billing periods exist
          items:
            properties:
              end:
                description: First instant after the period (UTC), exclusive
                format: date-time
                type: string
              includedPrints:
                description: Live prints the plan includes
                type: integer
              start:
                description: First instant of the period (UTC)
                format: date-time
                type: string
              usedPrints:
                description: Live print jobs created so far
                type: integer
            required:
              - start
              - end
              - includedPrints
              - usedPrints
            type: object
          type: array
        period:
          properties:
            end:
              description: First instant after the period (UTC), exclusive
              format: date-time
              type: string
            includedPrints:
              description: Live prints the plan includes
              type: integer
            start:
              description: First instant of the period (UTC)
              format: date-time
              type: string
            usedPrints:
              description: Live print jobs created so far
              type: integer
          required:
            - start
            - end
            - includedPrints
            - usedPrints
          type: object
        plan:
          description: >-
            Current plan (lite, essential, standard or premium), as in GET
            /v1/whoami
          example: essential
          type: string
      required:
        - plan
        - period
        - history
      type: object
    Error:
      description: >-
        Every error response uses this envelope; code is stable, message is for
        humans.
      properties:
        error:
          properties:
            code:
              example: not_found
              type: string
            message:
              example: Printer not found
              type: string
            request_id:
              example: 4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a
              type: string
          required:
            - code
            - message
            - request_id
          type: object
      required:
        - error
      type: object
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: pe_live_ or pe_test_ key
      description: >-
        Send `Authorization: Bearer <API key>`. Use a pe_test_ key in the
        playground; it only reaches virtual test printers.
      scheme: bearer
      type: http
      x-default: pe_test_REPLACE_WITH_YOUR_TEST_KEY
    BasicAuth:
      description: >-
        PrintNode compatible: put the API key in the username with an empty
        password
      scheme: basic
      type: http

````

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