List products

GET /v1/admin/plans/products

• Operation ID: listPlanProducts
• Tags: Plans and pricing
• Base URL: http://localhost:8787

All local billing products ordered by sort order then name. Returns a bare array (not paginated).

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission plans.read.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: plans.read

Responses

200

Products.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: (object (PlansProduct))[]

Field	Type	Required	Description
[].id	string<uuid>	yes	-
[].key	string	yes	-
[].name	string	yes	-
[].description	string | null	yes	-
[].type	string	yes	One of: "subscription", "credit_pack"
[].tier_key	string	yes	-
[].ruleset_id	string<uuid>	yes	-
[].ruleset_key	string	yes	-
[].credits_included	integer	yes	-
[].stripe_product_id	string | null	yes	-
[].default_stripe_price_id	string | null	yes	-
[].features	string[]	yes	-
[].sort_order	integer	yes	-
[].is_public	boolean	yes	-
[].highlight	boolean	yes	-
[].badge	string | null	yes	-
[].is_active	boolean	yes	-
[].metadata	object	yes	-

Errors

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "plans.read"
  }
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X GET 'http://localhost:8787/v1/admin/plans/products' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/plans/products", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();