Skip to main content Link Search Menu Expand Document (external link)

Reports

Reporting data is collected to allow you to analyze your Ongoing subscriptions.

Available Data

Requests

GET /api/reports

Output

  • The currency that the financials are reported in

    reports.currencyCode - Primary shop currency

  • Total completed value

    reports.completedTotal

  • Scheduled subscription value

    reports.scheduledTotal

  • Historical daily reports of all subscription totals (filterable by status i.e. ‘active’, ‘paused’, ‘expired’ etc..)

    reports.daily - 30 day total

{
  "reports": {
    "daily": [
      "2022-07-15": {
        "subscriptions": {
          "active": 760,
          "cancelled": 110,
          "expired": 160,
          "failed": 120,
          "paused": 150,
          "total": 1300
        }
      },
      "2022-07-14": {
        "subscriptions": {
          "active": 600,
          "cancelled": 100,
          "expired": 150,
          "failed": 150,
          "paused": 200,
          "total": 1200
        }
      },
      "...."
    ],
    "currencyCode": "USD",
    "completedTotal": "1258592.55",
    "scheduledTotal": "352001.21",
  },
  "message": "Reports history fetched successfully.",
  "errors": false
}