Check Bundle

13min
Checks the status and validity of a license bundle
GET
Request
Query Parameters
hardware_id
String
required
Unique hardware ID generated for the client device
product
String
required
Short code for the bundle product
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)
license_id
Number
optional
Ensures that the action affects only the bundle 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"
include_expired_features
Boolean
optional
Whether expired product features should be included in the response
env
String
optional
Checks the licenses status against the specified product installation file environment (matching the installation file's "environment" property)
os_ver
String
optional
Updates license device data, sets Operating System string to this value
hostname
String
optional
Updates license device data, sets hostname string to this value
os_hostname
String
optional
Legacy version of "hostname" parameter (see above)
ip
String
optional
Updates license device data, sets IP address string to this value
ip_local
String
optional
Legacy version of "ip" parameter (see above)
app_ver
String
optional
Updates license device data, sets application version string to this value
sdk_ver
String
optional
Updates license device data, sets SDK version string to this value
mac_address
String
optional
Updates license device data, sets MAC address string to this value
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
Curl
Node.js
JS
Python
Ruby
require "uri"
require "net/http"

url = URI("/api/v4/check_bundle?hardware_id=string&product=string&license_key=string&username=string")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body

require "uri"
require "net/http"

url = URI("/api/v4/check_bundle?hardware_id=string&product=string&license_key=string&username=string")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body
Responses
200
[
    {
        "id": 1742895176814029,
        "order_store_id": "0bce1a4470aa495ca53acc5b48377eb3",
        "license_active": true,
        "license_enabled": true,
        "license_type": "perpetual",
        "license_key": "UCD8-XVHJ-TSRH-W4BO",
        "is_trial": false,
        "max_license_users": 1,
        "validity_period": null,
        "enable_maintenance_period": false,
        "maintenance_period": null,
        "allow_grace_period": false,
        "grace_period": 0,
        "max_activations": 1,
        "allow_unlimited_activations": false,
        "times_activated": 1,
        "start_date": null,
        "transfer_count": 0,
        "max_transfers": 0,
        "allow_overages": false,
        "max_overages": 0,
        "is_floating_cloud": false,
        "is_floating": false,
        "floating_timeout": 120,
        "can_borrow": false,
        "max_borrow_time": 0,
        "prevent_vm": false,
        "custom_fields": [],
        "product_features": [],
        "customer": {
            "email": "",
            "company_name": "",
            "reference": "",
            "phone": "",
            "first_name": "",
            "last_name": "",
            "city": "",
            "postcode": "",
            "state": "",
            "country": "",
            "address": "",
            "customer_account": null,
            "metadata": {}
        },
        "product_details": {
            "product_id": 1586066454419168,
            "product_name": "Bundle One",
            "short_code": "bun1",
            "authorization_method": "license-key",
            "metadata": {}
        },
        "metadata": {},
        "is_hardware_key_auth": false,
        "is_air_gapped": false,
        "device_id": 1742895188873059,
        "is_borrowed": false,
        "borrowed_until": null,
        "is_expired": false,
        "version": "",
        "installation_file": "",
        "release_date": "",
        "hash_md5": "",
        "requires_version": "",
        "environment": "",
        "eula_link": "",
        "release_notes_link": "",
        "size": "",
        "channel": "",
        "license_signature": "KQfPkJ89kpbIs/T0xcSufU6fVzIoZMgNMuJgXG4eFsl1721aBw7ePl3kSqCQU3+8B200opR6yjdSBuqZw5OAebi/DsspG9UpMHOM38l6C/6BBHc5I1+CL5SvlLvH8/c8/fWNn4XjDd8S0VquK1+qxoukQ2N5QiwYRwHiA0y1X4n1FIYHBO+1MO+WZsdWj4SVkbiBuMWMTrVuNwmHgnSziOU/j4H3Uk5JFZqilJflAdz+jtmvciZkay8CQEKQKHnw0x8M6mWemU1dJaj0pgTeF/CXyQvTZT+9iccYPrrSEgbeeuqVexaT6qJajOjp0XNH/8Eg/eUnYZU8A2mQcZB8i2SAgVlBD9dSTCTrZP7OoJWpWJ91UtNjJ/2VWehaDXGikVF0BfQjkm+d1ZzCt3TWbWffOawxv+M+hjDWIzEkRE0qFARBCX66XT5ftZHBcuNP65vedrpkx+8ZO3jNLonEv2qChBwQcOtrnEC38kPQBkcbBxoCClbbtPp145v30mfYLXB0CudxO00j8uWWnMseg1XwMihrqWN9oDLB2obRdkiDZ/9mKSykVeUOxPTaB7T44AlgnEFki45DO6BH1ZH+cxN0shcrzXZwrpHjczNVSgIVHV4jNdyY47gH+SS/Cn6j9+jQ9IU4kZtEbFmhkTQRXS996YNsc9mFhOh2AIde/WE="
    },
    {
        "id": 1742895176822039,
        "order_store_id": "0bce1a4470aa495ca53acc5b48377eb3",
        "license_active": true,
        "license_enabled": true,
        "license_type": "perpetual",
        "license_key": "UCD8-XVHJ-TSRH-W4BO",
        "is_trial": false,
        "max_license_users": 1,
        "validity_period": null,
        "enable_maintenance_period": true,
        "maintenance_period": "2026-03-25T00:00:00.000Z",
        "allow_grace_period": false,
        "grace_period": 0,
        "max_activations": 1,
        "allow_unlimited_activations": false,
        "times_activated": 1,
        "start_date": null,
        "transfer_count": 0,
        "max_transfers": 0,
        "allow_overages": false,
        "max_overages": 0,
        "is_floating_cloud": false,
        "is_floating": false,
        "floating_timeout": 120,
        "can_borrow": false,
        "max_borrow_time": 0,
        "prevent_vm": false,
        "custom_fields": [],
        "product_features": [],
        "customer": {
            "email": "",
            "company_name": "",
            "reference": "",
            "phone": "",
            "first_name": "",
            "last_name": "",
            "city": "",
            "postcode": "",
            "state": "",
            "country": "",
            "address": "",
            "customer_account": null,
            "metadata": {}
        },
        "product_details": {
            "product_id": 2,
            "product_name": "Test product",
            "short_code": "TP",
            "authorization_method": "license-key",
            "metadata": {
                "null": null,
                "array": [
                    1,
                    2,
                    3
                ],
                "color": "gold",
                "number": 123,
                "object": {
                    "a": " 串 句 龜 龜 契 金 喇",
                    "c": "d"
                },
                "string": "℀ Test 豈 更 車 賈 龜 契 金 喇",
                "boolean": true
            }
        },
        "metadata": {},
        "is_hardware_key_auth": false,
        "is_air_gapped": false,
        "device_id": 1742895189133069,
        "is_borrowed": false,
        "borrowed_until": null,
        "is_expired": false,
        "version": "1.0.2",
        "installation_file": "https://s3.amazonaws.com/licensespring/SDK/Mac/ExampleMacAppV1.0.1.zip",
        "release_date": "2021-05-09T00:00:00.000Z",
        "hash_md5": "2eb32e05fc742061af21a199627370db",
        "requires_version": "1.0.1",
        "environment": "mac",
        "eula_link": "https://docs.licensespring.com/docs/c",
        "release_notes_link": "https://docs.licensespring.com/docs/c",
        "size": "2734565",
        "channel": null,
        "license_signature": "KQfPkJ89kpbIs/T0xcSufU6fVzIoZMgNMuJgXG4eFsl1721aBw7ePl3kSqCQU3+8B200opR6yjdSBuqZw5OAebi/DsspG9UpMHOM38l6C/6BBHc5I1+CL5SvlLvH8/c8/fWNn4XjDd8S0VquK1+qxoukQ2N5QiwYRwHiA0y1X4n1FIYHBO+1MO+WZsdWj4SVkbiBuMWMTrVuNwmHgnSziOU/j4H3Uk5JFZqilJflAdz+jtmvciZkay8CQEKQKHnw0x8M6mWemU1dJaj0pgTeF/CXyQvTZT+9iccYPrrSEgbeeuqVexaT6qJajOjp0XNH/8Eg/eUnYZU8A2mQcZB8i2SAgVlBD9dSTCTrZP7OoJWpWJ91UtNjJ/2VWehaDXGikVF0BfQjkm+d1ZzCt3TWbWffOawxv+M+hjDWIzEkRE0qFARBCX66XT5ftZHBcuNP65vedrpkx+8ZO3jNLonEv2qChBwQcOtrnEC38kPQBkcbBxoCClbbtPp145v30mfYLXB0CudxO00j8uWWnMseg1XwMihrqWN9oDLB2obRdkiDZ/9mKSykVeUOxPTaB7T44AlgnEFki45DO6BH1ZH+cxN0shcrzXZwrpHjczNVSgIVHV4jNdyY47gH+SS/Cn6j9+jQ9IU4kZtEbFmhkTQRXS996YNsc9mFhOh2AIde/WE="
    },
    {
        "id": 1742895176871049,
        "order_store_id": "0bce1a4470aa495ca53acc5b48377eb3",
        "license_active": true,
        "license_enabled": true,
        "license_type": "time-limited",
        "license_key": "UCD8-XVHJ-TSRH-W4BO",
        "is_trial": false,
        "max_license_users": 1,
        "validity_period": "2045-03-25T00:00:00.000Z",
        "enable_maintenance_period": false,
        "maintenance_period": null,
        "allow_grace_period": false,
        "grace_period": 0,
        "max_activations": 1,
        "allow_unlimited_activations": false,
        "times_activated": 1,
        "start_date": null,
        "transfer_count": 0,
        "max_transfers": 0,
        "allow_overages": false,
        "max_overages": 0,
        "is_floating_cloud": false,
        "is_floating": false,
        "floating_timeout": 120,
        "can_borrow": false,
        "max_borrow_time": 0,
        "prevent_vm": false,
        "custom_fields": [],
        "product_features": [],
        "customer": {
            "email": "",
            "company_name": "",
            "reference": "",
            "phone": "",
            "first_name": "",
            "last_name": "",
            "city": "",
            "postcode": "",
            "state": "",
            "country": "",
            "address": "",
            "customer_account": null,
            "metadata": {}
        },
        "product_details": {
            "product_id": 1552912698614011,
            "product_name": "Basic product",
            "short_code": "basicproduct",
            "authorization_method": "license-key",
            "metadata": {}
        },
        "metadata": {},
        "is_hardware_key_auth": false,
        "is_air_gapped": false,
        "device_id": 1742895189356079,
        "is_borrowed": false,
        "borrowed_until": null,
        "is_expired": false,
        "version": "",
        "installation_file": "",
        "release_date": "",
        "hash_md5": "",
        "requires_version": "",
        "environment": "",
        "eula_link": "",
        "release_notes_link": "",
        "size": "",
        "channel": "",
        "license_signature": "G7TdP3OGP7x2IAJNoCy/nGomkQ4LhxcKVmQdPc48xgf8rO7gkg13K6aEApUyUyiRL9PGPvTEgLaaNzvmtaidpGHp/iHq2LIdqtOStc6TmGDLrNHOBwcnMbCR+YIrwXpGZA+AhjLsgjP9NJ+A1JleRv0edmHyqsuF1r6tsKYu8lUFMFHc46U2V7cCsqsZx8GeWe3LDVedLsQi6Q+A5KS3vQ8XIjz4i0zyoGYgY31CAZ6gQa6rsMeOwKOb13tHWB5n5zNk8nWbqYzt2Odb9Mi+dXgKGJNE9ez2kSSPaZnI2mC5VvVdSVPOsAxKDc3173tX6ZR2O36v3E8LBt/O9Y6IoBgs04DuuMRZko6+tqiVd6w53iB3WTMTVxWgfVgpsqjYkgcTPMTfkyNfGffpP5CwLOZ1LyBBIcqcyYWElRli9zHpdUsnkkTEJcNeERAqhg6KlNAj6tfLVOomnxPljcp08oiKeDqfSvGU0tKIXNvZInDc12dSnwyWQRN/MyNa9HY88x5Dq9QHMmG70aUM2BuvyPBPJt8t8UVj8AnwKovxPezWB9bCvGJv0l+erSDpPcQz1ll+BnBkT8+WSRPCcDC2DHAHHsCQmVO5tINdJ1u7QfndhDhtQZn5IGr4jyMuHoc2ez4E4cCJrU65XjLYbZuehFuSsPxHjP24DWZEyA7F6wk="
    }
]
[
    {
        "id": 1742895176814029,
        "order_store_id": "0bce1a4470aa495ca53acc5b48377eb3",
        "license_active": true,
        "license_enabled": true,
        "license_type": "perpetual",
        "license_key": "UCD8-XVHJ-TSRH-W4BO",
        "is_trial": false,
        "max_license_users": 1,
        "validity_period": null,
        "enable_maintenance_period": false,
        "maintenance_period": null,
        "allow_grace_period": false,
        "grace_period": 0,
        "max_activations": 1,
        "allow_unlimited_activations": false,
        "times_activated": 1,
        "start_date": null,
        "transfer_count": 0,
        "max_transfers": 0,
        "allow_overages": false,
        "max_overages": 0,
        "is_floating_cloud": false,
        "is_floating": false,
        "floating_timeout": 120,
        "can_borrow": false,
        "max_borrow_time": 0,
        "prevent_vm": false,
        "custom_fields": [],
        "product_features": [],
        "customer": {
            "email": "",
            "company_name": "",
            "reference": "",
            "phone": "",
            "first_name": "",
            "last_name": "",
            "city": "",
            "postcode": "",
            "state": "",
            "country": "",
            "address": "",
            "customer_account": null,
            "metadata": {}
        },
        "product_details": {
            "product_id": 1586066454419168,
            "product_name": "Bundle One",
            "short_code": "bun1",
            "authorization_method": "license-key",
            "metadata": {}
        },
        "metadata": {},
        "is_hardware_key_auth": false,
        "is_air_gapped": false,
        "device_id": 1742895188873059,
        "is_borrowed": false,
        "borrowed_until": null,
        "is_expired": false,
        "version": "",
        "installation_file": "",
        "release_date": "",
        "hash_md5": "",
        "requires_version": "",
        "environment": "",
        "eula_link": "",
        "release_notes_link": "",
        "size": "",
        "channel": "",
        "license_signature": "KQfPkJ89kpbIs/T0xcSufU6fVzIoZMgNMuJgXG4eFsl1721aBw7ePl3kSqCQU3+8B200opR6yjdSBuqZw5OAebi/DsspG9UpMHOM38l6C/6BBHc5I1+CL5SvlLvH8/c8/fWNn4XjDd8S0VquK1+qxoukQ2N5QiwYRwHiA0y1X4n1FIYHBO+1MO+WZsdWj4SVkbiBuMWMTrVuNwmHgnSziOU/j4H3Uk5JFZqilJflAdz+jtmvciZkay8CQEKQKHnw0x8M6mWemU1dJaj0pgTeF/CXyQvTZT+9iccYPrrSEgbeeuqVexaT6qJajOjp0XNH/8Eg/eUnYZU8A2mQcZB8i2SAgVlBD9dSTCTrZP7OoJWpWJ91UtNjJ/2VWehaDXGikVF0BfQjkm+d1ZzCt3TWbWffOawxv+M+hjDWIzEkRE0qFARBCX66XT5ftZHBcuNP65vedrpkx+8ZO3jNLonEv2qChBwQcOtrnEC38kPQBkcbBxoCClbbtPp145v30mfYLXB0CudxO00j8uWWnMseg1XwMihrqWN9oDLB2obRdkiDZ/9mKSykVeUOxPTaB7T44AlgnEFki45DO6BH1ZH+cxN0shcrzXZwrpHjczNVSgIVHV4jNdyY47gH+SS/Cn6j9+jQ9IU4kZtEbFmhkTQRXS996YNsc9mFhOh2AIde/WE="
    },
    {
        "id": 1742895176822039,
        "order_store_id": "0bce1a4470aa495ca53acc5b48377eb3",
        "license_active": true,
        "license_enabled": true,
        "license_type": "perpetual",
        "license_key": "UCD8-XVHJ-TSRH-W4BO",
        "is_trial": false,
        "max_license_users": 1,
        "validity_period": null,
        "enable_maintenance_period": true,
        "maintenance_period": "2026-03-25T00:00:00.000Z",
        "allow_grace_period": false,
        "grace_period": 0,
        "max_activations": 1,
        "allow_unlimited_activations": false,
        "times_activated": 1,
        "start_date": null,
        "transfer_count": 0,
        "max_transfers": 0,
        "allow_overages": false,
        "max_overages": 0,
        "is_floating_cloud": false,
        "is_floating": false,
        "floating_timeout": 120,
        "can_borrow": false,
        "max_borrow_time": 0,
        "prevent_vm": false,
        "custom_fields": [],
        "product_features": [],
        "customer": {
            "email": "",
            "company_name": "",
            "reference": "",
            "phone": "",
            "first_name": "",
            "last_name": "",
            "city": "",
            "postcode": "",
            "state": "",
            "country": "",
            "address": "",
            "customer_account": null,
            "metadata": {}
        },
        "product_details": {
            "product_id": 2,
            "product_name": "Test product",
            "short_code": "TP",
            "authorization_method": "license-key",
            "metadata": {
                "null": null,
                "array": [
                    1,
                    2,
                    3
                ],
                "color": "gold",
                "number": 123,
                "object": {
                    "a": " 串 句 龜 龜 契 金 喇",
                    "c": "d"
                },
                "string": "℀ Test 豈 更 車 賈 龜 契 金 喇",
                "boolean": true
            }
        },
        "metadata": {},
        "is_hardware_key_auth": false,
        "is_air_gapped": false,
        "device_id": 1742895189133069,
        "is_borrowed": false,
        "borrowed_until": null,
        "is_expired": false,
        "version": "1.0.2",
        "installation_file": "https://s3.amazonaws.com/licensespring/SDK/Mac/ExampleMacAppV1.0.1.zip",
        "release_date": "2021-05-09T00:00:00.000Z",
        "hash_md5": "2eb32e05fc742061af21a199627370db",
        "requires_version": "1.0.1",
        "environment": "mac",
        "eula_link": "https://docs.licensespring.com/docs/c",
        "release_notes_link": "https://docs.licensespring.com/docs/c",
        "size": "2734565",
        "channel": null,
        "license_signature": "KQfPkJ89kpbIs/T0xcSufU6fVzIoZMgNMuJgXG4eFsl1721aBw7ePl3kSqCQU3+8B200opR6yjdSBuqZw5OAebi/DsspG9UpMHOM38l6C/6BBHc5I1+CL5SvlLvH8/c8/fWNn4XjDd8S0VquK1+qxoukQ2N5QiwYRwHiA0y1X4n1FIYHBO+1MO+WZsdWj4SVkbiBuMWMTrVuNwmHgnSziOU/j4H3Uk5JFZqilJflAdz+jtmvciZkay8CQEKQKHnw0x8M6mWemU1dJaj0pgTeF/CXyQvTZT+9iccYPrrSEgbeeuqVexaT6qJajOjp0XNH/8Eg/eUnYZU8A2mQcZB8i2SAgVlBD9dSTCTrZP7OoJWpWJ91UtNjJ/2VWehaDXGikVF0BfQjkm+d1ZzCt3TWbWffOawxv+M+hjDWIzEkRE0qFARBCX66XT5ftZHBcuNP65vedrpkx+8ZO3jNLonEv2qChBwQcOtrnEC38kPQBkcbBxoCClbbtPp145v30mfYLXB0CudxO00j8uWWnMseg1XwMihrqWN9oDLB2obRdkiDZ/9mKSykVeUOxPTaB7T44AlgnEFki45DO6BH1ZH+cxN0shcrzXZwrpHjczNVSgIVHV4jNdyY47gH+SS/Cn6j9+jQ9IU4kZtEbFmhkTQRXS996YNsc9mFhOh2AIde/WE="
    },
    {
        "id": 1742895176871049,
        "order_store_id": "0bce1a4470aa495ca53acc5b48377eb3",
        "license_active": true,
        "license_enabled": true,
        "license_type": "time-limited",
        "license_key": "UCD8-XVHJ-TSRH-W4BO",
        "is_trial": false,
        "max_license_users": 1,
        "validity_period": "2045-03-25T00:00:00.000Z",
        "enable_maintenance_period": false,
        "maintenance_period": null,
        "allow_grace_period": false,
        "grace_period": 0,
        "max_activations": 1,
        "allow_unlimited_activations": false,
        "times_activated": 1,
        "start_date": null,
        "transfer_count": 0,
        "max_transfers": 0,
        "allow_overages": false,
        "max_overages": 0,
        "is_floating_cloud": false,
        "is_floating": false,
        "floating_timeout": 120,
        "can_borrow": false,
        "max_borrow_time": 0,
        "prevent_vm": false,
        "custom_fields": [],
        "product_features": [],
        "customer": {
            "email": "",
            "company_name": "",
            "reference": "",
            "phone": "",
            "first_name": "",
            "last_name": "",
            "city": "",
            "postcode": "",
            "state": "",
            "country": "",
            "address": "",
            "customer_account": null,
            "metadata": {}
        },
        "product_details": {
            "product_id": 1552912698614011,
            "product_name": "Basic product",
            "short_code": "basicproduct",
            "authorization_method": "license-key",
            "metadata": {}
        },
        "metadata": {},
        "is_hardware_key_auth": false,
        "is_air_gapped": false,
        "device_id": 1742895189356079,
        "is_borrowed": false,
        "borrowed_until": null,
        "is_expired": false,
        "version": "",
        "installation_file": "",
        "release_date": "",
        "hash_md5": "",
        "requires_version": "",
        "environment": "",
        "eula_link": "",
        "release_notes_link": "",
        "size": "",
        "channel": "",
        "license_signature": "G7TdP3OGP7x2IAJNoCy/nGomkQ4LhxcKVmQdPc48xgf8rO7gkg13K6aEApUyUyiRL9PGPvTEgLaaNzvmtaidpGHp/iHq2LIdqtOStc6TmGDLrNHOBwcnMbCR+YIrwXpGZA+AhjLsgjP9NJ+A1JleRv0edmHyqsuF1r6tsKYu8lUFMFHc46U2V7cCsqsZx8GeWe3LDVedLsQi6Q+A5KS3vQ8XIjz4i0zyoGYgY31CAZ6gQa6rsMeOwKOb13tHWB5n5zNk8nWbqYzt2Odb9Mi+dXgKGJNE9ez2kSSPaZnI2mC5VvVdSVPOsAxKDc3173tX6ZR2O36v3E8LBt/O9Y6IoBgs04DuuMRZko6+tqiVd6w53iB3WTMTVxWgfVgpsqjYkgcTPMTfkyNfGffpP5CwLOZ1LyBBIcqcyYWElRli9zHpdUsnkkTEJcNeERAqhg6KlNAj6tfLVOomnxPljcp08oiKeDqfSvGU0tKIXNvZInDc12dSnwyWQRN/MyNa9HY88x5Dq9QHMmG70aUM2BuvyPBPJt8t8UVj8AnwKovxPezWB9bCvGJv0l+erSDpPcQz1ll+BnBkT8+WSRPCcDC2DHAHHsCQmVO5tINdJ1u7QfndhDhtQZn5IGr4jyMuHoc2ez4E4cCJrU65XjLYbZuehFuSsPxHjP24DWZEyA7F6wk="
    }
]
﻿
Schema
Request Query Parameters
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "allOf": [
      {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "license_key": { "type": "string" }
            },
            "required": ["license_key"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "username": { "type": "string" }
            },
            "required": ["username"],
            "additionalProperties": false
          }
        ]
      },
      {
        "type": "object",
        "properties": {
          "hardware_id": { "type": "string" },
          "product": { "type": "string" },
          "license_id": { "type": "number" },
          "is_vm": { "type": "boolean" },
          "vm_info": { "type": "string" },
          "os_ver": { "type": "string" },
          "hostname": { "type": "string" },
          "os_hostname": { "type": "string" },
          "ip": { "type": "string" },
          "ip_local": { "type": "string" },
          "app_ver": { "type": "string" },
          "sdk_ver": { "type": "string" },
          "mac_address": { "type": "string" },
          "include_expired_features": { "type": "boolean" }
        },
        "required": ["hardware_id", "product"],
        "additionalProperties": false
      }
    ]
  }
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "allOf": [
      {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "license_key": { "type": "string" }
            },
            "required": ["license_key"],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "username": { "type": "string" }
            },
            "required": ["username"],
            "additionalProperties": false
          }
        ]
      },
      {
        "type": "object",
        "properties": {
          "hardware_id": { "type": "string" },
          "product": { "type": "string" },
          "license_id": { "type": "number" },
          "is_vm": { "type": "boolean" },
          "vm_info": { "type": "string" },
          "os_ver": { "type": "string" },
          "hostname": { "type": "string" },
          "os_hostname": { "type": "string" },
          "ip": { "type": "string" },
          "ip_local": { "type": "string" },
          "app_ver": { "type": "string" },
          "sdk_ver": { "type": "string" },
          "mac_address": { "type": "string" },
          "include_expired_features": { "type": "boolean" }
        },
        "required": ["hardware_id", "product"],
        "additionalProperties": false
      }
    ]
  }
}
﻿
Response Body
TypeScript
JSON Schema
type BundleCheckResponseBody = BundleCheckResponse[];

type BundleCheckResponse = {
  id: number,
  allow_grace_period: boolean,
  allow_overages: boolean,
  allow_unlimited_activations: boolean,
  borrowed_until: string | null,
  can_borrow: boolean,
  channel: string,
  device_id: number,
  enable_maintenance_period: boolean
  environment: string,
  eula_link: string,
  floating_timeout: number,
  grace_period: number,
  hash_md5: string,
  installation_file: string,
  is_air_gapped: boolean,
  is_borrowed: boolean,
  is_expired: boolean,
  is_floating_cloud: boolean,
  is_floating: boolean,
  is_hardware_key_auth: boolean,
  license_active: boolean,
  license_enabled: boolean,
  license_signature: string,
  license_signature_v2: string,
  offline_signature: string,
  license_type: string,
  maintenance_period: string | null,
  max_activations: number,
  max_borrow_time: number,
  max_license_users: number,
  max_overages: number,
  max_transfers: number,
  order_store_id: string,
  prevent_vm: boolean,
  release_date: string,
  release_notes_link: string,
  requires_version: string,
  size: string,
  start_date: string | null,
  times_activated: number,
  transfer_count: number,
  validity_period: string | null, // string is in DateISO8601UTC format
  version: string,
  
  product_features: ({
    id: number,
    code: string,
    name: string,
    expiry_date: string,
    metadata: JSON,
    feature_type: 'activation' | 'consumption',
    is_floating: boolean,
    is_floating_cloud: boolean,

    // the following properties are only present if is_floating=true or is_floating_cloud=true
    floating_users: number,
    floating_timeout: number,

    // the following properties are only present if feature_type=consumption
    max_consumption: number,
    allow_unlimited_consumptions: boolean,
    total_consumptions: number,
    allow_overages: number,
    max_overages: number,
    reset_consumption: boolean,
    consumption_period: 'daily' | 'weekly' | 'monthly' | 'annualy' | null,
  })[],
  
  custom_fields: ({
    name: string,
    data_type: 'numer' | 'text' | 'date/time',
    value: string,
  })[],
  
  customer: {
    email: string,
    company_name: string,
    reference: string,
    phone: string,
    first_name: string,
    last_name: string,
    city: string,
    postcode: string,
    state: string,
    country: string,
    address: string,
    customer_account: string | null,
    metadata: JSON,
  },
  
  product_details: {
    product_id: number,
    product_name: string,
    short_code: string,
    authorization_method: 'license-key' | 'user',
    metadata: JSON,
  },
  
  metadata: JSON,
  
  // the following property is only present if is_trial=true
  trial_days: number,
  
  // the following properties is only present if is_floating=true or is_floating_cloud=true
  floating_in_use_devices: number,
  floating_users: number,
  
  // the following properties are only present if license_type='consumption'
  max_consumptions: number,
  total_consumptions: number,
  allow_unlimited_consumptions: boolean,
  reset_consumption: boolean,
  consumption_period: string | null, // string is in DateISO8601UTC format
  
} & ({

  // for key-based licenses:
  license_key: string,

} | {

  // for user-based licenses:
  user: {
    id: number,
    email: string,
    first_name: string,
    last_name: string,
    phone_number: string,
    is_initial_password: boolean,
    max_activations: number,
    allow_unlimited_activations: boolean,
    total_activations: number
  }
});

type BundleCheckResponseBody = BundleCheckResponse[];

type BundleCheckResponse = {
  id: number,
  allow_grace_period: boolean,
  allow_overages: boolean,
  allow_unlimited_activations: boolean,
  borrowed_until: string | null,
  can_borrow: boolean,
  channel: string,
  device_id: number,
  enable_maintenance_period: boolean
  environment: string,
  eula_link: string,
  floating_timeout: number,
  grace_period: number,
  hash_md5: string,
  installation_file: string,
  is_air_gapped: boolean,
  is_borrowed: boolean,
  is_expired: boolean,
  is_floating_cloud: boolean,
  is_floating: boolean,
  is_hardware_key_auth: boolean,
  license_active: boolean,
  license_enabled: boolean,
  license_signature: string,
  license_signature_v2: string,
  offline_signature: string,
  license_type: string,
  maintenance_period: string | null,
  max_activations: number,
  max_borrow_time: number,
  max_license_users: number,
  max_overages: number,
  max_transfers: number,
  order_store_id: string,
  prevent_vm: boolean,
  release_date: string,
  release_notes_link: string,
  requires_version: string,
  size: string,
  start_date: string | null,
  times_activated: number,
  transfer_count: number,
  validity_period: string | null, // string is in DateISO8601UTC format
  version: string,
  
  product_features: ({
    id: number,
    code: string,
    name: string,
    expiry_date: string,
    metadata: JSON,
    feature_type: 'activation' | 'consumption',
    is_floating: boolean,
    is_floating_cloud: boolean,

    // the following properties are only present if is_floating=true or is_floating_cloud=true
    floating_users: number,
    floating_timeout: number,

    // the following properties are only present if feature_type=consumption
    max_consumption: number,
    allow_unlimited_consumptions: boolean,
    total_consumptions: number,
    allow_overages: number,
    max_overages: number,
    reset_consumption: boolean,
    consumption_period: 'daily' | 'weekly' | 'monthly' | 'annualy' | null,
  })[],
  
  custom_fields: ({
    name: string,
    data_type: 'numer' | 'text' | 'date/time',
    value: string,
  })[],
  
  customer: {
    email: string,
    company_name: string,
    reference: string,
    phone: string,
    first_name: string,
    last_name: string,
    city: string,
    postcode: string,
    state: string,
    country: string,
    address: string,
    customer_account: string | null,
    metadata: JSON,
  },
  
  product_details: {
    product_id: number,
    product_name: string,
    short_code: string,
    authorization_method: 'license-key' | 'user',
    metadata: JSON,
  },
  
  metadata: JSON,
  
  // the following property is only present if is_trial=true
  trial_days: number,
  
  // the following properties is only present if is_floating=true or is_floating_cloud=true
  floating_in_use_devices: number,
  floating_users: number,
  
  // the following properties are only present if license_type='consumption'
  max_consumptions: number,
  total_consumptions: number,
  allow_unlimited_consumptions: boolean,
  reset_consumption: boolean,
  consumption_period: string | null, // string is in DateISO8601UTC format
  
} & ({

  // for key-based licenses:
  license_key: string,

} | {

  // for user-based licenses:
  user: {
    id: number,
    email: string,
    first_name: string,
    last_name: string,
    phone_number: string,
    is_initial_password: boolean,
    max_activations: number,
    allow_unlimited_activations: boolean,
    total_activations: number
  }
});
﻿
Response Signatures
The response objects contains the following digital signature:
 license_signature: see the Response Signature﻿ article
license_signature_v2: see the Response Signature v2﻿ article
offline_signature: can be used for activating/deactivating using the offline method, see the Deactivate Bundle (Offline Method)﻿ article
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. Requires username and to be provided.
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. 
License Types
The license_type property defines one of the 4 types of licenses based on their duration and how the license is used:
Perpetual: perpetual
Time-limited: time-limited
Subscription: subscription
Consumption: consumption
For more information see: License Types﻿ 
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
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
List of exceptions
missing_headers (400): Some headers are missing
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_enabled (400): The license is not enabled
license_not_active (400): The license is not active
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
license_not_enough_consumptions (400): Not enough consumptions left
floating_not_available (400): No available slots for floating license
﻿
Updated 25 Mar 2025
Did this page help you?
Check License
License Feature Check