Skip to main content
GET
/
api
/
v1
/
subscription_details
/
summary
Get aggregated summary of subscriptions by status
curl --request GET \
  --url https://api.raul.ugps.io/api/v1/subscription_details/summary \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "byStatus": [
    {
      "status_id": 123,
      "subscription_status_name": "<string>",
      "count": 123
    }
  ],
  "byPlan": [
    {
      "plan_id": 123,
      "plan_name": "<string>",
      "count": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

client_id
string

Filter by client ID

date_from
string

Filter from date (ISO 8601)

date_to
string

Filter to date (ISO 8601)

Response

200 - application/json

Subscription summary

total
number
required
byStatus
object[]
required
byPlan
object[]
required