List plans
curl --request GET \
--url https://api.uselotus.io/api/plans/ \
--header 'Authorization: <authorization>'
[
{
"active_subscriptions": 123,
"active_version": 123,
"display_version": {
"active_from": "2023-11-07T05:31:56Z",
"active_to": "2023-11-07T05:31:56Z",
"components": [],
"created_on": "2023-11-07T05:31:56Z",
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>"
},
"description": "<string>",
"features": [],
"flat_fee_billing_type": "in_advance",
"flat_rate": 123,
"localized_name": "<string>",
"plan_name": "<string>",
"price_adjustment": {
"price_adjustment_amount": 123,
"price_adjustment_description": "<string>",
"price_adjustment_name": "<string>",
"price_adjustment_type": "percentage"
},
"recurring_charges": [],
"status": "active",
"target_customers": [],
"usage_billing_frequency": "<string>",
"version": 123
},
"external_links": [
{
"external_plan_id": "<string>",
"source": "stripe"
}
],
"num_versions": 123,
"parent_plan": {
"plan_id": "<string>",
"plan_name": "<string>"
},
"plan_description": "<string>",
"plan_duration": "monthly",
"plan_id": "<string>",
"plan_name": "<string>",
"status": "<string>",
"tags": [
"<string>"
],
"target_customer": {
"customer_id": "<string>",
"customer_name": "<string>",
"email": "jsmith@example.com"
},
"versions": [
{
"active_from": "2023-11-07T05:31:56Z",
"active_to": "2023-11-07T05:31:56Z",
"components": [],
"created_on": "2023-11-07T05:31:56Z",
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>"
},
"description": "<string>",
"features": [],
"flat_fee_billing_type": "in_advance",
"flat_rate": 123,
"localized_name": "<string>",
"plan_name": "<string>",
"price_adjustment": {
"price_adjustment_amount": 123,
"price_adjustment_description": "<string>",
"price_adjustment_name": "<string>",
"price_adjustment_type": "percentage"
},
"recurring_charges": [],
"status": "active",
"target_customers": [],
"usage_billing_frequency": "<string>",
"version": 123
}
]
}
]
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
Token-based authentication with required prefix "Token"
Query Parameters
Filter to plans that have this duration.
monthly
- Monthlyquarterly
- Quarterlyyearly
- Yearly
monthly
, quarterly
, yearly
Filter to plans that do not have any of the tags in this list.
Filter to plans that have any of the tags in this list.
Filter to plans that have all of the tags in this list.
Filter to versions that have the currency specified by this currency code.
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 Onlypublic_only
- Public Onlyall
- All
custom_only
, public_only
, all
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.
active
, ended
, not_started
Response
The number of active subscriptions that this plan has across all versions.
This plan's currently active version.
[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.
The external links that this plan has.
The number of versions that this plan has.
[DEPRECATED] The parent plan that this plan has.
Description of the plan
Duration of the plan
monthly
- Monthlyquarterly
- Quarterlyyearly
- Yearly
monthly
, quarterly
, yearly
,
Name of the plan
[DEPRECATED] The status of this plan.
The tags that this plan has.
[DEPRECATED] The target customer that this plan has.
This plan's versions.
curl --request GET \
--url https://api.uselotus.io/api/plans/ \
--header 'Authorization: <authorization>'
[
{
"active_subscriptions": 123,
"active_version": 123,
"display_version": {
"active_from": "2023-11-07T05:31:56Z",
"active_to": "2023-11-07T05:31:56Z",
"components": [],
"created_on": "2023-11-07T05:31:56Z",
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>"
},
"description": "<string>",
"features": [],
"flat_fee_billing_type": "in_advance",
"flat_rate": 123,
"localized_name": "<string>",
"plan_name": "<string>",
"price_adjustment": {
"price_adjustment_amount": 123,
"price_adjustment_description": "<string>",
"price_adjustment_name": "<string>",
"price_adjustment_type": "percentage"
},
"recurring_charges": [],
"status": "active",
"target_customers": [],
"usage_billing_frequency": "<string>",
"version": 123
},
"external_links": [
{
"external_plan_id": "<string>",
"source": "stripe"
}
],
"num_versions": 123,
"parent_plan": {
"plan_id": "<string>",
"plan_name": "<string>"
},
"plan_description": "<string>",
"plan_duration": "monthly",
"plan_id": "<string>",
"plan_name": "<string>",
"status": "<string>",
"tags": [
"<string>"
],
"target_customer": {
"customer_id": "<string>",
"customer_name": "<string>",
"email": "jsmith@example.com"
},
"versions": [
{
"active_from": "2023-11-07T05:31:56Z",
"active_to": "2023-11-07T05:31:56Z",
"components": [],
"created_on": "2023-11-07T05:31:56Z",
"currency": {
"code": "<string>",
"name": "<string>",
"symbol": "<string>"
},
"description": "<string>",
"features": [],
"flat_fee_billing_type": "in_advance",
"flat_rate": 123,
"localized_name": "<string>",
"plan_name": "<string>",
"price_adjustment": {
"price_adjustment_amount": 123,
"price_adjustment_description": "<string>",
"price_adjustment_name": "<string>",
"price_adjustment_type": "percentage"
},
"recurring_charges": [],
"status": "active",
"target_customers": [],
"usage_billing_frequency": "<string>",
"version": 123
}
]
}
]