List plans
Lists the plans the caller can see.
Lists the plans the caller can see. Anonymous-readable: the pricing page renders from it.
- Path
GET https://api.sylphx.com/v1/plans - Scope
billing:read - Effect
read— nothing is written. - Collection plans
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
plansand, when there is more,next_page_token - Publishable key callable
Request
| Field | Type | What it is |
|---|---|---|
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels and filterable fields. |
order_by | string | AIP-132 ordering over filterable fields. |
Response
| Field | Type | What it is |
|---|---|---|
plans | Plan[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
Plan
| 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. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
PlanVersion
| Field | Type | What it is |
|---|---|---|
version | string | The version, the date it takes effect: YYYY-MM-DD. Output only. |
effective_time | timestamp | When the version takes effect. Output only. |
fee | Money | The monthly fee, charged in advance. Output only. |
included_credit | Money | A monthly usage credit applied to overage. Output only. |
payment_method_required | bool | A payment method is required to be on this plan. Output only. |
meter_prices | MeterPrice[] | Included quantity and price per meter. Output only. |
resource_limits | map<string, int64> | The most Resources per collection, for example projects; -1 means unlimited. Output only. |
rate_limits | map<string, int64> | Requests per minute per rate class (rate_limit_policies × 60, without bursts or bands). Output only. |
rate_limit_policies | RateLimitPolicy[] | The rate limit per rate class (control, inference) as a token bucket, then the higher limits of each committed-spend band. Output only. |
Money
| Field | Type | What it is |
|---|---|---|
currency_code | string | ISO 4217 currency, for example USD. Required. |
units_minor | int64 | The amount in the currency's minor unit (cents for USD). Required. |
MeterPrice
| Field | Type | What it is |
|---|---|---|
meter | string | The meter id. Output only. |
meter_version | int32 | The meter version the price applies to. Output only. |
dimension_match | map<string, string> | The dimensions a usage row must carry for this price to apply; the most specific match wins. Output only. |
included | int64 | The quantity included per period, in the meter's base unit. Output only. |
overage | Overage | What happens past the included quantity. Output only. One of deny, bill, bill_until_spend_limit. |
tiers | PriceTier[] | Price tiers past the included quantity, lowest first. Output only. |
RateLimitPolicy
| Field | Type | What it is |
|---|---|---|
rate_class | string | control (the Resource API) or inference (AI requests). Output only. |
requests_per_second | int64 | Sustained requests per second, per org. Output only. |
burst | int64 | Requests the bucket holds for a burst. Output only. |
min_monthly_spend | Money | Set on a band: the committed monthly spend from which it applies. Output only. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
Examples
curl "https://api.sylphx.com/v1/plans" \
-H "Authorization: Bearer $SYLPHX_API_KEY"