Plans
List Plans
Retrieve all plans for the authenticated merchant. Excludes soft-deleted plans and trial plans by default. Plans are versioned—each stablePlanId can have multiple versions. Results can include associated features, prices, and trial information.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Query Parameters
includeFeatures?string
Include associated features with each plan version. Adds features array with featureId, featureName, featureSlug, and featureValue.
Default
"false"Value in
"true" | "false"includePrices?string
Include associated prices for each plan. Adds prices array with full pricing details (interval, amount, currency, etc.).
Default
"false"Value in
"true" | "false"includeTrials?string
Include trial plans (isTrialPlan=true) in results. By default, trial plans are excluded.
Default
"false"Value in
"true" | "false"Response Body
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/plans"{
"plans": [
{
"id": "pln_01hrwzqrz4ytkwv07syv8k7g3z",
"stablePlanId": "pln_stable_abc123",
"merchantId": "mrc_01hptv3p6xj173pfv96pxd5pke",
"versionNumber": 1,
"planName": "Pro Plan",
"planDescription": "Advanced features for growing teams",
"commitMessage": "Initial version",
"isTrialPlan": false,
"trialParentPlanId": null,
"trialDays": null,
"pspPlanId": null,
"createdAt": "2024-12-01T10:00:00.000Z",
"deletedAt": null,
"isVisibleInPricingTable": true
}
]
}{
"error": "Failed to list plans",
"details": "Database query failed"
}