invoicepdfs-com Usage API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Usage API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged usage across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Usage
paths:
  /api/v1/usage:
    get:
      tags:
      - Usage
      summary: Get Usage
      description: 'Renders used this calendar month, against the plan''s quota.


        The period starts at midnight UTC on the first of the month.


        For rate limits, log retention and overage, use `get_usage_limits`; for

        the individual renders behind the count, `list_usage_events`.'
      operationId: get_usage
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/usage/events:
    get:
      tags:
      - Usage
      summary: List Usage Events
      description: 'One row per metered render, newest first.


        The detail behind the count `get_usage` returns, each row naming the

        render that produced it.'
      operationId: list_usage_events
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageEventsListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/usage/limits:
    get:
      tags:
      - Usage
      summary: Get Usage Limits
      description: 'Every ceiling on the account, and how close you are to each.


        A superset of `get_usage`: the render quota and what is left of it, plus

        requests per second, how long API logs are kept, and overage — whether it

        is enabled and available on the plan, how many renders have gone over,

        and what they have cost so far.


        The cost estimate is rounded up, so it is never lower than the invoice.'
      operationId: get_usage_limits
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageLimitsResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
components:
  schemas:
    UsageRenderLimits:
      properties:
        used:
          type: integer
          title: Used
        limit:
          type: integer
          title: Limit
        remaining:
          type: integer
          title: Remaining
      type: object
      required:
      - used
      - limit
      - remaining
      title: UsageRenderLimits
    UsageLimitsData:
      properties:
        renders:
          $ref: '#/components/schemas/UsageRenderLimits'
        rate_limit:
          $ref: '#/components/schemas/UsageRateLimit'
        api_log_retention:
          type: integer
          title: Api Log Retention
          default: 0
        overage:
          $ref: '#/components/schemas/UsageOverage'
      type: object
      required:
      - renders
      - rate_limit
      title: UsageLimitsData
    UsageRenders:
      properties:
        used:
          type: integer
          title: Used
        quota:
          type: integer
          title: Quota
      type: object
      required:
      - used
      - quota
      title: UsageRenders
    UsageData:
      properties:
        period:
          $ref: '#/components/schemas/UsagePeriod'
        renders:
          $ref: '#/components/schemas/UsageRenders'
      type: object
      required:
      - period
      - renders
      title: UsageData
    UsageResponse:
      properties:
        data:
          $ref: '#/components/schemas/UsageData'
      type: object
      required:
      - data
      title: UsageResponse
    UsageEventOut:
      properties:
        id:
          type: string
          title: Id
        render_id:
          type: string
          title: Render Id
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - render_id
      - created_at
      title: UsageEventOut
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    UsageOverage:
      properties:
        enabled:
          type: boolean
          title: Enabled
          default: false
        available:
          type: boolean
          title: Available
          default: false
        renders:
          type: integer
          title: Renders
          default: 0
        price_millicents:
          anyOf:
          - type: integer
          - type: 'null'
          title: Price Millicents
        estimated_cost_cents:
          type: integer
          title: Estimated Cost Cents
          default: 0
      type: object
      title: UsageOverage
      description: Renders past the quota this period, and what they cost.
    UsageRateLimit:
      properties:
        requests_per_second:
          type: integer
          title: Requests Per Second
      type: object
      required:
      - requests_per_second
      title: UsageRateLimit
    UsageLimitsResponse:
      properties:
        data:
          $ref: '#/components/schemas/UsageLimitsData'
      type: object
      required:
      - data
      title: UsageLimitsResponse
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    UsageEventsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/UsageEventOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: UsageEventsListResponse
    UsagePeriod:
      properties:
        start:
          type: string
          title: Start
        end:
          type: string
          title: End
      type: object
      required:
      - start
      - end
      title: UsagePeriod
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs