---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Plans"
description: "The `plans` collection of Sylphx Billing: A Plan is a public or private price list: Free, Pro, and the private plans onboarding needs (`agent-trial`, partner plans)."
type: reference
product: platform
summary: "A Plan is a public or private price list: Free, Pro, and the private plans onboarding needs (`agent-trial`, partner plans)."
updated: 2026-09-28
order: 900
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

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`

**Not available yet.** Sylphx Billing is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `plans/{plan}`, for example `plans/pro`. |
| `uid` | `string` | `pln_<cell><ulid>`. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. Output only. |
| `listed` | `bool` | Listed on the pricing page; private plans are visible only to their orgs. Output only. |
| `current_version` | `string` | The version new subscriptions start on, for example `2026-11-02`. Output only. |
| `versions` | `PlanVersion[]` | 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.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/plans#get) | Gets a plan. |
| `GET` | [`list`](/docs/api/plans#list) | Lists 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` · not available yet · callable with a publishable key · [Request, response and examples](/docs/api/plans/get)

## 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` · not available yet · callable with a publishable key · paginated · [Request, response and examples](/docs/api/plans/list)