Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Get the plan of the workspace

The plan of the workspace at Troopy: the Trial, Pro, Max or Ultra, what the plan lets it do, whether its teammates work, and when it renews or ends. Each workspace pays for itself, and people are free. Owners and admins change the plan in Settings > Billing. Needs an owner or admin.

get/api/v1/billing

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy billing get
MCP tooltroopy_get_billing
Rate limit60 calls in 60 seconds, for each key

Response

200 · application/json
data*object
10 properties
billed*boolean

Whether Troopy charges for workspaces here. False: every workspace has Ultra

state*enum<string>

trial: the 3-day Trial of the organization, on a card that Stripe charges at trialEnd. past_due: Stripe tries the card again. ended and none: the teammates stop

trialactivepast_dueendednone

plan*enum<string> | null

The plan of the subscription, also in its Trial

promaxultra

interval*enum<string> | null

How often the workspace pays

monthyear

works*boolean

The teammates work, and the computer wakes

big*boolean

A computer above the small one, for faster builds, tests and browsing: Max and Ultra, also in a Trial

limits*object

What the plan lets the workspace do

5 properties
teammates*integer
voiceMinutes*integer

Minutes of voice a month on Troopy's own OpenAI key

picturesPerDay*integer
runs*object

The most that one teammate may be set to

3 properties
rounds*integer
runsPerDay*integer
usdPerRun*number
replaysPerDay*integer

The new session replays that the site records in a UTC day

trialEnd*string | null

When the Trial ends, and Stripe charges the card unless someone cancelled

periodEnd*string | null

When the plan renews

cancelAt*string | null

When the plan stops, after a cancel

Errors

401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.