Version
GET

Your Copilot Credits

/v1/me/copilot-credits in the Copilot Credits API.

curl https://api.subscriby.net/v1/me/copilot-credits \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

One object: the balance split into free and paid with what lapses next, this month's free allowance used and left, this month's usage per kind, the per-unit prices, the packs on sale in this environment and the settings the write below changes. An agent asking whether it can afford a turn needs only this.

exhausted is true when the pool has nothing left; the monthly allowance may still cover a turn, which is why the Copilot keeps answering on a Free plan with an empty pool. paid_spent_this_month_cents is the figure the cap in settings is measured against.

GET
/v1/me/copilot-credits

Requires ability

The token must hold this ability, or the call is refused with 403.

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Responses

200OK

The overview: balance, allowance, this month, prices, packs and settings.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

How is this guide?

Last updated on