Usage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/soldgraph-com/json-schema/soldgraph-com-usage-schema.json",
  "title": "Usage",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/soldgraph-com-openapi.json#/components/schemas/Usage",
  "type": "object",
  "required": [
    "plan",
    "used",
    "limit",
    "remaining",
    "extra_requests",
    "window",
    "shared_allowance",
    "rate_limit_per_minute"
  ],
  "properties": {
    "plan": {
      "type": "string",
      "description": "Your plan, like free or pro."
    },
    "used": {
      "type": "integer",
      "description": "Requests counted against the allowance: in the rolling 30 days, or of the one-time free credit when window is one_time. Free accounts include linked accounts."
    },
    "limit": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The plan's allowance per rolling 30 days, or the size of the one-time free credit when window is one_time. Null when unlimited."
    },
    "remaining": {
      "type": [
        "integer",
        "null"
      ],
      "description": "limit minus used, never below 0. Null when unlimited."
    },
    "extra_requests": {
      "type": "integer",
      "description": "Extra requests bought on top of the plan. Spent only after the allowance."
    },
    "window": {
      "type": "string",
      "enum": [
        "rolling_30_days",
        "one_time"
      ],
      "description": "rolling_30_days: usage frees up as it ages out. one_time: a free account's one-time credit, which does not refill."
    },
    "shared_allowance": {
      "type": "boolean",
      "description": "True when other linked free accounts draw on the same allowance."
    },
    "rate_limit_per_minute": {
      "type": "integer",
      "description": "API calls allowed per minute, job polls and this call included."
    }
  }
}