Skip to main content
GET
List plans

Authorizations

Authorization
string
header
required

Workspace API token. Create one under Settings → Core Platform → API Keys and grant it the plans:read scope.

Query Parameters

billing_period
enum<string>

Show only plans that bill on this period.

Available options:
monthly,
quarterly,
half_yearly,
yearly,
lifetime
include_private
boolean
default:false

Set to true to also include private plans. By default you only get the plans shown on your pricing page.

Response

The catalogue, keyed by billing period.

status
string
Example:

"success"

data
object
meta
object