Skip to main content
GET
List Plans
Returns the active plans assigned to your broker, ordered by sort_order and then display_name. Requires services:read or admin:full.

Use the catalog

Pass a returned slug, id, or display_name to Create Service. For live upgrades and downgrades, pass it as new_plan. Plan names, specifications, and prices are broker-specific. Compare upgrade_rank to determine plan-change direction. The target must have the same billing_type as the current plan; monthly/hourly conversion requires cancellation and recreation. The response is an array without pagination. Missing specifications or prices can be null. An empty array means no active plans are available.
A Sandbox key returns the real broker catalog, not generated plans. Sandbox service creation validates against this catalog, while Sandbox upgrade and downgrade simulations use fixed standard plans. See Sandbox Mode.
For authentication, permissions, rate limits, and error handling, see Errors and Retries.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Response

Active broker plans. No pagination; the array can be empty.

success
boolean
required
data
object[]
required
message
string
pagination
object
Last modified on September 8, 2026