Skip to main content

Get Subscriptions Summary

Returns aggregate metrics across all subscription plans under the merchant's company account.

Use this for dashboard-level overviews ("how much am I making across all plans?"). For per-plan details, use Get Subscription Plan instead.

GET/api/subscriptions/summaryAuth: Required

Response

totalRevenuestring

Sum of all subscription revenues.

revenueCurrencystring

Currency of totalRevenue.

activeSubscriptionsnumber

Total plans with active status.

activeSubscribersnumber

Total active clients across all plans.