Get plan

Fetch a single plan. Pass ?include=chips to also return the chip list from the current version.

GET /plans/{id}

Get plan

cURL

curl --request GET \
  --url https://api.openquota.ai/v1/plans/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "current_version_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "chips": "<unknown>"
}

Pass ?include=chips to also return the current plan version’s chip list — that’s the full set of rules the engine evaluates. The shape of the chips payload mirrors the plan model used internally; it’s stable within a version but new chip kinds may appear over time.

Authorizations

Authorization · string · header · required

Provide your API key as Authorization: Bearer <key>. Generate keys in the OpenQuota admin under Settings → API Keys.

Path Parameters

id · string · required

Example:

"pln_01abc..."

Query Parameters

include · enum<string>

Pass chips to include the chip list in the response.

Available options: chips

Response

200

application/json

The plan.

id · string · required

name · string · required

current_version_id · string | null · required

created_at · string<date-time> · required

chips · any | null

Chip list from the current plan version. Present only when ?include=chips is passed.