Usage

retrieve credit usage for the current billing period

Changed on

Credit allotment, consumption to date, and cap-enforcement state for a workspace's current billing period

get/usage/credits

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/usage/credits
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

organization_idstring required

The organization id to retrieve credit usage for

Response

Credit usage for the workspace's current billing period.

organization_idstring
cap_enforcement_enabledboolean

True when the workspace has opted into enforcement (allocations.enforce_limit) on an explicit credit allocation and is not exempt (e.g. trial). False means the allocation is informational only

period_startinteger

Billing period start, epoch millis UTC (inclusive)

period_endinteger

Billing period end, epoch millis UTC (exclusive)

allotment_centicreditsinteger

Effective credit allocation in centicredits. Also absent when no credit allocation is configured for the workspace

consumed_centicreditsinteger

Centicredits consumed so far this period (near-real-time, ~10 minute lag)

estimated_in_flight_centicreditsinteger

Estimated centicredits for currently running cloud tests. Also absent when the estimate is temporarily unavailable (e.g. its underlying counts could not be read)

Changes