Skip to main content
GET
Get Plan Details

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

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

Query Parameters

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.
number
required
Unique identifier for the plan.
string
required
Display name of the plan.
string
Full plan description. May contain HTML.
number
Base recurring price.
string
ISO 4217 currency code.

Examples

Fetch plan details

TypeScript Integration