Report usage after each chargeable operation and handle limits and credit overage.

If your plugin sells metered capacity (API calls, image generations, translations), report usage after each chargeable operation so limits and billing stay accurate.

Report usage

const usage = await client.reportUsage({
  licenseKey: 'LK-2025-XXXX-YYYY',
  metric: 'api_requests',  // your metric key
  quantity: 1,
})
 
if (!usage.ok || !usage.data.allowed) {
  throw new Error(`Limit reached: ${usage.data?.remaining ?? 0} left this period`)
}

The response tells you where the customer stands:

Field	Meaning
`allowed`	Whether this operation is permitted
`remaining`	Units left this period
`resetAt`	When the counter resets

Check-then-do pattern

Report (and decrement) before doing expensive work, so you never perform an operation the customer can't pay for:

export async function generateImage(prompt: string, licenseKey: string) {
  const usage = await client.reportUsage({
    licenseKey,
    metric: 'image_generations',
    quantity: 1,
    consumeCredits: true, // allow credit overage past the plan limit
  })
 
  if (!usage.ok || !usage.data.allowed) {
    throw new Error(
      `Monthly limit reached. ${usage.data?.remaining ?? 0} left. ` +
      `Resets ${new Date(usage.data?.resetAt ?? '').toLocaleDateString()}.`,
    )
  }
 
  return doGenerateImage(prompt) // only runs if allowed
}