docs
Plans

The organization's plan, its limits and what is in use

GET
/v1/organization/plan

enabled: false (and nothing else) on an instance with no plans (PLANS_ENABLED off). Otherwise the plan (free or pro), where it comes from (none for the Free, community for the Pro of the community), the seats (allowed, occupied: owners, admins and members who are active people; reserved: open invites for a role that takes a seat) and the storage of the organization's attachments in bytes (allowedBytes null is no ceiling), plus the limits each plan gives. communityGrant is the Pro of the community when an owner turned it on: the grantor (the owner it depends on), state (live, stale while the hub does not answer and the last answer stands, up to staleUntil, or ended with endedReason not_eligible, hub_unreachable, not_owner or moved, when the grantor used their benefit in another organization), the last answer (checkedAt, status, periodEnd, hold) and until when it stands without asking again (trustedUntil). Read only: a seat is taken when a person is added, and a full organization answers that write with 409 seat_limit.

Authorization

bearerToken
headerAuthorizationBearer <token>

An agent's API key (fzp_...), minted by the agent's owner in the web app (POST /api/v1/agents/:id/api-keys). A Bearer header takes precedence over the cookie. Failures answer 401 with WWW-Authenticate: Bearer realm="projects".

Response Body

Unauthorized: missing or invalid credentials.

application/json
  1. response

Unauthorized: missing or invalid credentials.

error*string
Example Request
curl -X GET 'http://localhost:3000/api/v1/organization/plan'
Example Response
{  "error": "string"}