Get account limits
Check remaining machine starts, included VM time, the wallet, overage prices, access readiness, and concurrent-sandbox capacity for the wallet a create would bill: the org / X-Boat-Org you pass (id or name), else the account’s active wallet, else personal. The response carries teamId when an organization wallet was read.
Authorizations
Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.
Headers
Same as the org query parameter. Query wins when both are set.
Query Parameters
Billing wallet for this request: an organization you belong to, by id (team_…) or by name as GET /orgs lists it (case-insensitive), or personal. Omitted, the account's active wallet applies (PATCH /orgs/active; personal until set). Two organizations sharing the name answer 409 ambiguous_org and need the id. Sandboxes and snapshots stay creator-private. On /environments routes, only this query parameter selects the organization's shared environments; the X-Boat-Org header and the active wallet do not apply there. Members read them, owners and admins change them.
Legacy alias for org. Takes precedence over org / X-Boat-Org when set.
Response
Current creation and concurrent-boat limits.
true
Stable success envelope discriminator added by v1.
Whether the authenticated account can create or operate sandboxes right now.
Account access state returned by the current backend. Billing endpoints are not part of v1.
"trial"
Plan caps for machine starts. Null on unlimited accounts. Create, fork and resume each count as one start.
The one wallet of this account or organization, in US dollars. It pays overage only: VM time past the plan, saved snapshots past the included count, extra starts and the AI proxy. It never pays the plan. Null on unlimited accounts.
What the plan includes this billing period. Null on unlimited accounts.
What the wallet pays past the plan.
What the next start costs now. 0 inside every limit; null when it would be refused.
Start ceilings with extra starts: the hour and day limits times overagePrices.startLimitMultiplier, and the minute limit times overagePrices.startMinuteLimitMultiplier. Starts above startLimits and up to these ceilings are paid from the wallet at the overagePrices.startBrackets prices. Null when extra starts are not available now (before the first payment, an empty wallet, or an unlimited account).
Remaining machine starts in the rolling minute, hour and day windows. Null windows mean the account is unlimited.
Deprecated. Read planIncluded.vmHoursRemaining and wallet.balanceDollars.
Deprecated. Read wallet.balanceDollars.
Deprecated. Read wallet.balanceDollars.
Deprecated. Read wallet.balanceDollars.
Deprecated.
Current plan key, or trial before any payment.
"box_20"
Monthly price of the current plan in dollars.
Every plan tier and its limits.
"user"
"service"
service for service accounts, otherwise null.
Service for service accounts, otherwise null.
True when the account has no machine-time or start limits.
True when an organization has an active per-seat plan.
Machine time used in the last 24 hours, in seconds. Useful to estimate how long the included time and the wallet last.
Lifetime VM-time allowance for new sandboxes while the account has not paid, a plan trial included. Null once the account has paid.
VM time already used against trialComputeCapSeconds. Null once the account has paid.
The trial limits in one readable line. Null on paid accounts.
Each sandbox type, and whether this account can create it now. A blocked type carries the reason.
Fair-use caps on a gifted account, or null when there are none.
Deprecated. Read planIncluded.vmHoursRemaining and wallet.balanceDollars.
Present when limits were read for a team wallet (?teamId=, ?org=, or X-Boat-Org).
Caller's role on that team when teamId is present.