Statistics licenses monthly

Retrieves monthly license usage statistics for reporting and analysis by the user authorized.

get

This endpoint returns a breakdown of license data grouped by date, including totals for licenses created, active, expired, used, unused, and financial details such as total amount, refund, and postpaid billing.

        Filters can be applied to narrow the result set by package, subscription type,
        license type (e.g., Prepaid/Postpaid), and license status (e.g., Active, Inactive).

Query parameters

packageIdstringOptional

The id of the package.

subscriptionIdstringOptional

The id of the subscription type.

typestring · enumOptional

This enum is used to check which type of delivery is used for the license.

Possible values:

statusstring · enumOptional

This enum is used to map the status of License.

Possible values:

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/licenses/statistics/monthly

HTTPcURLJavaScriptPython

GET /api/v1/licenses/statistics/monthly HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "totalRemaining": 150,
    "totalLimit": 500,
    "totalLicenses": 350,
    "days": [
      {
        "date": "2025-09-19",
        "items": [
          {
            "packageId": "sApKpllz4sAplsmzha",
            "subscriptionTypeId": "sApKpllz4sAplsmzha",
            "totalLicenses": 50,
            "totalAmount": 1500,
            "currency": "USD",
            "usedLicenses": 30,
            "unusedLicenses": 20,
            "totalNormalAmount": 1800,
            "totalRefundAmount": 100,
            "totalPostpaidAmount": 200,
            "totalMailDeliveryAmount": 20,
            "notStartedLicenses": 5,
            "inactiveLicenses": 3,
            "activeLicenses": 40,
            "expiredLicenses": 2
          }
        ]
      }
    ]
  },
  "errors": []
}