Me

Get the caller's current plan

GET
/v1/me/plan

The active organization's resolved plan (with its limit map), the subscription status backing it, and the plan grants attached to the organization and to the user.

plan is null when the workspace has no active, trialing, or past-due subscription. No billing details (invoices, payment methods) are exposed.

Authorization

x-api-key<token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/me/plan"
{
  "grants": {
    "organization": [
      {
        "additive": true,
        "planId": "string"
      }
    ],
    "user": [
      {
        "planId": "string"
      }
    ]
  },
  "organizationId": "string",
  "plan": {
    "displayName": "string",
    "group": "string",
    "id": "string",
    "limits": {
      "property1": null,
      "property2": null
    },
    "name": "string"
  },
  "subscription": {
    "planName": "string",
    "status": "string"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}
{
  "error": "string"
}

Get the caller's credit balance and usage GET

Balance split by bucket (cycle allowance, purchased on-demand, personal), the per-cycle allowance and on-demand unit price, and ledger totals over a window. The window defaults to the current calendar month to date (UTC). Figures are for the caller's own membership in their active organization — the same organization the API meters requests against.

Update the current caller's profile PATCH

Partial update — send only the fields that change; `null` clears one. Returns the account in the same shape as `GET /v1/me`. `email` is NOT updatable here: changing it runs a verification flow. Sending it is a 400, not a silent no-op.