Skip to main content
GET
Get credit balance

Authorizations

The full Cookie header copied from a signed-in connie.ai browser request. See the Authentication page.

Path Parameters

workspaceId
string<uuid>
required

The workspace id, as in the app URL connie.ai/<workspaceId>/....

Response

The balance.

balance
number

Total credits available (plan plus top-up). Can be negative when overdrawn.

seatBalance
number

Plan credits.

topupBalance
number

Top-up credits from credit packs and auto top-up. They never expire.

tier
enum<string>

The plan, as a stable id. In the app, starter, plus and build are the Starter plans (2,500, 10,000 and 22,000 credits a month) and scale, growth and pro_max are the Scale plans (35,000, 55,000 and 100,000).

Available options:
free,
starter,
plus,
build,
scale,
growth,
pro_max
planName
string

The plan name shown in the app, with the credits it adds per billing period (for example "Starter 2,500/mo", or "Starter 30,000/yr" on an annual plan).

trialPaused
boolean

A cancelled trial is paused; paid work waits until it resumes or a paid plan starts.

paidExecutionBlocked
enum<string> | null

Paid work is blocked independently of the balance. A Standard workspace needs a subscription after trial end; Beta/Internal retain their exceptions. Browsing stays available.

Available options:
trial_paused,
trial_ended,
null
accessMode
enum<string>

Product access policy, independent of the spendable balance.

Available options:
standard,
beta,
internal
accessState
enum<string>

Current workspace product state. Access does not authorize spending credits. free: the workspace is spending its free signup credits. free_spent: it has used them all and needs a plan. A new workspace receives its free credits on first use, so before_trial is rarely seen.

Available options:
before_trial,
trial,
trial_ended,
subscribed,
beta,
internal,
free,
free_spent
freeCredits
object | null

The workspace's free credits, as shown in the sidebar meter. Null unless accessState is free or free_spent.

paymentRecovery
object | null

Unresolved subscription recovery, retained after downgrade to Free. No private payment details.