VMs

Get a VM's burn rate, session cost and runway

Changed on

Returns a VM's bundled hourly rate, the cost its open session has accrued, and the org's available balance, total burn rate and projected runway. Every VM bills at one bundled hourly rate (per-GPU catalog price times GPU count for GPU VMs, a flat size rate for CPU VMs); disk is included, never billed separately. The rate is locked when the usage session opens, so this endpoint reads it from the open usage record when one exists (rateSource=locked) and only falls back to the current catalog when nothing is accruing (rateSource=catalog).

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

get/v1/vms/{id}/burn

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/vms/{id}/burn
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

The VM's burn breakdown

accruedSessionCentsinteger

cost accrued by the open session so far (session span times the locked rate, the same span math settlement uses); omitted when no session is open

autoStopFloorCentsinteger required

available-balance floor (cents) below which the org is auto-stopped

diskBilledboolean required

always false today: disk is included in the bundled hourly rate and never billed as a separate line item

gpuCountinteger

set when rateBasis is gpu

nonBillableboolean

This VM's usage is recorded but never charged (a provider consuming its own reserved node), so pricePerHourCents is informational and every cents figure below is 0 for it. Without this a client cannot tell "not charged" from "nothing running".

orgAccruedCentsinteger required

the org's un-settled usage across all workloads: the current month, plus any prior month not yet settled

orgAccruedMonthCentsinteger required

deprecated alias of orgAccruedCents (same value; the name predates un-settled prior months being included); will be removed in a future spec version

orgAvailableCentsinteger required

spendable balance = ledger balance minus orgAccruedCents (can be negative)

orgBurnPerHourCentsinteger required

sum of the locked rates of every open usage record in the org

perGpuCentsinteger

pricePerHourCents / gpuCount; set when rateBasis is gpu

pricePerHourCentsinteger required

the VM's bundled hourly rate: the open usage record's locked rate when a session is accruing, else the current catalog rate for the VM's shape

projectedRunwayHoursnumber double nullable required

(orgAvailableCents - autoStopFloorCents) / orgBurnPerHourCents; null when orgBurnPerHourCents is 0, clamped to 0 when available is already at or below the floor

rateBasis'gpu' | 'cpu' required

gpu = per-GPU catalog price times gpuCount; cpu = flat per-resource-size rate

rateSource'locked' | 'catalog' required

locked = read from the open usage record (exactly what settlement will charge); catalog = no open session, the rate that would apply on next start

sessionStartedAtstring

start of the open usage session; omitted when none

vmIdstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status