Get the organization's plan

GET/v1/organization/plan

Authorization

AuthorizationBearer token · headerrequired

Responses

200The plan, and how much of each resource the organization holds against it.

allowancesAllowanceBody[]required

One for every resource a plan can cap, capped or not.

Show properties

Array of AllowanceBody

maxinteger<int32> | nullrequired

The most the plan allows, or `null` where it does not cap this.

resourcePlanResourceBodyrequired

A resource a plan may cap.

Allowed:workspacesagentsvaultsskillsfunctionsapi_keysmodel_providerssessionsmembers

usedinteger<int64>required

How many the organization holds, counted as a creation's check counts them. It can exceed `max` after a move to a smaller plan: what is held is kept, and only the next creation is refused.

descriptionstring | nullrequired

display_namestring | nullrequired

slugstringrequired

401Missing, malformed, or invalid bearer token.

errorErrorDetailrequired

What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.

Show properties

codeErrorCoderequired

The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.

Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Request

curl -X GET "https://api.us.cloud.subako.ai/v1/organization/plan" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.us.cloud.subako.ai/v1/organization/plan", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.us.cloud.subako.ai/v1/organization/plan",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "allowances": [
    {
      "max": 0,
      "resource": "workspaces",
      "used": 0
    }
  ],
  "description": "string",
  "display_name": "string",
  "slug": "string"
}

{
  "error": {
    "code": "unauthorized",
    "message": "string"
  }
}