Skip to main content

Get Customer Subscriptions Statistics

GET /v2/subscription/customers/:tenantId/statistics

Retrieves aggregated subscription metrics grouped by status, providing counts and total pricing for each category. This endpoint calculates summary statistics across active, expired, in-cancellation, and cancelled subscriptions, making it useful for financial reporting, dashboard KPIs, and monitoring subscription health. Apply the same filters as the subscription list endpoint to scope statistics to specific tenants, date ranges, or other criteria.

Query Parameters​

  • ~filter[_id] - Parameter for ~filter[_id]
  • ~filter[tenant] - Parameter for ~filter[tenant]
  • ~filter[start_date] - Parameter for ~filter[start_date]
  • ~filter[end_date] - Parameter for ~filter[end_date]
  • ~filter[price] - Parameter for ~filter[price]
  • ~filter[items.sku] - Parameter for ~filter[items.sku]
  • ~filter[agreementPrice] - Parameter for ~filter[agreementPrice]
  • ~search - Parameter for ~search

Request Example​

GET /v2/subscription/customers/:tenantId/statistics

Headers​

  • Accept - Expected response format (Example: application/json, text/csv)

Response Example​

{
  "active": {
    "count": 12,
    "price": 5400
  },
  "expired": {
    "count": 3,
    "price": 1200
  },
  "in_cancellation": {
    "count": 1,
    "price": 450
  },
  "cancelled": {
    "count": 4,
    "price": 1800
  },
  "total": {
    "count": 20,
    "price": 8850
  }
}