Get Subscription Plan
Returns details and metrics for a single subscription plan: definition (price, currency, interval), aggregated revenue (totalRevenue, monthlyRevenue), and counts of related invoices and subscribers.
This endpoint returns the plan detail only — to fetch the list of subscribers on the plan, use List Subscribers; for invoices generated by the plan, use List Plan Invoices.
/api/subscriptions/%plan_id%/main-infoAuth: RequiredResponse
idstringPlan identifier.
namestringPlan name.
invoiceAmountstringTotal amount per renewal in invoiceCurrency.
invoiceCurrencystringItems price currency.
intervalCountnumberRenewal period interval counter.
intervalUnitstringRenewal period interval unit (day, week, month, year).
createdAtstringPlan creation date and time.
totalRevenuestringAccumulated plan revenue.
monthlyRevenuestringMonthly recurring revenue. The current version supports 1-month plans only, so this is simply the invoice amount × active subscribers. Normalization for other periods (day/week/year) is planned for future versions.
revenueCurrencystringCurrency of totalRevenue and monthlyRevenue.
subscriptionsobjectCounts of invoices generated for this plan — despite the key name, this object counts invoices, not subscriptions.
subscribersobjectCounts of subscriber records on this plan.