> For the complete documentation index, see [llms.txt](https://docs.licensespring.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.licensespring.com/events-api/event-list/event-data-objects.md).

# Event Data Objects

Field reference and payload examples for objects included in Events API webhooks.

The `data` object contains one or more objects under keys matching their names, such as `data.license`.

Each event page identifies the objects it includes. Objects that do not apply are omitted. They are never sent as `null`.

{% hint style="info" %}
**Dates use two formats.** Events from the Vendor Platform and Management API use dates such as `"2026-12-31"` and times such as `"2026-12-31T14:00:00Z"`.

License API events  activations, checks, deactivations, consumptions, new orders, and trials, use full timestamps for `validity_period` and `maintenance_period`, such as `"2026-12-31T00:00:00.000Z"`. Parse both formats.
{% endhint %}

### Licenses

#### `license`

| Field                       | Type           | Description                                                                                                                                             |
| --------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                        | integer        | License id                                                                                                                                              |
| `license_key`               | string or null | The license key. `null` or missing for user-based licenses                                                                                              |
| `max_license_users`         | integer        | How many license users can be assigned                                                                                                                  |
| `is_trial`                  | boolean        | Whether it is a trial license                                                                                                                           |
| `active`                    | boolean        | Whether the license has been activated. `false` until the first activation, and again after a reset                                                     |
| `enabled`                   | boolean        | Whether the license is enabled                                                                                                                          |
| `validity_period`           | date or null   | Expiry date. `null` if the license doesn't expire                                                                                                       |
| `enable_maintenance_period` | boolean        | Whether the license has a maintenance period                                                                                                            |
| `maintenance_period`        | date or null   | End of maintenance                                                                                                                                      |
| `max_activations`           | integer        | How many devices can activate the license                                                                                                               |
| `times_activated`           | integer        | How many times the license has been activated                                                                                                           |
| `max_consumptions`          | integer        | Consumption limit, for consumption licenses                                                                                                             |
| `total_consumptions`        | integer        | Consumptions used, for consumption licenses                                                                                                             |
| `allow_overages`            | boolean        | Whether overages are allowed. Only in events sent by the License API, except `license.created`                                                          |
| `max_overages`              | integer        | Overage allowance. Same as above                                                                                                                        |
| `activation_type`           | string         | `online` or `offline`. Only in `license.activated`                                                                                                      |
| `deactivation_type`         | string         | `online` or `offline`. Only in `license.deactivated`                                                                                                    |
| `product`                   | object         | The `product` object. Only in `license.activated`, `license.checked`, `license.deactivated`, `license.released` and the consumption and checkout events |
| `order`                     | object         | The license's order: `id` (integer) and `store_id` (string or null)                                                                                     |

#### `license_product_feature`

A product feature as it is on one license. See [License feature events](https://docs.licensespring.com/events-api/event-list/license-feature-events.md) for where it sits in `data`.

| Field                         | Type            | Description                                                                                                     |
| ----------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
| `id`                          | integer         | License feature id                                                                                              |
| `license_id`                  | integer         | The license                                                                                                     |
| `product_feature_id`          | integer         | The product feature it comes from                                                                               |
| `max_consumption`             | integer         | Consumption limit, for consumption features                                                                     |
| `total_consumptions`          | integer         | Consumptions used                                                                                               |
| `allow_overages`              | boolean         | Whether overages are allowed                                                                                    |
| `max_overages`                | integer         | Overage allowance                                                                                               |
| `allow_negative_consumptions` | boolean         | Whether negative consumptions are allowed                                                                       |
| `consumption_period`          | string or null  | How often consumptions reset: `daily`, `weekly`, `monthly` or `annually`. Empty or `null` when they don't reset |
| `expiry_date`                 | date or null    | When the feature expires. An empty string or `null` when it doesn't                                             |
| `is_floating`                 | boolean         | Whether it is a floating feature                                                                                |
| `is_floating_cloud`           | boolean         | Whether it is a floating cloud feature                                                                          |
| `floating_users`              | integer         | Floating seats                                                                                                  |
| `floating_timeout`            | integer or null | Floating timeout in minutes                                                                                     |

#### `license_custom_field`

| Field                     | Type    | Description               |
| ------------------------- | ------- | ------------------------- |
| `id`                      | integer | Id of the value           |
| `license_id`              | integer | The license               |
| `product_custom_field_id` | integer | The product custom field  |
| `value`                   | string  | The value on this license |

#### `license_user`

| Field        | Type    | Description     |
| ------------ | ------- | --------------- |
| `id`         | integer | License user id |
| `true_email` | string  | Email address   |
| `first_name` | string  | First name      |
| `last_name`  | string  | Last name       |

#### `license_user_group`

| Field  | Type    | Description |
| ------ | ------- | ----------- |
| `id`   | integer | Group id    |
| `code` | string  | Group code  |
| `name` | string  | Group name  |

### Devices

#### `device`

| Field         | Type    | Description              |
| ------------- | ------- | ------------------------ |
| `id`          | integer | Device id                |
| `hardware_id` | string  | The device's hardware ID |

#### `device_variable`

| Field       | Type    | Description    |
| ----------- | ------- | -------------- |
| `id`        | integer | Variable id    |
| `device_id` | integer | The device     |
| `variable`  | string  | Variable name  |
| `value`     | string  | Variable value |

See [License custom field and device variable events](https://docs.licensespring.com/events-api/event-list/license-custom-field-and-device-variable-events.md) for the shape the License API sends.

### Customers and orders

#### `customer`

| Field                                             | Type    | Description                     |
| ------------------------------------------------- | ------- | ------------------------------- |
| `id`                                              | integer | Customer id                     |
| `email`                                           | string  | Email address                   |
| `first_name`, `last_name`                         | string  | Name                            |
| `phone`                                           | string  | Phone number                    |
| `reference`                                       | string  | Your reference for the customer |
| `address`, `postcode`, `city`, `state`, `country` | string  | Address                         |

{% hint style="info" %}
Empty fields are empty strings. The customer company name, metadata, and customer account are not included.
{% endhint %}

#### `order`

| Field      | Type           | Description                            |
| ---------- | -------------- | -------------------------------------- |
| `id`       | integer        | Order id. A string in `order.created`  |
| `store_id` | string or null | The order id from your store or system |

### Products

#### `product`

| Field                  | Type    | Description                                              |
| ---------------------- | ------- | -------------------------------------------------------- |
| `id`                   | integer | Product id                                               |
| `product_name`         | string  | Name                                                     |
| `short_code`           | string  | Product short code. Changes when the product is archived |
| `active`               | boolean | Whether the product is enabled                           |
| `authorization_method` | string  | `license-key` or `user`                                  |
| `is_archived`          | boolean | Whether the product is archived                          |
| `is_bundle`            | boolean | Whether the product is a bundle                          |

#### `product_feature`

| Field                              | Type            | Description                               |
| ---------------------------------- | --------------- | ----------------------------------------- |
| `id`                               | integer         | Product feature id                        |
| `product_id`                       | integer         | The product                               |
| `name`, `code`                     | string          | Feature name and code                     |
| `feature_type`                     | string          | `activation` or `consumption`             |
| `is_deleted`                       | boolean         | Whether the feature is deleted            |
| `max_consumption`                  | integer         | Default consumption limit                 |
| `allow_unlimited_consumptions`     | boolean         | Whether consumption is unlimited          |
| `allow_negative_consumptions`      | boolean         | Whether negative consumptions are allowed |
| `allow_overages`                   | boolean         | Whether overages are allowed              |
| `max_overages`                     | integer         | Overage allowance                         |
| `reset_consumption`                | boolean         | Whether consumptions reset periodically   |
| `consumption_period`               | string or null  | Reset period                              |
| `is_floating`, `is_floating_cloud` | boolean         | Floating type                             |
| `floating_users`                   | integer         | Floating seats                            |
| `floating_timeout`                 | integer or null | Floating timeout in minutes               |

#### `product_custom_field`

| Field           | Type    | Description                    |
| --------------- | ------- | ------------------------------ |
| `id`            | integer | Custom field id                |
| `name`          | string  | Field name                     |
| `default_value` | string  | Default value for new licenses |

#### `installation_file`

| Field                             | Type    | Description                      |
| --------------------------------- | ------- | -------------------------------- |
| `id`                              | integer | File id                          |
| `product_id`                      | integer | The product                      |
| `version`                         | string  | Version                          |
| `filename`                        | string  | File name                        |
| `full_link`                       | string  | Download link                    |
| `size`                            | string  | File size                        |
| `hash_md5`                        | string  | MD5 hash                         |
| `release_date`                    | date    | Release date                     |
| `enabled`                         | boolean | Whether the file is offered      |
| `environment`                     | string  | Operating system, or empty       |
| `channel`                         | string  | Release channel                  |
| `requires_version`                | string  | Version required before this one |
| `release_notes_link`, `eula_link` | string  | Links                            |

### Scheduled updates

#### `scheduled_update`

| Field                   | Type     | Description                                   |
| ----------------------- | -------- | --------------------------------------------- |
| `id`                    | integer  | Scheduled update id                           |
| `license`               | object   | The `license` object                          |
| `name`, `note`          | string   | Name and note                                 |
| `scheduled_at`          | datetime | When it applies, always on the hour           |
| `status`                | string   | `pending`, `applied`, `cancelled` or `failed` |
| `scheduled_update_data` | list     | The changes, see below                        |

Each item in `scheduled_update_data`:

| Field                  | Type           | Description                                                                                                                                                           |
| ---------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                   | integer        | Change id                                                                                                                                                             |
| `action`               | string         | `license-update`, `license-reset`, `license-product-feature-update`, `license-product-feature-delete`, `license-custom-field-update` or `license-custom-field-delete` |
| `product_feature`      | object or null | The `product_feature` object the change is about                                                                                                                      |
| `product_custom_field` | object or null | The `product_custom_field` object the change is about                                                                                                                 |
| `update_data`          | object         | The values the change sets                                                                                                                                            |
| `error_message`        | string or null | Why the change failed                                                                                                                                                 |

#### `future_scheduled_update`

Available only in `scheduled_update.will_process_1_day`.

| Field    | Type            | Description                             |
| -------- | --------------- | --------------------------------------- |
| `status` | string          | Predicted result: `applied` or `failed` |
| `errors` | list of strings | Why it would fail                       |

### Consumption

#### `consumption_info`

The consumption that caused this event.

| Field          | Type    | Description                                                                                                                   |
| -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `consumptions` | integer | The amount of this call. Negative for a negative consumption                                                                  |
| `is_unlimited` | boolean | Whether the owner has no limit. On license events this is the license, on feature events the feature, on pool events the pool |

#### `consumption_pool`

The pool, after this event.

| Field                          | Type    | Description                                                       |
| ------------------------------ | ------- | ----------------------------------------------------------------- |
| `id`                           | integer | Pool id                                                           |
| `name`                         | string  | Pool name                                                         |
| `type`                         | string  | `license` or `license_product_feature`                            |
| `total_consumptions`           | integer | The pool total after this consumption, reservation or reset       |
| `max_consumptions`             | integer | The pool limit                                                    |
| `allow_overages`               | boolean | Whether the pool allows overages                                  |
| `max_overages`                 | integer | Overage allowance. `0` with overages allowed means no upper limit |
| `allow_unlimited_consumptions` | boolean | Whether the pool has no limit                                     |
| `allow_negative_consumptions`  | boolean | Whether negative consumptions are allowed                         |

#### `consumption_pool_checkout`

An offline checkout. Only on the checkout events.

| Field         | Type           | Description                                                              |
| ------------- | -------------- | ------------------------------------------------------------------------ |
| `checked_out` | integer        | Units reserved for the device                                            |
| `consumed`    | integer        | Units the device reported as used. `0` on `checked_out` events           |
| `returned`    | integer        | Units returned to the pool. `0` on `checked_out` events                  |
| `synced_at`   | string or null | When the checkout was settled (ISO 8601). `null` on `checked_out` events |

{% hint style="warning" %}
For consumption and checkout events, read totals from `consumption_pool` and `consumption_info`.

The `total_consumptions` values in `license` and `license_product_feature` are read at the request start. They may not include the current consumption. To track a license's running total, use `license.updated` or call the License API.
{% endhint %}

### Request details

#### `request_info`

The License API request that caused the event. Sent with the events the License API sends: activations, checks, deactivations, releases, new licenses, and the consumption and checkout events.

| Field          | Type   | Description                                                                                                                                                 |
| -------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `source`       | string | `sdk` when the request came from an SDK, `api` for other License API calls, `platform` for orders created in the vendor platform or with the Management API |
| `sdk_version`  | string | The SDK version, when the request came from an SDK                                                                                                          |
| `query_params` | object | The identifying values sent in the request: any of `username`, `license_key`, `hardware_id`, `product`, `env`, `channel`, `feature`                         |

### Example payloads

#### `license.consumption_added`

A license in the "Shared Usage" pool consumes 5 units from an SDK. The same call also sends the `consumption_pool.consumption_added` event below.

```json
{
  "id": "6f1c2a8e-3b7d-4c55-9a0e-2f4b8d1e7c90",
  "event": "license.consumption_added",
  "user_id": null,
  "initiator_id": "1234",
  "initiator_type": "api_key",
  "ts": 1792656041,
  "data": {
    "license": {
      "id": 1790242270029099,
      "license_key": "DEMO-AAAA-BBBB-CCCC",
      "max_license_users": 0,
      "is_trial": false,
      "active": true,
      "validity_period": null,
      "enable_maintenance_period": false,
      "maintenance_period": null,
      "max_activations": 1,
      "times_activated": 1,
      "max_consumptions": 1000,
      "total_consumptions": 120,
      "allow_overages": false,
      "max_overages": 0,
      "enabled": true,
      "product": {
        "id": 48,
        "product_name": "Consumption Demo",
        "short_code": "consumption-demo",
        "active": true,
        "authorization_method": "license-key",
        "is_archived": false,
        "is_bundle": false
      },
      "order": {
        "id": 9310,
        "store_id": "demo-order-1"
      }
    },
    "device": {
      "id": 55120,
      "hardware_id": "demo-device-01"
    },
    "request_info": {
      "source": "sdk",
      "sdk_version": "7.38.0",
      "query_params": {
        "license_key": "DEMO-AAAA-BBBB-CCCC",
        "hardware_id": "demo-device-01",
        "product": "consumption-demo"
      }
    },
    "consumption_info": {
      "consumptions": 5,
      "is_unlimited": false
    }
  }
}
```

#### `consumption_pool.consumption_added`

The pool event for the same call. `consumption_pool.total_consumptions` is the pool total after the 5 units.

```json
{
  "id": "0b9d4f21-7e6a-4a8c-b1f3-5c2e9d8a7b64",
  "event": "consumption_pool.consumption_added",
  "user_id": null,
  "initiator_id": "1234",
  "initiator_type": "api_key",
  "ts": 1792656041,
  "data": {
    "license": {
      "id": 1790242270029099,
      "license_key": "DEMO-AAAA-BBBB-CCCC",
      "max_license_users": 0,
      "is_trial": false,
      "active": true,
      "validity_period": null,
      "enable_maintenance_period": false,
      "maintenance_period": null,
      "max_activations": 1,
      "times_activated": 1,
      "max_consumptions": 1000,
      "total_consumptions": 120,
      "allow_overages": false,
      "max_overages": 0,
      "enabled": true,
      "product": {
        "id": 48,
        "product_name": "Consumption Demo",
        "short_code": "consumption-demo",
        "active": true,
        "authorization_method": "license-key",
        "is_archived": false,
        "is_bundle": false
      },
      "order": {
        "id": 9310,
        "store_id": "demo-order-1"
      }
    },
    "consumption_pool": {
      "id": 8,
      "name": "Shared Usage",
      "type": "license",
      "total_consumptions": 8205,
      "max_consumptions": 10000,
      "allow_overages": true,
      "max_overages": 500,
      "allow_unlimited_consumptions": false,
      "allow_negative_consumptions": true
    },
    "device": {
      "id": 55120,
      "hardware_id": "demo-device-01"
    },
    "request_info": {
      "source": "sdk",
      "sdk_version": "7.38.0",
      "query_params": {
        "license_key": "DEMO-AAAA-BBBB-CCCC",
        "hardware_id": "demo-device-01",
        "product": "consumption-demo"
      }
    },
    "consumption_info": {
      "consumptions": 5,
      "is_unlimited": false
    }
  }
}
```

#### `consumption_pool.reset`

A vendor platform user resets the pool. Only the `consumption_pool` section is sent.

```json
{
  "id": "c4e81a3d-2f5b-4d6e-9a7c-8b1f0e3d2a59",
  "event": "consumption_pool.reset",
  "user_id": 312,
  "initiator_id": "312",
  "initiator_type": "platform_user",
  "ts": 1792659600,
  "data": {
    "consumption_pool": {
      "id": 8,
      "name": "Shared Usage",
      "type": "license",
      "total_consumptions": 0,
      "max_consumptions": 10000,
      "allow_overages": true,
      "max_overages": 500,
      "allow_unlimited_consumptions": false,
      "allow_negative_consumptions": true
    }
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.licensespring.com/events-api/event-list/event-data-objects.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
