GET
Read this cycle's usage

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Response

Read this cycle's usage

Api_V1_Entities_WorkspaceUsage model

billed_in_cents
integer<int32>
required

Hours written to the ledger this cycle before the hour in progress, plus any adjustments

pending_in_cents
integer<int32>
required

The hours not closed yet, from billed_through to now, priced live

total_in_cents
integer<int32>
required

billed_in_cents plus pending_in_cents

minimum_in_cents
integer<int32>
required

The monthly minimum while the workspace is charged it, or 0; usage up to it is not charged on top. It is charged from the first workload on Usage Billing until the renewal after the last one is gone, and only while the subscription pays for nothing else

projected_in_cents
integer<int32>
required

The cycle's usage if what runs now keeps running until cycle_end: total_in_cents plus the hourly cost of every running workload at its current replicas and all storage, and never below minimum_in_cents

limit_reached_on
string<date>
required

ISO8601 date that pace reaches spend_limit_in_cents within this cycle, or null when there is no limit, it is already reached, or the projection stays under it

spend_limit_in_cents
integer<int32>
required

The admin's ceiling, or null for none

spend_limit_floor_in_cents
integer<int32>
required

The lowest limit that can be set: the monthly minimum, or what storage alone costs for a cycle when that is more

pay_per_use_enabled
boolean
required

Whether Usage Billing is offered in this workspace; on by default

charge_threshold_in_cents
integer<int32>
required

Unbilled usage beyond the minimum is charged to the card whenever it reaches this amount, rather than waiting for the renewal. It starts at 2500 and each paid renewal raises it a step (5000, 25000, 100000, 400000); during a free trial, until a charge in it is paid, it is 500. A value Miget set for the workspace, on an approved limit increase or otherwise, replaces the ladder; null once usage is charged with the renewal alone, and before the subscription's first payment, when nothing is charged. A refused charge stops the workspace's workloads on Usage Billing until it is paid

charged_early_in_cents
integer<int32>
required

What was charged this cycle at the threshold; the renewal bills only the usage beyond it

credits_applied_in_cents
integer<int32>
required

What the workspace's credits pay of this cycle's usage beyond the minimum, before the card: what they paid of the hours already sent to billing, plus what the balance left covers of the rest, the hour in progress included. The renewal and the threshold bill only the usage beyond the minimum and these credits

due_after_first_payment_in_cents
integer<int32>
required

Usage that ran before the subscription's first payment, as during an onboarding Miget set up, and is not billed yet: all of it, with no monthly minimum taken off, is charged to the card right after that payment, the workspace's credits paying first. 0 once the subscription is paid

cycle_start
string
required

ISO8601 start of the billing cycle; the calendar month before the subscription's first payment

cycle_end
string
required

ISO8601 end of the billing cycle

billed_through
string
required

ISO8601 start of the first hour not closed yet; billed_in_cents counts the closed hours before it

workloads
object[]
required
adjustments
object[]
required