> 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/vendor-platform/orders/license-detail-view.md).

# License Detail View

## License Status

A license can display one of the following statuses:

| Status            | Description                                                            |
| ----------------- | ---------------------------------------------------------------------- |
| **Active**        | The license is enabled and has at least one active device              |
| **Inactive**      | The license is enabled but currently has no active devices             |
| **Not Activated** | The license has been issued but has never been activated by any device |
| **Disabled**      | The license has been manually disabled from the vendor platform        |

All licenses that have been issued within LicenseSpring will have their own license detail view.

**To access the license editing page via the Orders tab, follow these steps:**

{% stepper %}
{% step %}

### Go to the Orders tab

{% endstep %}

{% step %}

### Click on Licenses

{% endstep %}

{% step %}

### Select the license to edit

From the list, locate and select the license you want to edit. (You can click anywhere on the license row to open the edit license page.)
{% endstep %}
{% endstepper %}

In this view, you can see all information associated with the license, ability to edit the license's entitlements including disabling or resetting a license, review the usage of the license in table format, along with analytics.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/UC2UYILL1d2eV8QgcnDN/oGH07XVkXXNrs6rtzO4rh_image.png)

### Editing a License

{% hint style="info" %}
You cannot edit everything within a license. For example, you cannot edit a license type. You can however, add/remove features, change the expiry date (for time-limited licenses) or max activations
{% endhint %}

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/pcxSDnw744teNX54Yq7l/4ELiubs3yiL1s0bHsBr0F_image.png)

Depending on the type of license that it is, you will be able make different types of changes.

Some of the common changes for all licenses include:

* Changing the number of max activations allowed for that license
* Setting the number of device transfers allowed or preventing license transfers altogether
* Preventing virtual machines
* Changing the license start date
* Modifying whether or not the license is a floating license
* Modifying the maintenance period for that license

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/2b4TZM8KmiTknafoiSm2/5UvjZLzGRaUfsmUG7hPmF_image.png)

### Reset a License

Resetting a license will reset license entitlements, including setting total activations to 0, deactivating license devices, resetting total consumptions, etc.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/vv73V6qUcYT10oIzVnQt/VvKNMmMN6%20VbBGzPlOPlD_image.png)

When selecting **Reset License**, you will be presented with a set of options that allow you to reset specific license parameters individually. This provides flexibility in managing license states without needing to recreate them entirely.

You can choose to reset the following:

* **Validity period**
* **Consumptions**
* **Maintenance period**
* **Metadata**
* **Product features**
* **Custom fields**

> **Note:** Core license data will always be reset as part of this action.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FFuH5MVzWEXXjvQp8i4jB%2FScreenshot%202026-03-23%20104621.png?alt=media&amp;token=2da6f563-844c-466f-8514-bde4e7671dd1" alt=""><figcaption></figcaption></figure>

### Disable/Enable a License

Disabling a license will reject any attempts to activate, or perform a check on that license. Disabling a license will not change any of the entitlements to the license. The status of the license will be set to `Disabled`

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/fYczZkIYqzE05p1YObg9/XP9ret86YmeY6mNkmfPXe_image.png)

A disabled license can be re-enabled at a later date. The status will revert to whatever the status was if it was not disabled: `Not Activated`/`Inactive`/`Active`"

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/bB7bwxhNa5HvseBHIA52/_8q4lEpdxd4sZTQhHG61a_image.png)

### Delete a License

Deleting a license will remove it from the LicenseSpring database. This is a destructive process, and cannot be reverted through the vendor platform.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/7QLw8p8JbfTmmFNAcxyy/pi1BxtQbTNfpF6ntEcOgm_image.png)

### Devices Associated With a License

Any device that has been activated a license will appear in this tab:

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/zjH1ZUjWmjW3628jKHT1/5KO7tp%20%20j8c6V6HhjoYS7_image.png)

You can retrieve more information on the computer that activated the license by expanding the "details" arrow:

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/AvBNytjOD2IeNbaIstzE/VSeKkZb5DDHm3cKcZtOsV_image.png)

{% hint style="info" %}
Many of the fields are optional and do not need to be sent when activating a license. The only field that needs to be sent when activating a license is the Hardware ID.
{% endhint %}

#### Retrieve Current Device Variables

Devices can send key value pairs back to LicenseSpring. You can retrieve the most current values sent by clicking on the "Device Variables" button.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/QP1kqI2oIi92ybqjXesK/47_REWO%20gOvZ8wfTB7atc_image.png)

![Device Variables Display](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/XrE7yYH9t1PwJvFEZTsz/BmNspJj_L5ghiPaqOPzbU_image.png)

#### Reset Device

Resetting a device from the license details view will set the status of the device to `Inactive` and decrement the `Total activations` field by 1. The next time that device attempts any action using the License API, the server will return a 4XX error.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/7fy5iGApLWr74noWF3wE/PjHwHcIb3pFc6NZr3Sylt_image.png)

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/bP8gx6ZWfmMhotUgT7d1/Ok_A6VoTBeIHnFHcPYzIh_image.png)

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/svtYncZGFl82pv785SK3/Fit1q_uzoW1LEjeftkmO%20_image.png)

#### Blacklist/Whitelist Device

Blacklisting a device will prevent that device from using it with this license. Blacklisted devices appear at the bottom of the view.

You can always unblock a device by whitelisting it.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/zqz4vBWkTHMkOpcSM4Di/trFmjIWXAkjjA7euFasR7_image.png)

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/foG5BuAo6yuJQX7N75qn/sU07%204tkSOJtUv5Qc_Y6p_image.png)

#### Users of a User-Based License

User-based licenses have a `Users` tab listing the users assigned to the license, with their activations on it. The same tab is on user-based bundle licenses.

**See a user's devices on the license**

Click the arrow in the `Devices` column to see the devices that user has activated on this license, with their hardware ID, last check and status. Click a hardware ID to open the device.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FwL3zmtgAQ2oGbQ3TBF9H%2F19-platform-license-users-devices.png?alt=media&amp;token=0dbf43db-cacd-4379-a418-1ffdd34d2c79" alt=""><figcaption></figcaption></figure>

With permission to manage licenses, you can also act on each device:

* `Reset`: deactivates the device and frees its activation. Only active devices can be reset.
* `Revoke`: on floating licenses, releases a device that is currently using a floating seat.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FrML2Pbcr7NylTjCyyQl4%2F20-platform-user-devices-reset.png?alt=media&amp;token=be6aa677-ebf1-41cc-a461-9d546793de57" alt=""><figcaption></figcaption></figure>

The list shows up to 50 devices, most recently checked first. If the user has more, click `View all devices` to open their user page.

> Only devices linked to the user are listed. On older licenses, devices may not be linked to users. Those are listed only on the license's `Devices` tab.

**Remove one user**

Open the menu in the user's `Actions` column and click `Remove`.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FTQKSyHhdGKJt4kL66vvq%2F21-platform-remove-user-reset.png?alt=media&amp;token=9cad6492-ed24-43b9-8569-5519bde3c082" alt=""><figcaption></figcaption></figure>

To also free the activations the user used on this license, tick `Also reset this user's devices on this license`. The user's active devices on the license are listed, all ticked; untick any you want to keep. If no devices are linked to the user, you can pick from the license's active devices instead.

The devices are reset first. If resetting them fails, the user is not removed, so you can try again.

**Remove several users by email**

1. **Click `Batch remove users`.**
2. **Enter the emails** of the users to remove. Type or paste them; an email is added when you press `Enter`, `Tab` or a comma.
3. **Choose whether to reset their devices** with `Also reset the removed users' devices on this license`.
4. **Click `Remove users`.**

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FpbqJJHCkHYP26zUl7x2d%2F25-platform-batch-remove-dialog.png?alt=media&amp;token=2b6f78b7-8708-472e-859d-457a16c36b4c" alt=""><figcaption></figcaption></figure>

If everyone was removed, the dialog closes. Otherwise it lists the results: `Devices reset`, `Removed`, `Removed, but devices could not be reset`, `Removed, no linked devices found to reset`, `Not assigned to this license` and `Could not be removed`. Each user is removed separately, so one failure doesn't stop the others.

> Batch remove resets only devices linked to a user. On older licenses, devices may not be linked to users. Reset those from the license's `Devices` tab.

You can remove users even when the license is full.

#### Get License Refresh File

When a license has been node-locked to a given device, a device-specific license file is created which can be reached through the use of our SDKs to perform local license checks. This file is updated each time entitlements for the license change. You can download this file and send to the end user:

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/Oss7fYsxfBVUA75avspA/tg9WSyrgxUAIU6QagJ8EN_image.png)

After clicking **Download License Refresh File**, a dialog will appear prompting you to select a user and an authorization method.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2F1nn4lzoWW8lhV2Z29j5B%2Fimage.png?alt=media&amp;token=95c322aa-b3bc-4b30-b84b-460cb6bb6fb9" alt=""><figcaption></figcaption></figure>

When **OAuth** is selected as the authorization method, you will be prompted to select a Client ID and Client Secret.

The available OAuth clients are sourced from the following:

* License
* Customer
* Customer Account
* Order
* Company

{% hint style="info" %}
Only valid OAuth clients are displayed  clients with expired secrets will not appear in the list. Make sure the Client ID and Secret you select match the ones being used in the application running on the device.
{% endhint %}

### Edit License Custom Field

If the product has any custom fields defined, then the fields will always be available to all licenses issued for that product. You can override the value of the custom field for any given license.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/FalIl69PDCBExkukgR73/scgA_cQiqLkyU_CaNw9oO_image.png)

### Edit Product Features of the License

You can add/remove or modify features for any given license provided that those features have been defined for the license.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/7lpxWvHr1Cqpbdc9mE1Y/vF3x9s8WQkyCiS_LFbX82_image.png)

#### Add/Remove a Feature

If a feature has not already been added to the license, you can select which feature to add.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/sNp1E2KJRiavUYuqRAjn/EvsFvwdWS_IF08gueVohq_image.png)

{% hint style="info" %}
You can add an expiry date for an individual feature if you would like to limit the use of a module with time. Additionally, you can define a valid\_duration ( same like for a time limited license, eq- 1m, 1y, etc. ) which will be recalculated as expiry\_date at the time of the first license activation.
{% endhint %}

![Toggling Product Features](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/NXgWBQbG8L41AXvZqeGO/hMhoDS5KTInok_gvDZM6V_image.png)

#### Change Consumption Feature Allowances

You can modify the allowances for consumption features:

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/A9se1eEAB5prPVnKNCOZ/eSinBvmRzENNqt7rjH9Vm_image.png)

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/57VvWx0AB0s6QLLBH0T1/zftrlG89PcNQN_83ZS7BK_image.png)

### License Usage Report

The license usage report includes tabular data on events that occurred on the license, such as license checks.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/zMKUCG3DcVGhO4LdEY1R/Em0n1HOW5aztw3eODDs2j_image.png)

#### List of license usage events

* License activated
* Offline license activated
* License check
* Consumption added
* Max consumptions reached
* Feature consumption added
* Max feature consumptions reached
* License created
* License deactivated
* Offline license deactivated
* Floating release
* Floating borrow
* Trial license created
* Get device variables
* Track device variables
* Get versions
* Get installation file

#### Export License Usage Report in a CSV

You may download the CSV of the license usage report by specifying a date range, and clicking the download button.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/X5AoqVuveB8NNitIMPey/wFdToiTS23TmW7ytsRynQ_image.png)

### Analytics

The [**Analytics**](https://docs.licensespring.com/vendor-platform/analytics.md) tab aggregates the license usage report data and plots it for better understanding.

![](https://content.gitbook.com/content/gLzurdfXUuKr9IziZWLz/blobs/KPQ9n2GWv8qk4LVddcDz/HOyob1frBs0bgwnhLdAi2_image.png)

#### Analytics for All Licenses

Using the license detail view, you are able to see license-specific statistics, including:

* License checks
* Get device variables
* Track device variables

#### Analytics for Consumption Licenses

Consumption licenses have unique statistics displayed, including:

* Daily consumptions
* Total consumptions
* Overages

Consumption events are also tracked, such as:

* Reset consumption
* Add consumption

{% hint style="info" %}
**Note:** License analytics also tracks license feature consumption
{% endhint %}


---

# 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/vendor-platform/orders/license-detail-view.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.
