Plans
List plans
GET

/api/plans/

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

Retrieves an array of plan objects.

Out of the parameters below, duration, exclude_tags, include_tags, and include_tags_all will filter plan objects. version_currency_code, version_custom_type, and version_status will filter versions within those plans. If a plan has no versions that match the filter, it will not be returned.

lotus.list_plans()

Authorizations

Authorization[header]required
string

Token-based authentication with required prefix "Token"

Query Parameters

duration
string

Filter to plans that have this duration.

  • monthly - Monthly
  • quarterly - Quarterly
  • yearly - Yearly
exclude_tags
array

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

include_tags
array

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

include_tags_all
array

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

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

array