> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# NetLicensing

> NetLicensing is a software license management platform for administering products, license models, licensees, licenses, and commerce workflows.

![NetLicensing logo](https://mintcdn.com/composio-preview/9YPuzjEU4UlMnwGq/images/toolkits/netlicensing.svg?fit=max\&auto=format\&n=9YPuzjEU4UlMnwGq\&q=85\&s=8158cd7cac357baf6c9de482e9a965d8)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 21
* **Triggers:** 0
* **Slug:** `NETLICENSING`
* **Version:** 20261101\_00

## Tools

> [accordion] Check In Licensee Session
>
> **Slug:** `NETLICENSING_CHECK_IN_LICENSEE_SESSION`
>
> Return and release a NetLicensing floating-license session for a licensee and return the validation results and provider cache TTL when supplied.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Required unique identifier for the floating-license session.
>
> **product\_number** `string`
>
> Product number used by general validation when required for licensee auto-creation.
>
> **licensee\_number** `string` *required*
>
> Licensee number or alias whose floating-license session is being changed.
>
> **max\_checkout\_validity** `integer`
>
> Optional positive maximum checkout validity for the session, in seconds.
>
> **product\_module\_number** `string` *required*
>
> Number of the Floating product module that owns the session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Out Licensee Session
>
> **Slug:** `NETLICENSING_CHECK_OUT_LICENSEE_SESSION`
>
> Allocate a NetLicensing floating-license session for a licensee and return the validation results with their cache TTL.
>
> #### Input Parameters
>
> **session\_id** `string` *required*
>
> Required unique identifier for the floating-license session.
>
> **product\_number** `string`
>
> Product number used by general validation when required for licensee auto-creation.
>
> **licensee\_number** `string` *required*
>
> Licensee number or alias whose floating-license session is being changed.
>
> **max\_checkout\_validity** `integer`
>
> Optional positive maximum checkout validity for the session, in seconds.
>
> **product\_module\_number** `string` *required*
>
> Number of the Floating product module that owns the session.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bundle
>
> **Slug:** `NETLICENSING_CREATE_BUNDLE`
>
> Create a purchasable NetLicensing bundle from existing license templates.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable bundle name.
>
> **price** `number`
>
> Bundle price. A positive price requires currency to be EUR.
>
> **active** `boolean` *required*
>
> Whether the bundle is active.
>
> **number** `string`
>
> Optional stable bundle number; NetLicensing generates one when omitted.
>
> **currency** `string`
>
> Bundle-price currency. Required as EUR when price is positive.
>
> **description** `string`
>
> Bundle description.
>
> **license\_template\_numbers** `array` *required*
>
> One or more license-template numbers included in the bundle.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create License
>
> **Slug:** `NETLICENSING_CREATE_LICENSE`
>
> Assign a license from a license template to a licensee.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable license name.
>
> **price** `number`
>
> License-specific price. A positive price requires currency to be EUR.
>
> **active** `boolean` *required*
>
> Whether the license is active.
>
> **hidden** `boolean`
>
> Whether the license is hidden from customer-facing views.
>
> **number** `string`
>
> Optional stable license number; NetLicensing generates one when omitted.
>
> **currency** `string`
>
> License-price currency. Required as EUR when price is positive.
>
> **quantity** `integer`
>
> Allocated quantity.
>
> **start\_date** `string`
>
> ISO-8601 date-time when the license starts.
>
> **time\_volume** `integer`
>
> License-specific time allowance override.
>
> **used\_quantity** `integer`
>
> Initial consumed quantity.
>
> **parent\_feature** `string`
>
> Parent feature license number when this license is a child feature.
>
> **licensee\_number** `string` *required*
>
> Number of the licensee receiving the license.
>
> **time\_volume\_period** `string ("DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Period unit for time\_volume.
>
> **license\_template\_number** `string` *required*
>
> Number of the template defining license behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Licensee
>
> **Slug:** `NETLICENSING_CREATE_LICENSEE`
>
> Create a licensee under a product so licenses can be assigned and validated.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable licensee name.
>
> **active** `boolean` *required*
>
> Whether the licensee is active.
>
> **number** `string`
>
> Optional stable licensee number; NetLicensing generates one when omitted.
>
> **product\_number** `string` *required*
>
> Number of the product that owns the licensee.
>
> **custom\_properties** `object`
>
> Non-secret custom licensee properties. Use exact NetLicensing property names as keys.
>
> **marked\_for\_transfer** `boolean`
>
> Whether this licensee's licenses may be transferred to another licensee.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Licenses From Bundle
>
> **Slug:** `NETLICENSING_CREATE_LICENSES_FROM_BUNDLE`
>
> Create one or more licenses for a licensee from the license templates associated with a bundle.
>
> #### Input Parameters
>
> **bundle\_number** `string` *required*
>
> Number of the bundle whose templates will create licenses.
>
> **licensee\_number** `string` *required*
>
> Number of the licensee that will receive the created licenses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create License Template
>
> **Slug:** `NETLICENSING_CREATE_LICENSE_TEMPLATE`
>
> Create a license template under a product module using a supported license type.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable template name.
>
> **price** `number`
>
> Template price. A positive price requires currency to be EUR.
>
> **quota** `integer`
>
> Default quota for quota-based licensing.
>
> **active** `boolean` *required*
>
> Whether the template is active.
>
> **hidden** `boolean`
>
> Whether the template is hidden from customer-facing views.
>
> **number** `string`
>
> Optional stable template number.
>
> **currency** `string`
>
> Template-price currency. Required as EUR when price is positive.
>
> **quantity** `integer`
>
> Default quantity for quantity-based licensing.
>
> **automatic** `boolean`
>
> Whether licenses are generated automatically from this template.
>
> **time\_volume** `integer`
>
> Time allowance for time-limited licenses.
>
> **license\_type** `string ("FEATURE" | "TIMEVOLUME" | "FLOATING" | "QUANTITY")` *required*
>
> License type returned by NETLICENSING\_LIST\_LICENSING\_OPTIONS.
>
> **max\_sessions** `integer`
>
> Maximum concurrent sessions.
>
> **hide\_licenses** `boolean`
>
> Whether licenses generated from this template are hidden.
>
> **time\_volume\_period** `string ("DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Period unit for time\_volume.
>
> **product\_module\_number** `string` *required*
>
> Number of the parent product module.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product
>
> **Slug:** `NETLICENSING_CREATE_PRODUCT`
>
> Create a NetLicensing product that can contain product modules and licensees.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable product name.
>
> **active** `boolean` *required*
>
> Whether the product is active.
>
> **number** `string`
>
> Optional stable product number; NetLicensing generates one when omitted.
>
> **version** `string` *required*
>
> Product version label.
>
> **vat\_mode** `string ("GROSS" | "NET")`
>
> Whether configured prices include VAT (GROSS) or exclude it (NET).
>
> **discounts** `array`
>
> Discount tiers, each defined by a qualifying total price, currency, and discount amount.
>
> **description** `string`
>
> Product description.
>
> **licensing\_info** `string`
>
> Licensing information shown for the product.
>
> **licensee\_auto\_create** `boolean`
>
> Whether validation may automatically create missing licensees.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product Module
>
> **Slug:** `NETLICENSING_CREATE_PRODUCT_MODULE`
>
> Create a licensing-model-specific module under a NetLicensing product.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable module name.
>
> **active** `boolean` *required*
>
> Whether the module is active.
>
> **number** `string`
>
> Optional stable module number; NetLicensing generates one when omitted.
>
> **red\_threshold** `integer`
>
> Usage threshold for a failing validation result.
>
> **product\_number** `string` *required*
>
> Number of the parent product.
>
> **licensing\_model** `string` *required*
>
> Licensing model name returned by NETLICENSING\_LIST\_LICENSING\_OPTIONS.
>
> **yellow\_threshold** `integer`
>
> Usage threshold for a warning validation result.
>
> **custom\_properties** `object`
>
> Model-specific scalar properties. Use exact NetLicensing property names as keys.
>
> **node\_secret\_modes** `array`
>
> Node-secret modes enabled for the module: PREDEFINED and/or CLIENT.
>
> **max\_checkout\_validity** `integer`
>
> Maximum checkout validity supported by the selected model.
>
> **license\_template\_types** `array`
>
> License template types required by the TryAndBuy licensing model: TIMEVOLUME and/or FEATURE. These are template types, not license-template resource numbers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Resource
>
> **Slug:** `NETLICENSING_DELETE_RESOURCE`
>
> Permanently delete a product, product module, license template, licensee, license, or bundle by number. Optional cascade deletion is limited to supported resource types.
>
> #### Input Parameters
>
> **force\_cascade** `boolean`
>
> Also delete dependent records. Supported only for product, product\_module, license\_template, and licensee; use with care.
>
> **resource\_type** `string ("product" | "product_module" | "license_template" | "licensee" | "license" | "bundle")` *required*
>
> Type of resource to permanently delete.
>
> **resource\_number** `string` *required*
>
> Number of the resource to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Resource
>
> **Slug:** `NETLICENSING_GET_RESOURCE`
>
> Get one product, product module, license template, licensee, license, transaction, or bundle by its NetLicensing number. Secret-like properties and keys are omitted from the returned resource.
>
> #### Input Parameters
>
> **resource\_type** `string ("product" | "product_module" | "license_template" | "licensee" | "license" | "transaction" | "bundle")` *required*
>
> Type of NetLicensing resource to retrieve.
>
> **resource\_number** `string` *required*
>
> Provider-assigned or caller-assigned number of the resource.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Licensing Options
>
> **Slug:** `NETLICENSING_LIST_LICENSING_OPTIONS`
>
> Return the supported licensing models and license types used when configuring product modules and license templates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Resources
>
> **Slug:** `NETLICENSING_LIST_RESOURCES`
>
> List one page of products, product modules, license templates, licensees, licenses, transactions, or bundles for the connected vendor. Secret-like properties and keys are omitted from returned resources.
>
> #### Input Parameters
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged for the next page.
>
> **resource\_type** `string ("product" | "product_module" | "license_template" | "licensee" | "license" | "transaction" | "bundle")` *required*
>
> Type of NetLicensing resource to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Transfer Licenses
>
> **Slug:** `NETLICENSING_TRANSFER_LICENSES`
>
> Irreversibly transfer all eligible licenses from a source licensee marked for transfer to a target licensee in the same product.
>
> #### Input Parameters
>
> **source\_licensee\_number** `string` *required*
>
> Number of the source licensee, which must be marked for transfer and belong to the same product as the target.
>
> **target\_licensee\_number** `string` *required*
>
> Number of the target licensee that will receive the licenses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Bundle
>
> **Slug:** `NETLICENSING_UPDATE_BUNDLE`
>
> Update selected bundle details or replace its complete set of license templates. At least one mutable field is required.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement bundle name.
>
> **price** `number`
>
> Replacement bundle price. A positive price requires currency to be EUR.
>
> **active** `boolean`
>
> Set whether the bundle is active.
>
> **currency** `string`
>
> Replacement bundle-price currency. Required as EUR when price is positive.
>
> **new\_number** `string`
>
> Replacement bundle number.
>
> **description** `string`
>
> Replacement bundle description.
>
> **bundle\_number** `string` *required*
>
> Number of the bundle to update.
>
> **license\_template\_numbers** `array`
>
> Complete replacement set of included license-template numbers. Supply at least one; a bundle cannot be left without templates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update License
>
> **Slug:** `NETLICENSING_UPDATE_LICENSE`
>
> Update a license's identity/number, name, parent-feature relationship, status, timing, pricing, visibility, or quantity. At least one mutable field is required.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement license name.
>
> **price** `number`
>
> Replacement price. A positive price requires currency to be EUR.
>
> **active** `boolean`
>
> Set whether the license is active.
>
> **hidden** `boolean`
>
> Set customer-facing visibility.
>
> **currency** `string`
>
> Replacement license-price currency. Required as EUR when price is positive.
>
> **quantity** `integer`
>
> Replacement allocated quantity.
>
> **new\_number** `string`
>
> Replacement license number. It can be changed only before the associated creation transaction closes.
>
> **start\_date** `string`
>
> Replacement ISO-8601 start date-time.
>
> **time\_volume** `integer`
>
> Replacement time allowance.
>
> **used\_quantity** `integer`
>
> Replacement consumed quantity.
>
> **license\_number** `string` *required*
>
> Number of the license to update.
>
> **parent\_feature** `string`
>
> Replacement parent feature license number.
>
> **time\_volume\_period** `string ("DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Replacement period unit for time\_volume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Licensee
>
> **Slug:** `NETLICENSING_UPDATE_LICENSEE`
>
> Update selected status, identity, transfer, or non-secret custom properties of a licensee. At least one mutable field is required.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement licensee name.
>
> **active** `boolean`
>
> Set whether the licensee is active.
>
> **new\_number** `string`
>
> Replacement licensee number.
>
> **licensee\_number** `string` *required*
>
> Number of the licensee to update.
>
> **custom\_properties** `object`
>
> Non-secret custom properties to update. Use exact NetLicensing property names as keys.
>
> **marked\_for\_transfer** `boolean`
>
> Set whether this licensee's licenses may be transferred.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update License Template
>
> **Slug:** `NETLICENSING_UPDATE_LICENSE_TEMPLATE`
>
> Update selected pricing, visibility, limits, or license behavior on a license template. At least one mutable field is required.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement template name.
>
> **price** `number`
>
> Replacement price. A positive price requires currency to be EUR.
>
> **quota** `integer`
>
> Replacement default quota.
>
> **active** `boolean`
>
> Set whether the template is active.
>
> **hidden** `boolean`
>
> Set customer-facing visibility.
>
> **currency** `string`
>
> Replacement template-price currency. Required as EUR when price is positive.
>
> **quantity** `integer`
>
> Replacement default quantity.
>
> **automatic** `boolean`
>
> Set automatic license generation.
>
> **new\_number** `string`
>
> Replacement template number.
>
> **time\_volume** `integer`
>
> Replacement time allowance.
>
> **license\_type** `string ("FEATURE" | "TIMEVOLUME" | "FLOATING" | "QUANTITY")`
>
> Replacement license type from NETLICENSING\_LIST\_LICENSING\_OPTIONS.
>
> **max\_sessions** `integer`
>
> Replacement maximum concurrent sessions.
>
> **hide\_licenses** `boolean`
>
> Set visibility of generated licenses.
>
> **time\_volume\_period** `string ("DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Replacement period unit for time\_volume.
>
> **license\_template\_number** `string` *required*
>
> Number of the license template to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product
>
> **Slug:** `NETLICENSING_UPDATE_PRODUCT`
>
> Update selected properties of an existing product; supplying discounts replaces the complete discount set, and an empty discounts list clears all discounts by sending one empty discount field. At least one mutable field is required.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement product name.
>
> **active** `boolean`
>
> Set whether the product is active.
>
> **version** `string`
>
> Replacement version label.
>
> **vat\_mode** `string ("GROSS" | "NET")`
>
> Set whether prices include VAT (GROSS) or exclude it (NET).
>
> **discounts** `array`
>
> Discount tiers to apply as the product's complete replacement set. Pass an empty list to clear all discounts; NetLicensing requires this as one empty discount field.
>
> **new\_number** `string`
>
> Replacement product number.
>
> **description** `string`
>
> Replacement product description.
>
> **licensing\_info** `string`
>
> Replacement licensing information.
>
> **product\_number** `string` *required*
>
> Number of the product to update.
>
> **licensee\_auto\_create** `boolean`
>
> Set whether validation may automatically create licensees.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product Module
>
> **Slug:** `NETLICENSING_UPDATE_PRODUCT_MODULE`
>
> Update selected properties and model-specific settings of a product module. At least one mutable field is required. When provided, non-empty node\_secret\_modes and license\_template\_types arrays each replace the complete corresponding set; omit either array to leave that set unchanged. The obsolete license\_template\_numbers name is not an input.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement module name.
>
> **active** `boolean`
>
> Set whether the module is active.
>
> **new\_number** `string`
>
> Replacement module number.
>
> **red\_threshold** `integer`
>
> Replacement failing threshold.
>
> **licensing\_model** `string`
>
> Replacement licensing model returned by NETLICENSING\_LIST\_LICENSING\_OPTIONS.
>
> **yellow\_threshold** `integer`
>
> Replacement warning threshold.
>
> **custom\_properties** `object`
>
> Model-specific scalar properties to update. Use exact NetLicensing property names as keys; standard product-module properties are not allowed.
>
> **node\_secret\_modes** `array`
>
> Non-empty replacement set of node-secret modes: PREDEFINED and/or CLIENT. Omit this field to leave the current set unchanged.
>
> **max\_checkout\_validity** `integer`
>
> Replacement maximum checkout validity.
>
> **product\_module\_number** `string` *required*
>
> Number of the product module to update.
>
> **license\_template\_types** `array`
>
> Non-empty replacement set of TryAndBuy license template types: TIMEVOLUME and/or FEATURE. These are template types, not license-template resource numbers; omit this field to leave the current set unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Licensee
>
> **Slug:** `NETLICENSING_VALIDATE_LICENSEE`
>
> Validate a NetLicensing licensee's active licenses and return the validation results with their cache TTL. Depending on the configured product, validation may auto-create the licensee when licensee\_name and product\_number are supplied.
>
> #### Input Parameters
>
> **licensee\_name** `string`
>
> Licensee name used by product configurations that auto-create licensees.
>
> **product\_number** `string`
>
> Expected product number when the licensee identifier alone is insufficient.
>
> **licensee\_number** `string` *required*
>
> Licensee number or alias to validate, up to 1000 characters.
>
> **product\_modules** `array`
>
> Product modules to validate, with licensing-model parameters keyed by their exact NetLicensing names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
