Updates a license

Updates a license.

put

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

Body

application/jsontext/jsonapplication/*+json

Contains the data for the license key update form.

packageIdstring · min: 1Required

The id of the package.

subscriptionTypeIdstring · min: 1Required

The id of the subscription type.

amountnumber · double · max: 2147483647Required

The amount value of a license to be created.

currencyCodestring · min: 1Required

The currency code in the ISO 4217 format, which is a three-letter uppercase code that identifies a specific currency. This value should strictly follow the ISO 4217 standard.

startDatestring · date-timeRequired

The start date of the license.

endDatestring · date-timeRequired

The end date of the license.

descriptionstring · nullableOptional

The description of the license.

tagsstring · nullableOptional

The tags of the license.

testModeboolean · nullableOptional

The test mode of the license. By default, it is set to false.

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

403

The user's access was denied.

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}

HTTPcURLJavaScriptPython

PUT /api/v1/licenses/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "packageId": "text",
  "subscriptionTypeId": "text",
  "amount": 1,
  "currencyCode": "text",
  "startDate": "2026-04-02T14:43:53.681Z",
  "endDate": "2026-04-02T14:43:53.681Z",
  "description": "text",
  "tags": "text",
  "testMode": true
}

application/jsontext/jsonapplication/*+json

{
  "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.813794+07:00",
    "endDate": "2026-02-25T08:03:23.813795+07:00",
    "tags": "#tag1, #tag2",
    "status": "Active",
    "usedByUserId": "aPlasizhyPls",
    "usedDate": "2026-02-26T08:03:23.813795+07:00",
    "testMode": false,
    "modifiedDate": "2026-01-26T08:03:23.813795+07:00"
  },
  "errors": []
}