Plans
Get Plan
GET

/api/plans/{plan_id}/

X-API-KEY*
Authorization*
curl --request GET \
  --url https://api.uselotus.io/api/plans/{plan_id}/ \
  --header 'Authorization: <authorization>' \
  --header 'X-API-KEY: <x-api-key>'

Retrieves a plan object.

lotus.get_plan(
    plan_id='plan_0569173ee6654369',
)

Authorizations

Authorization[header]required
string

Token-based authentication with required prefix "Token"

Path Parameters

plan_idrequired
string

Query Parameters

version_currency_code
string

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

version_custom_typeDefault: "all"
string

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.

  • custom_only - Custom Only
  • public_only - Public Only
  • all - All
version_statusDefault: ["active","not_started","ended"]
array

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

active_subscriptionsrequired
integer

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

active_versionrequired
integer

This plan's currently active version.

display_versionrequired
object

[DEPRECATED] Display version has been deprecated. Use 'versions' instead. We will still return this field for now with some heuristics for figuring out what the desired version is, but it will be removed in the near future.

external_linksrequired
array

The external links that this plan has.

num_versionsrequired
integer

The number of versions that this plan has.

parent_planrequired
object

[DEPRECATED] The parent plan that this plan has.

plan_descriptionrequired
string

Description of the plan

plan_durationrequired
string

Duration of the plan

  • monthly - Monthly
  • quarterly - Quarterly
  • yearly - Yearly
Available options:
monthly,
quarterly,
yearly,
null
plan_idrequired
string
plan_namerequired
string

Name of the plan

statusrequired
string

[DEPRECATED] The status of this plan.

tagsrequired
string[]

The tags that this plan has.

target_customerrequired
object

[DEPRECATED] The target customer that this plan has.

versionsrequired
array

This plan's versions.