Usage

periodstringrequired

The month the billing period started in, YYYY-MM.

Possible values: Value must match regular expression ^[0-9]{4}-[0-9]{2}$

Example: 2026-09

period_startstring<date>required

The first day of the period.

period_endstring<date>required

The first day after the period.

includedintegerrequired

Units included in the period.

usednumberrequired

Units used in the period.

overage_usednumberrequired

Units used beyond the included ones.

overage_balancenumberrequired

Prepaid units from packs that are still left now, also when the answer is about an earlier period.

hard_cap_unitsintegernullablerequired

The units at which overage stops live renders; null on a plan without overage and for an earlier period.

daily object[]required

Units and renders per UTC day, days without renders left out; renders counts test renders too, which cost no unit. Counted from the render log, so empty for a period older than its 13 months.

Array [

datestring<date>required

unitsnumberrequired

rendersintegerrequired

]

by_template object[]required

Units per template slug, most first; renders without a template are listed by their source (html, url, pdf_tool, or template once the template is gone). Counted from the render log, so empty for a period older than its 13 months.

Array [

templatestringrequired

unitsnumberrequired

]

Usage

{
  "period": "2026-09",
  "period_start": "2024-07-29",
  "period_end": "2024-07-29",
  "included": 0,
  "used": 0,
  "overage_used": 0,
  "overage_balance": 0,
  "hard_cap_units": 0,
  "daily": [
    {
      "date": "2024-07-29",
      "units": 0,
      "renders": 0
    }
  ],
  "by_template": [
    {
      "template": "string",
      "units": 0
    }
  ]
}