apiKey.
Things to know:
- How the pieces fit. A product has product modules; each module has a licensing model (TryAndBuy, Subscription, Floating, PayPerUse, …) and license templates. A licensee is one of your customers under a product, and a license is created for a licensee from a template.
- Every value is a string. NetLicensing returns each entity as a list of properties.
get,createandupdatereturnitemwithnumber,activeandnamelifted out and every property, custom ones included, inproperties; nested lists such as product discounts are inlists. - Custom properties. Any field NetLicensing does not know is stored as a custom property: pass them in
customProperties. - Paging. List calls take
filter,;-separatedkey=valuepairs such aspage=0;items=50, and returnpage(pageNumber, totalPages, totalItems, hasNext). - Validation changes state.
licensees.validatechecks out floating sessions and uses up pay-per-use and quota amounts unlessdryRunis true, so it isdestructive; it also clears the licensee’smarkedForTransferflag. - Deletes.
forceCascade: truealso deletes what depends on the entity (a product’s modules, templates, licensees and licenses). Deletes can’t be undone.
- 29 typed API operations
- 2 synced entities (
licenses,products) for fast.search()/.list()
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Labs64 NetLicensing API key before the first call: More: API Key
pnpm corsair setup --plugin=labs64netlicensing --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
List licenseesQuery synced data
Synced entities supporttenant.labs64netlicensing.db.<entity>.search() and .list(): licenses, products.
See Database for filters and operators.
What’s next
API reference
Every
labs64netlicensing.api.* operation with input and output types.Database
Synced entities, search filters, and operators.
Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.