Quickstart

npm install @theplugins/license-sdk
# or: pnpm add @theplugins/license-sdk

import { LicenseClient } from '@theplugins/license-sdk'
 
const client = new LicenseClient({
  apiUrl: process.env.LICENSE_API_URL ?? 'https://licenses.yourplugin.com',
})

const result = await client.activate({
  licenseKey: 'LK-2025-XXXX-YYYY', // from the customer's dashboard
  fingerprint: generateFingerprint(), // stable id for this device/site
  domain: 'acmecorp.com',            // optional, shown in the portal
  label: 'Production server',        // optional, human label
})
 
if (!result.ok) {
  console.error('Activation failed:', result.error)
  process.exit(1)
}
 
// Persist this so you can skip re-activation on restart
const connectionId = result.data.connectionId

const valid = await client.validate({
  licenseKey: 'LK-2025-XXXX-YYYY',
  fingerprint: storedFingerprint,
})
 
if (!valid.ok || !valid.data.active) {
  throw new Error('License invalid or expired')
}
 
console.log('Plan:', valid.data.plan.name)

const usage = await client.reportUsage({
  licenseKey: 'LK-2025-XXXX-YYYY',
  metric: 'api_requests',
  quantity: 1,
})
 
if (!usage.ok || !usage.data.allowed) {
  throw new Error('Plan limit reached for this period')
}