Adding Consumption

7min
Only for consumption licenses. Adds 1 (or more) consumptions to the license usage
POST
Params
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Body Parameters
hardware_id
required
String
Unique hardware ID generated for some device
product
required
String
Product short code
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. user@example.com)
consumptions
optional
Number
number of consumptions  (this is optional, if not provided "1" is default)
max_overages
optional
String
maximum number of overages
allow_overages
optional
String
true or false
Curl
Node.js
JS
Python
Ruby
|
import requests

url = "/api/v4/add_consumption"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"consumptions\":\"Number\",\"max_overages\":\"string\",\"allow_overages\":\"string\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/add_consumption"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"consumptions\":\"Number\",\"max_overages\":\"string\",\"allow_overages\":\"string\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
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",
    "device_not_found": "An active device matching the hardware_id not found.",
    "blacklisted": "This device is blacklisted",
    "license_not_active": "This license is not activated",
    "unsupported_product_feature": "One or more of requested product features     do not exists or they are not enabled on the product.",
    "Feature_not_enough_consumptions": "Not enough consumptions left."
{
    "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",
    "device_not_found": "An active device matching the hardware_id not found.",
    "blacklisted": "This device is blacklisted",
    "license_not_active": "This license is not activated",
    "unsupported_product_feature": "One or more of requested product features     do not exists or they are not enabled on the product.",
    "Feature_not_enough_consumptions": "Not enough consumptions left."
﻿
List of exceptions
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
license_not_enabled (400): The license is not enabled
license_not_consumption (400): The license needs to be of consumption type
license_not_enough_consumptions (400): Not enough consumptions left
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
﻿
Updated 22 Sep 2023
Did this page help you?
Consumption
Adding Feature Consumption
Docs powered by
Archbee
TABLE OF CONTENTS
POST
/api/v4/add_consumption
List of exceptions