Skip to main content
GET
Inspect account billing

Authorizations

Authorization
string
header
required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Response

The account billing status.

plan
enum<string>
required

pro while the Stripe subscription is active; free otherwise, including after Pro lapses.

Available options:
free,
pro
compute_allowed
boolean
required

Whether the account may hold and use VMs: true on Pro. On Free, its computers with a VM are fenced until it is Pro again; its sites keep serving.

site_limit
integer | null
required

How many sites the account holds at once, with a VM or without: 20 on Free, null (any number) on Pro. Creating or claiming a site past it answers 403 site_limit_reached.

subscription_status
enum<string>
required
Available options:
none,
incomplete,
incomplete_expired,
active,
past_due,
canceled,
unpaid,
paused,
unmanaged
price_cents
integer
required
currency
string
required
Allowed value: "usd"
interval
string
required
Allowed value: "month"
computer_limit
integer
required

VMs a Pro account holds at once.

guest_memory_ceiling_mib
integer
required

Guest-visible memory ceiling for each live computer. Physical residency is measured and not pre-allocated per computer.

account_memory_limit_mib
integer
required

Memory all of the account's computers may hold together, idle ones included. It is a ceiling, not a reservation: one busy computer may use whatever the account's idle computers leave, about 110 MiB each.

checkout_available
boolean
required
management_available
boolean
required
renews_at
string<date-time> | null
required

When the paying subscription next renews; null when it is set to end, or when no paying subscription or period is known.

ends_at
string<date-time> | null
required

When a paying subscription set to cancel ends; null otherwise.