Lotus home pagelight logo
Subscriptions
List subscriptions
GET

/api/subscriptions/

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

Retrieves an array of subscription objects.

lotus.list_subscriptions(customer_id="cust_id")

​
Authorizations

Authorization[header]required
string

Token-based authentication with required prefix "Token"

​
Query Parameters

customer_idrequired
string

Filter to a specific customer.

plan_id
string

Filter to a specific plan.

range_end
string

If specified, will only return subscriptions with a start date before this date.

range_start
string

If specified, will only return subscriptions with an end date after this date.

statusDefault: ["active"]
array

Filter to a specific set of subscription statuses. Defaults to active.

subscription_filters
array

Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'.

​
Response

array