Add Feature Consumption

Endpoint

• Method: POST

• Path: /api/v4/add_feature_consumption

• Description: Adds 1 or more consumptions to a license feature (licenses with consumption features only).

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string

• Authorization (string)

Recommended headers

• Accept: application/json

• Content-Type: application/json

Request

Body parameters

Required:

• hardware_id (string)

• product (string)

• feature (string)

One of:

• license_key (string)

• username (string)

Optional:

• license_id (number)

• consumptions (number) — Defaults to 1. Can be negative if allowed.

• event (array of strings) — consumption_add (default) or offline_floating_consumptions_sync (mutually exclusive)

Schema

Request schema (TypeScript + JSON Schema)

TypeScript

type AddFeatureConsumptionRequestBody = ({
  
  // required for key-based products:
  license_key: string,
 
} | { 
  // required for user-based products:
  username: string,

}) & {
  // required parameters:
  product: string,
  hardware_id: string,
  feature: string,
  
  // optional parameters:
  license_id?: string | undefined,
  consumptions?: number | undefined,
  event?: ('consumption_add' | 'offline_floating_consumptions_sync')[] | undefined,
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "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" },
        "feature": { "type": "string" },
        "license_id": { "type": "number" },
        "consumptions": { "type": "number" },
        "event": {
          "type": "array",
          "items": { "type": "string", "enum": ["consumption_add", "offline_floating_consumptions_sync"] },
          "minItems": 1,
          "not": {
            "allOf": [
              { "contains": { "const": "consumption_add" } },
              { "contains": { "const": "offline_floating_consumptions_sync" } }
            ]
          }
        }
      },
      "required": ["hardware_id", "product", "feature"],
      "additionalProperties": false
    }
  ]
}

Response schema (TypeScript + JSON Schema)

TypeScript

type AddFeatureConsumptionResponseBody = {
    allow_negative_consumptions: boolean,
    allow_overages: boolean,
    allow_unlimited_consumptions: boolean,
    consumption_period: 'daily' | 'weekly' | 'monthly' | 'annually' | null,
    is_floating_cloud: boolean,
    is_floating: boolean,
    max_consumptions: number,
    max_overages: number,
    reset_consumption: boolean,
    total_consumptions: number,
    
    // the following properties are only present on floating and floating cloud features:
   floating_timeout?: number | null,
   floating_users?: number,
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": { "type": "number" },
    "max_consumptions": { "type": "number" },
    "total_consumptions": { "type": "number" },
    "allow_unlimited_consumptions": { "type": "boolean" },
    "allow_negative_consumptions": { "type": "boolean" },
    "allow_overages": { "type": "boolean" },
    "max_overages": { "type": "number" },
    "reset_consumption": { "type": "boolean" },
    "consumption_period": { "type": [ "string", "null" ], "enum": [ "daily", "weekly", "monthly", "annually", null ] },
    "is_floating_cloud": { "type": "boolean" },
    "is_floating": { "type": "boolean" },
    "floating_timeout": { "type": [ "number", null ] },
    "floating_users": { "type": "number" }
  },
  "required": [
    "id",
    "max_consumptions",
    "total_consumptions",
    "allow_unlimited_consumptions",
    "allow_negative_consumptions",
    "allow_overages",
    "max_overages",
    "reset_consumption",
    "consumption_period",
    "is_floating_cloud",
    "is_floating"
  ],
  "additionalProperties": false
}

Response

Success response example (200)

{
  "total_consumptions": 5,
  "max_consumptions": 20,
  "allow_unlimited_consumptions": false,
  "allow_negative_consumptions": true,
  "allow_overages": false,
  "max_overages": 0,
  "reset_consumption": true,
  "consumption_period": "daily",
  "is_floating": false,
  "is_floating_cloud": false
}

Error response example (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."
}

Examples

curl

curl --location --request POST '/api/v4/add_feature_consumption' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{
  "hardware_id": "some-unique-id",
  "product": "XY",
  "feature": "FEATURE",
  "license_key": "AAAA-BBBB-CCCC-DDDD",
  "consumptions": 1
}'

nodejs

javascript (fetch)

python

ruby

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: client interactions with the license have to be authorized using a license_key

• User-based product licenses: the license has a corresponding "license user" instead of a license key. Client interactions with the license have to be authorized using a username

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:

:::CodeblockTabs

{
  status: number,
  code: string,
  message: string
}

:::

JSON Schema

:::CodeblockTabs

{
  "$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

• 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

• unsupported_product_feature (400): One or more of requested product features do not exists or they are not enabled on the product

• feature_not_enough_consumptions (400): Not enough consumptions left

• negative_consumptions_not_allowed (400): Negative consumptions not allowed

• device_not_found (400): An active device matching the hardware_id not found

• blacklisted (400): This device is blacklisted