Node.js SDK

npm install @orvlin/node

import { Orvlin } from '@orvlin/node';

const orvlin = new Orvlin({
  apiKey: process.env.ORVLIN_API_KEY!,
  baseUrl: 'https://api.orvlin.com',
});

const { hasAccess, remaining, source } = await orvlin.check('cust_acme', 'api_calls', { amount: 1 });

const entitlements = await orvlin.getEntitlements('cust_acme');

await orvlin.prefetch(['cust_acme', 'cust_globex']); // warm the cache
orvlin.invalidate('cust_acme');                      // drop one customer
orvlin.invalidate();                                 // drop everything

const snapshot = orvlin.snapshot();                  // save the cache
orvlin.restore(snapshot);                            // load it into a new process

await orvlin.track({
  customerId: 'cust_acme',
  eventName: 'api_call',
  idempotencyKey: requestId,
  properties: { endpoint: '/v1/search', statusCode: 200, latencyMs: 142 },
});

const result = await orvlin.track([
  { customerId: 'cust_acme', eventName: 'api_call', idempotencyKey: 'req_1' },
  { customerId: 'cust_acme', eventName: 'api_call', idempotencyKey: 'req_2' },
]);
// result: { accepted: 2, rejected: [] }

const { allowed, balance } = await orvlin.checkCredits('cust_acme', {
  creditType: 'ai_images',
  quantity: 1,
});

const wallets = await orvlin.getCreditBalances('cust_acme');

await orvlin.grantCredits('cust_acme', 'ai_images', {
  amount: 500,
  source: 'promotional',
  idempotencyKey: 'promo_launch_acme',
});

await orvlin.purchaseCredits('cust_acme', 'ai_images', {
  credits: 1000,
  collection: 'charge',
  idempotencyKey: 'order_20261012_001',
});

await orvlin.setAutoTopUp('cust_acme', 'ai_images', {
  threshold: 100,
  credits: 1000,
  maxPerMonth: 5,
  enabled: true,
});

import { OrvlinError } from '@orvlin/node';

try {
  await orvlin.track(event);
} catch (err) {
  if (err instanceof OrvlinError && err.status === 401) {
    // The API key is missing, revoked, or has the wrong role.
  }
}