Skip to content
Console
On this page

Plans

A Plan is a public or private price list: Free, Pro, and the private plans onboarding needs (`agent-trial`, partner plans).

A Plan is a public or private price list: Free, Pro, and the private plans onboarding needs (agent-trial, partner plans). Plans are top-level and read-only; each has immutable dated versions, and an org is on exactly one plan version at a time.

Service Sylphx Billing · Resource type billing.sylphx.com/Plan · Name pattern plans/{plan} · Shape record

Fields

FieldTypeWhat it is
namestringplans/{plan}, for example plans/pro.
uidstringpln_<cell><ulid>. Output only.
metaResourceMetaResource metadata. Output only.
listedboolListed on the pricing page; private plans are visible only to their orgs. Output only.
current_versionstringThe version new subscriptions start on, for example 2026-11-02. Output only.
versionsPlanVersion[]Every version, oldest first. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a plan.
GETlistLists the plans the caller can see. Anonymous-readable: the pricing page renders from it.

get

Gets a plan.

GET https://api.sylphx.com/v1/plans/plan · scope billing:read · effect read · callable with a publishable key · Request, response and examples

list

Lists the plans the caller can see. Anonymous-readable: the pricing page renders from it.

GET https://api.sylphx.com/v1/plans · scope billing:read · effect read · callable with a publishable key · paginated · Request, response and examples