> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Labs64 NetLicensing plugin

> Manage NetLicensing products, product modules, license templates, licensees and licenses, validate a licensee at run time, and read transactions.

Use **Labs64 NetLicensing** through Corsair: one client, typed API calls, local DB sync.

Create an API key in the NetLicensing console under Settings > API Access. Its role decides what the plugin can do: a Licensee key only validates and transfers its own licensee, Analytics reads everything, Operation also writes licensees and licenses, and Maintenance also writes products, modules and templates. The key is sent as HTTP Basic with the username `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`, `create` and `update` return `item` with `number`, `active` and `name` lifted out and every property, custom ones included, in `properties`; nested lists such as product discounts are in `lists`.
* **Custom properties.** Any field NetLicensing does not know is stored as a custom property: pass them in `customProperties`.
* **Paging.** List calls take `filter`, `;`-separated `key=value` pairs such as `page=0;items=50`, and return `page` (pageNumber, totalPages, totalItems, hasNext).
* **Validation changes state.** `licensees.validate` checks out floating sessions and uses up pay-per-use and quota amounts unless `dryRun` is true, so it is `destructive`; it also clears the licensee's `markedForTransfer` flag.
* **Deletes.** `forceCascade: true` also deletes what depends on the entity (a product's modules, templates, licensees and licenses). Deletes can't be undone.

**What you get:**

* 29 typed API operations
* 2 synced entities (`licenses`, `products`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/labs64netlicensing better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/labs64netlicensing better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/labs64netlicensing better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/labs64netlicensing better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { labs64netlicensing } from '@corsair-dev/labs64netlicensing';

export const corsair = createCorsair({
	plugins: [
		labs64netlicensing(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Labs64 NetLicensing API key before the first call: `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](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> labs64netlicensing()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**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](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'labs64netlicensing',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List licensees**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.labs64netlicensing.api.licensees.list({ filter: 'page=0;items=20' });
```

**Create a licensee**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.labs64netlicensing.api.licensees.create({ productNumber: 'P001', name: 'Acme Corp' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/labs64netlicensing/api.md) page.

## Query synced data

Synced entities support `tenant.labs64netlicensing.db.<entity>.search()` and `.list()`: `licenses`, `products`.

See [Database](https://docs.corsair.dev/plugins/labs64netlicensing/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/labs64netlicensing/api.md)
>
> Every `labs64netlicensing.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/labs64netlicensing/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.