Activate a license

Activate a license.

put

This method sets the license's status to Active based on its current state: NotStarted: Sets the StartDate to a valid date in the past.Expired: Sets the EndDate to a valid date in the future.Inactive: Sets both StartDate and EndDate if necessary. If the license has already been Used, the method does nothing.

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

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

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

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

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/licenses/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/v1/licenses/{id}/activate 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": "2026-01-26T08:03:23.815405+07:00",
    "endDate": "2026-02-25T08:03:23.815406+07:00",
    "tags": "#tag1, #tag2",
    "status": "Active",
    "usedByUserId": "aPlasizhyPls",
    "usedDate": "2026-02-26T08:03:23.815406+07:00",
    "testMode": false,
    "modifiedDate": "2026-01-26T08:03:23.815406+07:00"
  },
  "errors": []
}