Skip to main content
NetLicensing logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: NETLICENSING
  • Version: 20261101_00

Tools

Slug: NETLICENSING_CHECK_IN_LICENSEE_SESSIONReturn and release a NetLicensing floating-license session for a licensee and return the validation results and provider cache TTL when supplied.

Input Parameters

string
required
Required unique identifier for the floating-license session.
string
Product number used by general validation when required for licensee auto-creation.
string
required
Licensee number or alias whose floating-license session is being changed.
integer
Optional positive maximum checkout validity for the session, in seconds.
string
required
Number of the Floating product module that owns the session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CHECK_OUT_LICENSEE_SESSIONAllocate a NetLicensing floating-license session for a licensee and return the validation results with their cache TTL.

Input Parameters

string
required
Required unique identifier for the floating-license session.
string
Product number used by general validation when required for licensee auto-creation.
string
required
Licensee number or alias whose floating-license session is being changed.
integer
Optional positive maximum checkout validity for the session, in seconds.
string
required
Number of the Floating product module that owns the session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_BUNDLECreate a purchasable NetLicensing bundle from existing license templates.

Input Parameters

string
required
Human-readable bundle name.
number
Bundle price. A positive price requires currency to be EUR.
boolean
required
Whether the bundle is active.
string
Optional stable bundle number; NetLicensing generates one when omitted.
string
Bundle-price currency. Required as EUR when price is positive.
string
Bundle description.
array
required
One or more license-template numbers included in the bundle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_LICENSEAssign a license from a license template to a licensee.

Input Parameters

string
Human-readable license name.
number
License-specific price. A positive price requires currency to be EUR.
boolean
required
Whether the license is active.
boolean
Whether the license is hidden from customer-facing views.
string
Optional stable license number; NetLicensing generates one when omitted.
string
License-price currency. Required as EUR when price is positive.
integer
Allocated quantity.
string
ISO-8601 date-time when the license starts.
integer
License-specific time allowance override.
integer
Initial consumed quantity.
string
Parent feature license number when this license is a child feature.
string
required
Number of the licensee receiving the license.
string ("DAY" | "WEEK" | "MONTH" | "YEAR")
Period unit for time_volume.
string
required
Number of the template defining license behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_LICENSEECreate a licensee under a product so licenses can be assigned and validated.

Input Parameters

string
Human-readable licensee name.
boolean
required
Whether the licensee is active.
string
Optional stable licensee number; NetLicensing generates one when omitted.
string
required
Number of the product that owns the licensee.
object
Non-secret custom licensee properties. Use exact NetLicensing property names as keys.
boolean
Whether this licensee’s licenses may be transferred to another licensee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_LICENSES_FROM_BUNDLECreate one or more licenses for a licensee from the license templates associated with a bundle.

Input Parameters

string
required
Number of the bundle whose templates will create licenses.
string
required
Number of the licensee that will receive the created licenses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_LICENSE_TEMPLATECreate a license template under a product module using a supported license type.

Input Parameters

string
required
Human-readable template name.
number
Template price. A positive price requires currency to be EUR.
integer
Default quota for quota-based licensing.
boolean
required
Whether the template is active.
boolean
Whether the template is hidden from customer-facing views.
string
Optional stable template number.
string
Template-price currency. Required as EUR when price is positive.
integer
Default quantity for quantity-based licensing.
boolean
Whether licenses are generated automatically from this template.
integer
Time allowance for time-limited licenses.
string ("FEATURE" | "TIMEVOLUME" | "FLOATING" | "QUANTITY")
required
License type returned by NETLICENSING_LIST_LICENSING_OPTIONS.
integer
Maximum concurrent sessions.
boolean
Whether licenses generated from this template are hidden.
string ("DAY" | "WEEK" | "MONTH" | "YEAR")
Period unit for time_volume.
string
required
Number of the parent product module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_PRODUCTCreate a NetLicensing product that can contain product modules and licensees.

Input Parameters

string
required
Human-readable product name.
boolean
required
Whether the product is active.
string
Optional stable product number; NetLicensing generates one when omitted.
string
required
Product version label.
string ("GROSS" | "NET")
Whether configured prices include VAT (GROSS) or exclude it (NET).
array
Discount tiers, each defined by a qualifying total price, currency, and discount amount.
string
Product description.
string
Licensing information shown for the product.
boolean
Whether validation may automatically create missing licensees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_CREATE_PRODUCT_MODULECreate a licensing-model-specific module under a NetLicensing product.

Input Parameters

string
required
Human-readable module name.
boolean
required
Whether the module is active.
string
Optional stable module number; NetLicensing generates one when omitted.
integer
Usage threshold for a failing validation result.
string
required
Number of the parent product.
string
required
Licensing model name returned by NETLICENSING_LIST_LICENSING_OPTIONS.
integer
Usage threshold for a warning validation result.
object
Model-specific scalar properties. Use exact NetLicensing property names as keys.
array
Node-secret modes enabled for the module: PREDEFINED and/or CLIENT.
integer
Maximum checkout validity supported by the selected model.
array
License template types required by the TryAndBuy licensing model: TIMEVOLUME and/or FEATURE. These are template types, not license-template resource numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_DELETE_RESOURCEPermanently delete a product, product module, license template, licensee, license, or bundle by number. Optional cascade deletion is limited to supported resource types.

Input Parameters

boolean
Also delete dependent records. Supported only for product, product_module, license_template, and licensee; use with care.
string ("product" | "product_module" | "license_template" | "licensee" | "license" | "bundle")
required
Type of resource to permanently delete.
string
required
Number of the resource to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_GET_RESOURCEGet 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

string ("product" | "product_module" | "license_template" | "licensee" | "license" | "transaction" | "bundle")
required
Type of NetLicensing resource to retrieve.
string
required
Provider-assigned or caller-assigned number of the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_LIST_LICENSING_OPTIONSReturn the supported licensing models and license types used when configuring product modules and license templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_LIST_RESOURCESList 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

string
Opaque continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged for the next page.
string ("product" | "product_module" | "license_template" | "licensee" | "license" | "transaction" | "bundle")
required
Type of NetLicensing resource to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_TRANSFER_LICENSESIrreversibly transfer all eligible licenses from a source licensee marked for transfer to a target licensee in the same product.

Input Parameters

string
required
Number of the source licensee, which must be marked for transfer and belong to the same product as the target.
string
required
Number of the target licensee that will receive the licenses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_UPDATE_BUNDLEUpdate selected bundle details or replace its complete set of license templates. At least one mutable field is required.

Input Parameters

string
Replacement bundle name.
number
Replacement bundle price. A positive price requires currency to be EUR.
boolean
Set whether the bundle is active.
string
Replacement bundle-price currency. Required as EUR when price is positive.
string
Replacement bundle number.
string
Replacement bundle description.
string
required
Number of the bundle to update.
array
Complete replacement set of included license-template numbers. Supply at least one; a bundle cannot be left without templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_UPDATE_LICENSEUpdate a license’s identity/number, name, parent-feature relationship, status, timing, pricing, visibility, or quantity. At least one mutable field is required.

Input Parameters

string
Replacement license name.
number
Replacement price. A positive price requires currency to be EUR.
boolean
Set whether the license is active.
boolean
Set customer-facing visibility.
string
Replacement license-price currency. Required as EUR when price is positive.
integer
Replacement allocated quantity.
string
Replacement license number. It can be changed only before the associated creation transaction closes.
string
Replacement ISO-8601 start date-time.
integer
Replacement time allowance.
integer
Replacement consumed quantity.
string
required
Number of the license to update.
string
Replacement parent feature license number.
string ("DAY" | "WEEK" | "MONTH" | "YEAR")
Replacement period unit for time_volume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_UPDATE_LICENSEEUpdate selected status, identity, transfer, or non-secret custom properties of a licensee. At least one mutable field is required.

Input Parameters

string
Replacement licensee name.
boolean
Set whether the licensee is active.
string
Replacement licensee number.
string
required
Number of the licensee to update.
object
Non-secret custom properties to update. Use exact NetLicensing property names as keys.
boolean
Set whether this licensee’s licenses may be transferred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_UPDATE_LICENSE_TEMPLATEUpdate selected pricing, visibility, limits, or license behavior on a license template. At least one mutable field is required.

Input Parameters

string
Replacement template name.
number
Replacement price. A positive price requires currency to be EUR.
integer
Replacement default quota.
boolean
Set whether the template is active.
boolean
Set customer-facing visibility.
string
Replacement template-price currency. Required as EUR when price is positive.
integer
Replacement default quantity.
boolean
Set automatic license generation.
string
Replacement template number.
integer
Replacement time allowance.
string ("FEATURE" | "TIMEVOLUME" | "FLOATING" | "QUANTITY")
Replacement license type from NETLICENSING_LIST_LICENSING_OPTIONS.
integer
Replacement maximum concurrent sessions.
boolean
Set visibility of generated licenses.
string ("DAY" | "WEEK" | "MONTH" | "YEAR")
Replacement period unit for time_volume.
string
required
Number of the license template to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_UPDATE_PRODUCTUpdate 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

string
Replacement product name.
boolean
Set whether the product is active.
string
Replacement version label.
string ("GROSS" | "NET")
Set whether prices include VAT (GROSS) or exclude it (NET).
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.
string
Replacement product number.
string
Replacement product description.
string
Replacement licensing information.
string
required
Number of the product to update.
boolean
Set whether validation may automatically create licensees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_UPDATE_PRODUCT_MODULEUpdate 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

string
Replacement module name.
boolean
Set whether the module is active.
string
Replacement module number.
integer
Replacement failing threshold.
string
Replacement licensing model returned by NETLICENSING_LIST_LICENSING_OPTIONS.
integer
Replacement warning threshold.
object
Model-specific scalar properties to update. Use exact NetLicensing property names as keys; standard product-module properties are not allowed.
array
Non-empty replacement set of node-secret modes: PREDEFINED and/or CLIENT. Omit this field to leave the current set unchanged.
integer
Replacement maximum checkout validity.
string
required
Number of the product module to update.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NETLICENSING_VALIDATE_LICENSEEValidate 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

string
Licensee name used by product configurations that auto-create licensees.
string
Expected product number when the licensee identifier alone is insufficient.
string
required
Licensee number or alias to validate, up to 1000 characters.
array
Product modules to validate, with licensing-model parameters keyed by their exact NetLicensing names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not