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

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
put
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": "2025-08-19T10:03:56.087615+07:00",
    "endDate": "2025-09-18T10:03:56.087615+07:00",
    "tags": "#tag1, #tag2",
    "status": "Active",
    "usedByUserId": "aPlasizhyPls",
    "usedDate": "2025-09-19T10:03:56.087615+07:00",
    "testMode": false,
    "modifiedDate": "2025-08-19T10:03:56.087616+07:00"
  },
  "errors": []
}

Last updated

Was this helpful?