Deactivate Bundle (Online Method)

10min
Dectivate a license for a product
POST
Request
Header Parameters
Date
String
required
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
String
required
See "License API Authorization" article
Body Parameters
hardware_id
String
required
Unique hardware ID generated for the client device
product
String
required
Product short code
license_key
String
optional
Required if product is key-based (see section below)
username
String
optional
Required if product is user based (see section below)
id_token
String
optional
Required if using SSO (see section below). This is the id_token received from the SSO if Implicit grant authorization method is being used.
code
String
optional
Required if using SSO (see section below). This is the code received from the SSO if Authorization code grant method is being used.
customer_account_code
String
optional
Required if using SSO (see section below). This is the customer_account_code to which SSO provider is configured. 
license_id
Number
optional
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
sdk_ver
String
optional
Version of the SDK used
Curl
Node.js
JS
Python
Ruby
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"password\":\"string\",\"id_token\":\"string\",\"code\":\"string\",\"customer_account_code\":\"string\",\"is_vm\":\"Boolean\",\"vm_info\":\"string\",\"os_ver\":\"string\",\"hostname\":\"string\",\"os_hostname\":\"string\",\"ip\":\"string\",\"ip_local\":\"string\",\"app_ver\":\"string\",\"sdk_ver\":\"string\",\"mac_address\":\"string\"}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("/api/v4/deactivate_license", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"password\":\"string\",\"id_token\":\"string\",\"code\":\"string\",\"customer_account_code\":\"string\",\"is_vm\":\"Boolean\",\"vm_info\":\"string\",\"os_ver\":\"string\",\"hostname\":\"string\",\"os_hostname\":\"string\",\"ip\":\"string\",\"ip_local\":\"string\",\"app_ver\":\"string\",\"sdk_ver\":\"string\",\"mac_address\":\"string\"}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("/api/v4/deactivate_license", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));
Responses
200
400
{
    "unknown_product": "Provided product was not found",
    "license_not_found": "License with the provided license user not found",
    "license_not_enabled": "The license is not enabled",
    "vm_not_allowed": "Virtual machine not allowed",
    "offline_floating_cloud_not_supported": " Floating cloud licenses cannot be activated offline.",
    "license_start_date_error": "This license cannot be activated before start date: {date}",
    "blacklisted": "This device is blacklisted",
    "license_activated_max_times": "This license  has already been activated the maximum number of times",
    "license_user_activated_max_times": "License user has activated this license max times",
    "license_expired": "License validity period has expired.",
    "license_transferred_max_times": "This license has already been transferred the maximum number of times",
    "license_device_exists": "A device matching this hardware_id is already created on the license"
}
{
    "unknown_product": "Provided product was not found",
    "license_not_found": "License with the provided license user not found",
    "license_not_enabled": "The license is not enabled",
    "vm_not_allowed": "Virtual machine not allowed",
    "offline_floating_cloud_not_supported": " Floating cloud licenses cannot be activated offline.",
    "license_start_date_error": "This license cannot be activated before start date: {date}",
    "blacklisted": "This device is blacklisted",
    "license_activated_max_times": "This license  has already been activated the maximum number of times",
    "license_user_activated_max_times": "License user has activated this license max times",
    "license_expired": "License validity period has expired.",
    "license_transferred_max_times": "This license has already been transferred the maximum number of times",
    "license_device_exists": "A device matching this hardware_id is already created on the license"
}
﻿
Schema
Request Body
TypeScript
JSON Schema
type LicenseActivationRequestBody = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses:
  username: string
  password: string

} | {

  // for user-based licenses using single sign-on Implicit grant:
  id_token: string
  customer_account_code: string

} | {

  // for user-based licenses using single sign-on Authorization code grant:
  code: string
  customer_account_code: string

}) & {

  // required properties:
  hardware_id: string
  product: string

  // optional properties:
  license_id?: number | undefined
  sdk_ver?: string | undefined
}
type LicenseActivationRequestBody = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses:
  username: string
  password: string

} | {

  // for user-based licenses using single sign-on Implicit grant:
  id_token: string
  customer_account_code: string

} | {

  // for user-based licenses using single sign-on Authorization code grant:
  code: string
  customer_account_code: string

}) & {

  // required properties:
  hardware_id: string
  product: string

  // optional properties:
  license_id?: number | undefined
  sdk_ver?: string | undefined
}
﻿
Response Body
If the request succeeds, the endpoint responds with the HTTP code 200 and the string license_deactivated.
License Authorization Method
There are two types of product licenses based on how the client application authorizes itself to interact with a license:
Key-based product licenses
Each license assigned to the product requires the client to provide a license key in order to activate, check or deactivate the license (property license_key in the request body).
The license response object will contain the license_key property, and the property product_details.authorization_method will be the string license_key.
User-based product licenses
Each license assigned to the product has a corresponding "license user" instead of a license key. There are multiple ways a user-based product license can be accessed when making a request:
By providing the values for username and password for the license user
By providing the values for id_token and customer_account_code if using single sign-on authentication using Implicit grant
By providing the values for code and customer_account_code if using single sign-on authentication using Authorization code grant
﻿
In the license response object, product_details.authorization_method will have the string value user and the response object will contain the user object with information on the license user. 
Errors
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
﻿
List of Exceptions
unknown_product (400): Provided product was not found
product_not_bundle (400): Specified product "code" is not a bundle
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
device_not_found (400): An active device matching the hardware_id not found
missing_headers (400): Some headers are missing
﻿
﻿
Updated 13 Mar 2025
Did this page help you?
Deactivate License (Offline Method)
Deactivate Bundle (Offline Method)
Deactivate Bundle (Online Method)

Schema

Request Body

Response Body

License Authorization Method

Key-based product licenses

User-based product licenses

Errors

List of Exceptions

﻿
