Get a license

Get a license.

get

Path parameters

idstringRequired

The id of the license.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

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

404

The license was not found in the system.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "packageId": "sApKpllz4sAplsmzha",
    "subscriptionTypeId": "sApKpllz4sAplsmzha",
    "code": "JFWCODELICENSE",
    "type": "Normal",
    "amount": 1,
    "currencyCode": "USD",
    "description": "This is a trial license",
    "startDate": "2025-07-15T14:34:48.4154472+07:00",
    "endDate": "2025-08-14T14:34:48.4154476+07:00",
    "tags": "#tag1, #tag2",
    "status": "Active",
    "usedByUserId": "aPlasizhyPls",
    "usedDate": "2025-08-15T14:34:48.4154483+07:00",
    "testMode": false,
    "modifiedDate": "2025-07-15T14:34:48.4154491+07:00"
  },
  "errors": []
}