GET
/
api
/
subscriptions
/
curl --request GET \
  --url https://api.uselotus.io/api/subscriptions/ \
  --header 'Authorization: <api-key>'
[
  {
    "subscription_id": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "auto_renew": true,
    "is_new": true,
    "subscription_filters": [
      {
        "value": "<string>",
        "property_name": "<string>"
      }
    ],
    "customer": {
      "customer_name": "<string>",
      "email": "jsmith@example.com",
      "customer_id": "<string>"
    },
    "billing_plan": {
      "plan_name": "<string>",
      "plan_id": "<string>",
      "version_id": "<string>",
      "version": 123
    },
    "fully_billed": true,
    "addons": [
      {
        "addon_subscription_id": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "addon": {
          "addon_name": "<string>",
          "addon_id": "<string>",
          "addon_type": "flat",
          "billing_frequency": "one_time"
        },
        "fully_billed": true
      }
    ],
    "metadata": {}
  }
]

Retrieves an array of subscription objects.

lotus.list_subscriptions(customer_id="cust_id")

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Query Parameters

customer_id
string | null
required

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.

status
enum<string>[]

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

Available options:
active,
ended,
not_started
subscription_filters
object[]

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

200 - application/json
subscription_id
string
required
start_date
string
required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

end_date
string
required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

auto_renew
boolean
required

Whether the subscription automatically renews. Defaults to true.

is_new
boolean
required

Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.

subscription_filters
object[]
required
customer
object
required
billing_plan
object
required
fully_billed
boolean
required
addons
object[]
required
metadata
object
required
Cancel an Add-OnCreate a subscription