Skip to content
Get Started

Usage

Usage reports the organisation's checks for the current period (used, included, remaining and extra) and the project's traffic for a date range.

Endpoints

The usage object

The organisation's checks for the current period and the project's traffic for a date range.

The usage objectJSON
{
  "object": "usage_summary",
  "checks_used": 20,
  "checks_quota": 250000,
  "checks_remaining": 249980,
  "extra_checks": 0,
  "period_start": "2026-10-08",
  "period_end": "2026-11-01",
  "resets_at": "2026-11-01T00:00:00.000Z",
  "project": {
    "object": "usage",
    "period": {
      "from": "2026-10-01",
      "to": "2026-10-08"
    },
    "environment": "live",
    "totals": {
      "moderations": 20,
      "checks": 20,
      "flagged": 15,
      "allowed": 5,
      "reviewed": 0,
      "rejected": 15,
      "cached": 0,
      "partial": 0,
      "failed": 0
    },
    "by_day": [
      {
        "date": "2026-10-08",
        "moderations": 20,
        "checks": 20,
        "flagged": 15
      }
    ],
    "by_template": [
      {
        "template": "review",
        "moderations": 20,
        "checks": 20,
        "flagged": 15,
        "rejected": 15,
        "reviewed": 0
      }
    ],
    "by_policy": [
      {
        "policy": "made_with_ai",
        "moderations": 20,
        "checks": 20
      }
    ]
  }
}

Attributes

object"usage_summary"

Always usage_summary.

checks_usedinteger

Checks consumed from the period's allowance, across all projects of the organisation.

checks_quotainteger

Checks included in the period: the plan's monthly checks plus any credit added to the period.

checks_remaininginteger

Checks left in the period's allowance: checks_quota minus checks_used.

extra_checksinteger

Purchased extra checks that are still available. They are used only after the period's allowance is spent, carry over between periods and expire 365 days after purchase.

period_startdate

First day of the current period, as YYYY-MM-DD. A period is a calendar month in UTC, or a month counted from the subscription's billing date.

period_enddate

The day the period ends and the next one begins, as YYYY-MM-DD.

resets_attimestamp

When the allowance resets, ISO 8601 in UTC. The same moment as period_end.

projectmap

Traffic of the key's project for the requested date range, live keys only. It is aggregated every 5 minutes, so the most recent moderations can be missing.

objectstring

Always usage.

periodobject

The date range covered.

fromstring

First day of the range, as YYYY-MM-DD.

tostring

Last day of the range, as YYYY-MM-DD.

environmentstring

Always live.

totalsobject

Counts over the range: moderations, checks, flagged, allowed, reviewed, rejected, cached, partial and failed.

by_dayarray

One entry per day that had traffic, in date order: date, moderations, checks and flagged.

by_templatearray

One entry per template: template (the slug), moderations, checks, flagged, rejected and reviewed.

by_policyarray

One entry per advanced policy: policy, moderations and checks. checks adds the policy's catalog weight once for every moderation whose template enables it, so it is not a share of totals.checks.

Something missing or unclear on this page? Write to support@useinfrared.com.