Account

Usage this period

This UTC calendar month's Ironfang Render usage from your organisation's billing account: for every Render meter, what was used, how much of it the free allowance covered, what is held by work in flight, and what the settled usage costs before tax. The whole account - every product, budgets, statements - is /billing/v1.

An env bootstrap key, or a deployment with billing off, is unmetered and answers {"unmetered": true}.

get/v1/usage

Request

  • Base URL: https://api.ironfang.com/render
  • URL: https://api.ironfang.com/render/v1/usage
  • Auth: HTTP bearer

Response

Current period usage.

catalogue_versionstring

The billing catalogue version that prices this period.

currency'GBP'
mode'free' | 'setup_pending' | 'enabled' | 'paused' | 'closed'

The billing account's mode; enabled means paid usage beyond the free allowances is on.

period_endstring date

The period as [period_start, period_end) in UTC dates.

period_startstring date
product'render'
reservedstring

The most work in flight could add if it all succeeds; not charged on top of settled.

settledstring

What Ironfang Render's settled usage costs this period.

Changes

No recorded changes to this operation across all 1 revision of this API.