Create the licenses

Create a new license.

post

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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

Example: YOUR_BRAND_URL

AuthkeystringRequired

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

Body

application/jsontext/jsonapplication/*+json

Contains the data for the license key create form.

packageIdstring | nullableOptional

The package Id of the license.

subscriptionTypeIdstring | nullableOptional

The SubscriptionType Id of the license.

typestring · enumOptionalPossible values:

keystring | nullableOptional

The license key custom. If the license key has value, we create with the license otherwise auto generate license code.

startDatestring · date-timeOptional

The start date of the license.

endDatestring · date-timeOptional

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.

quantityinteger · int32Optional

The quantity of the license to create. By default, it is 1.

isOneQuantitybooleanRead-onlyOptional

Is the license key for one quantity.

userCodestring | nullableOptional

The user code of the license. If the userCode is empty, we get the current user logged in.

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 AuthKey header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/licenses HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "packageId": "text",
  "subscriptionTypeId": "text",
  "type": "1 - Normal",
  "key": "text",
  "startDate": "2025-05-09T12:21:46.349Z",
  "endDate": "2025-05-09T12:21:46.349Z",
  "description": "text",
  "tags": "text",
  "testMode": true,
  "quantity": 1,
  "userCode": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": 1,
  "errors": []
}