Skip to main content

Get Subscriber Summary

Returns metrics for a single subscriber within a specific plan: total payments, accumulated revenue, next renewal date.

Scoped to one plan — if the same subscriber is attached to multiple plans, each plan has its own summary. For a cross-plan view of all plans a subscriber belongs to, use Get Subscriber instead.

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

Response

idstring

Subscriber identifier.

emailstring

Subscriber's email.

statusstring

Subscriber's status on this plan: active, inactive, or pending.

subscribedDatestring

Date the subscriber was attached to the plan.

nextBillingDatestring

Next renewal invoice date.

paymentsCountsnumber

Number of completed renewal payments for this subscriber on this plan.

revenueAmountstring

Total revenue from this subscriber.

revenueAssetstring

Currency of revenueAmount.

planIdstring

Plan identifier.

planNamestring

Plan name.

intervalCountnumber

Renewal period interval counter.

intervalUnitstring

Renewal period interval unit.