Usage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/norekey/main/json-schema/norekey-usage-schema.json",
  "title": "Usage",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/norekey-api-openapi.json#/components/schemas/Usage",
  "type": "object",
  "required": [
    "team",
    "plan",
    "cycle",
    "pages",
    "limits"
  ],
  "properties": {
    "team": {
      "type": "object",
      "required": [
        "name",
        "slug"
      ],
      "description": "The team the API key belongs to.",
      "properties": {
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        }
      }
    },
    "plan": {
      "type": "string",
      "description": "The team's plan, e.g. `free`, `practice` or `firm`."
    },
    "cycle": {
      "type": "object",
      "required": [
        "started_at",
        "resets_at"
      ],
      "description": "The current monthly usage cycle. Paid teams' cycles follow their billing date.",
      "properties": {
        "started_at": {
          "type": "string",
          "format": "date-time"
        },
        "resets_at": {
          "type": "string",
          "format": "date-time",
          "description": "When `used` returns to zero."
        }
      }
    },
    "pages": {
      "type": "object",
      "required": [
        "allowance",
        "used",
        "remaining",
        "credit",
        "available"
      ],
      "properties": {
        "allowance": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "description": "Pages the plan includes per cycle; null when unlimited."
        },
        "used": {
          "type": "integer",
          "minimum": 0,
          "description": "Pages charged this cycle: accepted, in-progress and completed conversions. Failed conversions are refunded."
        },
        "remaining": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "description": "What's left of the plan allowance this cycle (never negative); null when unlimited."
        },
        "credit": {
          "type": "integer",
          "minimum": 0,
          "description": "Extra pages from page packs the team has bought or pages we've added. Spent only once the plan allowance runs out; they never expire."
        },
        "available": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "description": "`remaining` plus `credit`: the most pages the next upload may be charged. Null when unlimited."
        }
      }
    },
    "limits": {
      "type": "object",
      "required": [
        "max_pages_per_file",
        "max_file_mb",
        "scanned_page_multiplier"
      ],
      "properties": {
        "max_pages_per_file": {
          "type": "integer",
          "minimum": 0,
          "description": "Largest statement accepted, in pages."
        },
        "max_file_mb": {
          "type": "integer",
          "minimum": 0,
          "description": "Largest file accepted, in megabytes."
        },
        "scanned_page_multiplier": {
          "type": "integer",
          "minimum": 0,
          "description": "Always 1 — scanned pages are charged like any other. Kept so existing clients don't break."
        }
      }
    }
  }
}