Skip to main content
GET
/
api
/
public
/
plans
/
{planId}
{
  "Id": 123,
  "Name": "<string>",
  "Description": "<string>",
  "Price": 123,
  "PriceCurrencyCode": "<string>"
}

​
Get Plan Details

Returns the full configuration and pricing details for a specific plan. Used on the plan detail page to show features, pricing tiers, and included benefits.

​
Authentication

No authentication required for public plan details.

​
Path Parameters

​
planId
number
required
Numeric identifier of the plan. Returned as Id from the published plans endpoint.

​
Query Parameters

​
_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Name,Price,Description,InvoiceEvery,TimePasses,ExtraServices.

​
Response

Returns a Tariff object with full plan configuration.
​
Id
number
required
Unique identifier for the plan.
​
Name
string
required
Display name of the plan.
​
Description
string
Full plan description. May contain HTML.
​
Price
number
Base recurring price.
​
PriceCurrencyCode
string
ISO 4217 currency code.

​
Examples

​
Fetch plan details

GET /api/public/plans/12

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: plan } = useTypedData(httpClient, endpoints.plans.one(12))