plans

Changes a plan's price or limits. Requires the admin scope.

patch/v1/plans/{id}

Request

Path parameters

idstring required

Plan id

Request body

maxConcurrentMachinesinteger nullable
maxCpusinteger nullable
maxDiskGbinteger nullable
maxMachinesinteger nullable
maxMemoryMbinteger nullable

Response

Plan updated; applies from the next machine create

allowAlwaysOnboolean required
budgetPolicystring required
createdAtstring required
freeCreditMicrosinteger

Recurring free credit applied to each billing period, in micros (e.g. 5_000_000 = $5/month free). Discount applies after volume tiers.

idstring required
isDefaultboolean required
maxConcurrentMachinesinteger required
maxCpusinteger required
maxDiskGbinteger nullable

Largest disk (GB) one machine may request; null = platform maximum.

maxEgressGbinteger nullable
maxGroupsinteger required
maxMachinesinteger required
maxMemoryMbinteger required
monthlyBudgetMicrosinteger nullable
monthlyFeeMicrosinteger required

Flat recurring platform fee (micros per period); 0 = usage-only plan.

namestring required
rateBaseHourMicrosinteger

Per-machine-alive-hour "slot" fee in micros (e.g. 40_000 = $0.04/hr). Prices the held VM slot on top of consumed CPU/RAM — not allocated resources.

rateCpuHourMicrosinteger required
rateDiskGbHourMicrosinteger
rateEgressGbMicrosinteger
rateExecMicrosinteger required
rateMemoryGbHourMicrosinteger required
selfServeboolean

Whether a tenant may switch itself onto this plan. Operator-only tiers are false and never appear in the self-serve list.

Changes