Fetch all subscription plans configured for your project. Each plan includes pricing details, billing duration, recurring payment settings, and the Telegram channels or Discord roles it grants access to. Use this to sync your pricing page or build custom checkout flows.
GET/v2/projects/{project_id}/plans
Authorization
NonePublic
API key scope:plans:read (required for restricted keys).
Authentication is optional. Omit the header for the public view; a supplied invalid token is rejected. Authenticated restricted keys need plans:read.
Restricted keys receive the buyer-eligibility view of plans. Use an unrestricted key when your integration needs the complete management inventory.
Path Parameters
project_idstringrequired
The unique identifier of the project.
Query Parameters
searchstring
Literal, case-insensitive substring of the plan name. At most 100 UTF-16 code units before trimming; empty or whitespace-only means no filter.
sortstringDefault: priority
Sort by priority or name.
orderstring
Sort direction: asc or desc. Defaults to desc for priority sorting, or asc for name sorting.
limitintegerDefault: 10
Number of items per page (1-100).
offsetintegerDefault: 0
Number of items to skip; must be zero or greater.
For example, ?search=Gold&sort=name&order=asc searches for Gold and sorts matching plans by name. Omitting both sorting parameters uses priority descending. Ties use name ascending, then plan ID ascending. total counts matching plans visible to the caller before pagination. Invalid search, sort, order or pagination inputs return 422 VALIDATION_ERROR.
