List plans

Headers

X-Schematic-Api-KeystringRequired

Query parameters

company_idstringOptional
for_fallback_planbooleanOptional

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

for_initial_planbooleanOptional

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

for_trial_expiry_planbooleanOptional

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

has_product_idbooleanOptional
Filter out plans that do not have a billing product ID
idslist of stringsOptional
plan_typeenumOptional
Filter by plan type
Allowed values:
qstringOptional
requires_payment_methodbooleanOptional

Filter for plans that require a payment method (inverse of ForInitialPlan)

without_entitlement_forstringOptional
Filter out plans that already have a plan entitlement for the specified feature ID
without_product_idbooleanOptional
Filter out plans that have a billing product ID
without_paid_product_idbooleanOptional
Filter out plans that have a paid billing product ID
limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

OK
datalist of objects
paramsobject
Input parameters

Errors