Docs
⌘K
Billing ›

List billing plans

GET/v1/billing/plans

What is sold: plans, top-ups and their bonus, the free plan's terms and the hourly prices.

RequestTypeScript
  1. import { Agental } from "agental-sdk";
  3. const agental = new Agental();
  4. const prices = await agental.prices();
Answer200 OK · Prices
  1. {
  2. "currency": "usd",
  3. "interval": "hour",
  4. "label": "list price",
  5. "note": string,
  6. "plans": [{
  7. "size": "tiny" | "small" | "medium" | "large",
  8. "vcpu": integer,
  9. "memoryMb": integer,
  10. "diskGb": integer,
  11. "listPriceMicrosPerHour": integer,
  12. "stoppedMicrosPerHour": integer,
  13. … 3 more
  14. }],
  15. "tiers": [{
  16. "id": string,
  17. "dollarsPerMonth": integer,
  18. "includedMicros": integer,
  19. "runningUnits": integer,
  20. "freeBurstUnits": integer,
  21. "sandboxesAtOnce": integer,
  22. … 2 more
  23. }],
  24. "burstFee": {
  25. "halfLifeMinutes": integer,
  26. "feeMicrosPerGib": integer,
  27. "defaultBudgetMicros": integer,
  28. },
  29. "topUps": [{
  30. "id": string,
  31. "dollars": integer,
  32. "micros": integer,
  33. "bonusMicros": integer,
  34. "bonusPercent": number,
  35. }],
  36. "topUpRange": {
  37. "minDollars": integer,
  38. "maxDollars": integer,
  39. },
  40. … 4 more
  41. }

List price per hour for each size, in millionths of a US dollar.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 List price per hour for each size, in millionths of a US dollar. Not a charge.

Prices13 fields
currency
usd
interval
hour
label
list price
note
string
plans
object[]9 fields
Each size and what an hour of it costs.
More Named plans for the days when a size was the only thing to choose.
size
tinysmallmediumlarge
vcpu
integer
memoryMb
integer
diskGb
integer
listPriceMicrosPerHour
integer
stoppedMicrosPerHour
integer
What an hour of it stopped costs, with its disk kept: 5% of listPriceMicrosPerHour.
stoppedWithMemoryMicrosPerHour
integer
What an hour of it stopped with its memory kept costs, its disk kept too: 10% of listPriceMicrosPerHour.
currency
usd
label
list price
tiers
object[]8 fields
The plans: what each costs a month, what it includes, which sizes it makes, how many sandboxes it runs at once, and how many it starts at once for nothing.
More The first, free, costs and includes nothing: it pays from top-ups and its one credit, see free.
id
string
dollarsPerMonth
integer
includedMicros
integer
Credits the month's price pays for, in millionths of a US dollar: what the plan costs, to the dollar.
More They do not carry over.
runningUnits
integer
Small sandboxes the plan runs at once.
More A medium counts 2, a large 4, a tiny half. A create, fork or start past it is refused with 429 running_limit_reached.
freeBurstUnits
integer
Small sandboxes the plan starts at once for nothing, counted as runningUnits is.
More Starting faster costs a burst fee: see burstFee, and GET /v1/burst for an account's own.
sandboxesAtOnce
integer
The same as runningUnits: small sandboxes the plan runs at once.
More Sent for clients that read it, and it will be removed.
burst
object3 fields
Kept for clients that read it: the free burst in megabytes.
More Nothing is refused for speed now; a start faster than the free burst costs a fee.
tier
integer
The plan's place among the plans, 0 for the free plan.
perQuarterMb
integer
The plan's free burst, in megabytes: freeBurstUnits times 4096.
perHourMb
integer
The same as perQuarterMb.
sizes
string[]
The sizes a new sandbox, fork or template start may be on this plan, smallest first.
More A sandbox made before a change of plan still starts at its own size.
burstFee
object3 fields
What a start costs when an account starts sandboxes faster than its plan's free burst.
More Fees come out of the plan's credits and then the top-ups.
halfLifeMinutes
integer
How long an account's burst meter takes to fall by half.
More Each start adds its memory to it.
feeMicrosPerGib
integer
What a GiB started costs once the meter is at twice the free burst, in millionths of a US dollar.
More It costs nothing at the free burst's edge and rises in a straight line with how far over the meter goes: fee = feeMicrosPerGib / (2 × free) × (over after² − over before²), in GiB. A burst to twice the free burst costs about $0.04 for each small sandbox past it, one to three times about $0.08.
defaultBudgetMicros
integer
What an account spends on burst fees in a month at most unless it sets another budget: PUT /v1/burst/budget.
topUps
object[]5 fields
Top-ups offered as a choice: credits bought once, on any plan, the free one included.
More Any other whole number of dollars in topUpRange may be bought too. It is used after the month's credits, and it does not expire.
id
string
dollars
integer
micros
integer
Credits it adds, in millionths of a US dollar: what it costs and the bonus.
bonusMicros
integer
The part of micros that is the bonus.
bonusPercent
number
The bonus as a share of what it costs, to one place.
topUpRange
object2 fields
The smallest and the largest top-up, in whole US dollars.
minDollars
integer
maxDollars
integer
topUpBonus
object4 fields
The bonus on a top-up: none below fromDollars, fromPercent at fromDollars, rising evenly on a log scale to toPercent at toDollars, and toPercent from there on.
More The percent is rounded to one place, and what it adds to the cent.
fromDollars
integer
fromPercent
number
toDollars
integer
toPercent
number
volumeDiscount
object[]2 fields
Retired: bigger top-ups get a bonus instead, see topUpBonus.
More Always one step of 0%, sent for clients that read it.
fromMicros
integer
percent
number
storage
object4 fields
What a stopped sandbox's disk and snapshots past the free ones cost, by the second, from the plan's credits and then the top-ups.
stoppedPercent
number
What a stopped sandbox costs, as a share of its running price.
More Each size's is in plans[].stoppedMicrosPerHour.
stoppedWithMemoryPercent
number
What a sandbox stopped with its memory kept costs, as a share of its running price.
More Each size's is in plans[].stoppedWithMemoryMicrosPerHour.
freeSnapshots
integer
How many of an account's snapshots cost nothing: its oldest ones.
snapshotMicrosPerHour
integer
What each snapshot past the free ones costs an hour: $1.70 over a month of 730 hours.
free
object3 fields
The free plan: nothing a month, and what it runs is paid from top-ups and its one credit.
More It needs a card saved, charged nothing: POST /v1/billing/checkout with {"card": true}.
planId
free
creditMicros
integer
The credit an account on the free plan is given once, when it first saves a card, in millionths of a US dollar.
More It does not expire.
unpaidUnits
integer
Small sandboxes the free plan runs and starts at once, at most, until the account has paid for something, a top-up of any size.
More Then the plan's runningUnits. A tiny counts half.
← Get tierGet billing →