Get subscription summary

GET

/api/v1/portfolios/{portfolio_id}/subscriptions/summary

Get statistics about subscriptions including totals and breakdowns

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Subscription summary

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/portfolios//subscriptions/summary' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "success": true,
    "data": {
        "total_count": 0,
        "active_count": 0,
        "paused_count": 0,
        "cancelled_count": 0,
        "monthly_total": 0,
        "yearly_total": 0,
        "due_soon": 0,
        "overdue": 0,
        "by_billing_cycle": {
            "property1": 0,
            "property2": 0
        },
        "by_category": {
            "property1": 0,
            "property2": 0
        }
    }
}

Modified at 2025-12-03 16:47:21

Create subscription

Get subscription details