Sign in
api

get/api/plans/

Query parameters

duration'monthly' | 'quarterly' | 'yearly'

Filter to plans that have this duration.

exclude_tagsstring[]

Filter to plans that do not have any of the tags in this list.

include_tagsstring[]

Filter to plans that have any of the tags in this list.

include_tags_allstring[]

Filter to plans that have all of the tags in this list.

version_currency_codestring

Filter to versions that have the currency specified by this currency code.

version_custom_type'custom_only' | 'public_only' | 'all'

Filter to versions that have this custom type. If you choose custom_only, you will only see versions that have target customers. If you choose public_only, you will only see versions that do not have target customers.

version_statusstring[]

Filter to versions that have this status. Ended means it has an active_to date in the past. Not started means it has an active_from date in the future or null.

Response

plan_idstring required
plan_namestring required

Name of the plan

plan_duration'monthly' | 'quarterly' | 'yearly' | 'null' nullable required

Duration of the plan

plan_descriptionstring nullable required

Description of the plan

num_versionsinteger required

The number of versions that this plan has.

active_versioninteger required

This plan's currently active version.

active_subscriptionsinteger required

The number of active subscriptions that this plan has across all versions.

tagsstring[] required

The tags that this plan has.

statusstring required

[DEPRECATED] The status of this plan.

Changes