Subscriptions
List Subscriptions
Retrieve all subscriptions for the authenticated merchant. Excludes soft-deleted subscriptions. Results include associated customer, plan, and price details. Use includeFeatures to also get feature entitlements. Subscriptions have a stableSubscriptionId that persists across plan changes, and an internal id that tracks individual versions.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Query Parameters
includeFeatures?string
Include subscription feature entitlements with feature details (featureId, featureName, featureValue, etc.)
Default
"false"Value in
"true" | "false"Response Body
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/subscriptions"{
"subscriptions": [
{
"id": "sub_01hrwzqrz4ytkwv07syv8k7g3z",
"stableSubscriptionId": "sub_stable_abc123",
"merchantId": "mrc_01hptv3p6xj173pfv96pxd5pke",
"customerId": "cus_01hrx123",
"planId": "pln_01hrx456",
"effectivePriceId": "prc_01hrx789",
"status": "active",
"startTimestamp": "2024-12-01T00:00:00.000Z",
"endTimestamp": null,
"currentPeriodStart": "2024-12-01T00:00:00.000Z",
"currentPeriodEnd": "2025-01-01T00:00:00.000Z",
"cancelAtPeriodEnd": false,
"trialEndDate": null,
"gracePeriodEndsAt": null,
"createdAt": "2024-12-01T10:00:00.000Z",
"customer": {
"id": "cus_01hrx123",
"name": "Jane Doe",
"email": "jane@example.com"
},
"plan": {
"id": "pln_01hrx456",
"planName": "Pro Plan"
},
"price": {
"id": "prc_01hrx789",
"currency": "USD",
"pricingData": {
"type": "recurring",
"interval": "month",
"amountCents": 2999
}
}
}
]
}{
"error": "Failed to list subscriptions"
}