--- # @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit. title: "Get a plan" description: "`billing.plans.get` (GET /v1/{name}): Gets a plan." type: reference product: platform summary: "Gets a plan." updated: 2026-09-28 nav: false --- > **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. Gets a plan. **Not available yet.** Sylphx Billing is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`. - **Path** `GET https://api.sylphx.com/v1/plans/plan` - **Scope** `billing:read` - **Effect** `read` — nothing is written. - **Collection** [plans](/docs/api/plans) - **Publishable key** callable ## Request | Field | Type | What it is | | --- | --- | --- | | `name` | `string` | The name of the plan to get. Required. | ## Response | Field | Type | What it is | | --- | --- | --- | | `name` | `string` | `plans/{plan}`, for example `plans/pro`. | | `uid` | `string` | `pln_`. 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` | Caller-writable, indexed labels (AIP-122 label rules). | | `annotations` | `map` | 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` | The most Resources per collection, for example `projects`; -1 means unlimited. Output only. | | `rate_limits` | `map` | 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` | 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. | ### PriceTier | Field | Type | What it is | | --- | --- | --- | | `upper_bound` | `int64` | The tier ends at this quantity in the period, inclusive; 0 means unbounded. Output only. | | `unit_amount_minor` | `Rational` | The price per base unit, in minor units of the plan's currency. Output only. | ## Errors - [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented. - [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission. - [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible. Every error arrives in the body [Errors](/docs/platform/errors) describes. ## Examples **cURL** ```curl curl "https://api.sylphx.com/v1/plans/plan" \ -H "Authorization: Bearer $SYLPHX_API_KEY" ``` **TypeScript** ```ts const response = await sylphx.billing.plans.get({ name: 'plans/plan' }) ``` **Rust** ```rust let mut req = sylphx::billing::GetPlanRequest::default(); req.name = "plans/plan".to_string(); let response = sx.billing().plans().get(req).await?; ``` **CLI** ```bash sylphx billing plans get plans/plan ``` **MCP** ```json { "method_id": "billing.plans.get", "args": {"name":"plans/plan"} } ```