Skip to main content
GET
Subscription Metrics
The numbers behind a subscriptions dashboard, for the business and environment the API key belongs to.

Request authentication

This endpoint requires a Secret Key (sk_...).

How MRR is calculated

Every running subscription is normalised to a monthly figure in USD from its own terms, not from its plan — so a subscriber still on last year’s price contributes last year’s price.
  • A quarterly plan counts a third of its price each month; an annual one a twelfth.
  • Amounts in other currencies are converted at the current rate.
  • Subscriptions set to cancel at period end are excluded — they are not recurring any more.
  • trialing and past_due subscriptions are included: they are still expected to pay.
churn_percent is subscriptions canceled or expired in the last 30 days over that number plus the ones still running. It is null when there is no base to measure against, rather than 0 — a new account has not achieved zero churn, it has no churn to report yet.

Authorizations

x-api-key
string
header
required

Response

Portfolio metrics.

Subscription metrics.

message
string
data
object

Portfolio metrics for this business and environment.