Skip to content
Open Markdown

List the public product catalog ​

GET /v1/public/products

  • Operation ID: listPublicProducts
  • Tags: Public site
  • Base URL: http://localhost:8787

Active, public plans and credit packs ordered by sort_order. Returned as a bare array.

Workflow: Integration guide.

Authentication: none (public).

Authentication ​

  • Auth: none (public endpoint, no token required).

Responses ​

200 ​

Product catalog.

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

Schema: (object (PublicProduct))[]

FieldTypeRequiredDescription
[].idstring<uuid>yes-
[].keystringyes-
[].namestringyes-
[].descriptionstring | nullyes-
[].typestringyesProduct type, e.g. a subscription plan or credit_pack.
[].tier_keystringyes-
[].credits_includedintegeryes-
[].featuresanynoMarketing feature list; shape defined by the catalog.
[].sort_orderintegeryes-
[].highlightbooleanyes-
[].badgestring | nullyes-
[].pack_creditsinteger | nullyesCredit packs only.
[].pack_bonus_creditsinteger | nullyesCredit packs only.
[].pack_expires_afterstring | nullyesCredit packs only; Postgres interval text.
[].default_stripe_price_idstring | nullyes-
[].pricesanynoPrice list for the product (Stripe price ids, currency, amounts).

Errors ​

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)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional structured context. For 403 it is { perm }.

Error response

json
{
  "error": "internal"
}

Examples ​

curl ​

bash
curl -X GET 'http://localhost:8787/v1/public/products'

TypeScript ​

ts
const response = await fetch("http://localhost:8787/v1/public/products", {
  method: "GET",
});
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();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/public/products

Your token stays in this tab's memory and is sent only when you press Send request.

Built for developers. Ready for agents.