Add Consumption

Endpoint

• Method: POST

• Path: /api/v4/add_consumption

• Description: Adds 1 or more consumptions to a license (consumption-type licenses 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)

One of:

• license_key (string)

• username (string)

Optional:

• license_id (number)

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

• max_overages (number)

• allow_overages (boolean)

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

Examples

curl

curl --location --request POST '/api/v4/add_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",
  "license_key": "AAAA-BBBB-CCCC-DDDD",
  "consumptions": 1
}'

nodejs

javascript (fetch)

python

ruby

Schema

Request Body

Request schema (TypeScript + JSON Schema)

TypeScript

type AddConsumptionRequestBody = ({

  // required for key-based products:
  license_key: string,

} | {
  // required for user-based products:
  username: string,

}) & {
  // required parameters:
  product: string,
  hardware_id: string,

  // optional parameters:
  license_id?: string | undefined,
  consumptions?: number | undefined,
  max_overages?: number | undefined,
  allow_overages?: boolean | 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" },
        "license_id": { "type": "number" },
        "consumptions": { "type": "number" },
        "max_overages": { "type": "number" },
        "allow_overages": { "type": "boolean" },
        "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"],
      "additionalProperties": false
    }
  ]
}

Response Body

Response schema (TypeScript + JSON Schema)

TypeScript

type AddConsumptionResponseBody = {
  id: number,
  max_consumptions: number,
  total_consumptions: number,
  allow_unlimited_consumptions: boolean,
  allow_negative_consumptions: boolean,
  allow_overages: boolean,
  max_overages: number,
  reset_consumption: boolean,
  consumption_period: 'daily' | 'weekly' | 'monthly' | 'annually' | null,
}

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 ] }
  },
  "required": [
    "id",
    "max_consumptions",
    "total_consumptions",
    "allow_unlimited_consumptions",
    "allow_negative_consumptions",
    "allow_overages",
    "max_overages",
    "reset_consumption",
    "consumption_period"
  ],
  "additionalProperties": false
}

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:

Error schema (TypeScript + JSON Schema)

TypeScript

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

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
}

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

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