Skip to main content

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.

GET/api/subscriptions/%plan_id%/main-infoAuth: Required

Response

idstring

Plan identifier.

namestring

Plan name.

invoiceAmountstring

Total amount per renewal in invoiceCurrency.

invoiceCurrencystring

Items price currency.

intervalCountnumber

Renewal period interval counter.

intervalUnitstring

Renewal period interval unit (day, week, month, year).

createdAtstring

Plan creation date and time.

totalRevenuestring

Accumulated plan revenue.

monthlyRevenuestring

Monthly 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.

revenueCurrencystring

Currency of totalRevenue and monthlyRevenue.

subscriptionsobject

Counts of invoices generated for this plan — despite the key name, this object counts invoices, not subscriptions.

subscribersobject

Counts of subscriber records on this plan.