v80

OpenAPI 3.0.0raw.githubusercontent.com2026-08-03260491955.2 KB
plans

List plans

get/plans

Query parameters

company_idstring
company_scoped_onlyboolean

Only return plans that are scoped to a company (custom plans assigned to a company)

Only return plans that are scoped to a company (custom plans assigned to a company)

exclude_company_scopedboolean

Exclude plans that are scoped to a company (custom plans assigned to a company)

Exclude plans that are scoped to a company (custom plans assigned to a company)

for_fallback_planboolean

Filter for plans valid as fallback plans (not linked to billing)

Filter for plans valid as fallback plans (not linked to billing)

for_initial_planboolean

Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)

Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)

for_trial_expiry_planboolean

Filter for plans valid as trial expiry plans (not linked to billing or free)

Filter for plans valid as trial expiry plans (not linked to billing or free)

has_product_idboolean

Filter out plans that do not have a billing product ID

Filter out plans that do not have a billing product ID

idsstring[]
include_draft_versionsboolean

Include billing settings from draft versions for plans which have draft version

Include billing settings from draft versions for plans which have draft version

plan_type'plan' | 'add_on'

Filter by plan type

qstring
scoped_to_company_idstring

Filter plans scoped to a specific company (custom plans)

Filter plans scoped to a specific company (custom plans)

with_entitlementsboolean

Include each plan's entitlements in the response

Include each plan's entitlements in the response

without_entitlement_forstring

Filter out plans that already have a plan entitlement for the specified feature ID

Filter out plans that already have a plan entitlement for the specified feature ID

without_paid_product_idboolean

Filter out plans that have a paid billing product ID

Filter out plans that have a paid billing product ID

limitinteger

Page limit (default 100)

Page limit (default 100)

offsetinteger

Page offset (default 0)

Page offset (default 0)

Response

OK