Node SDK

import { CHARGE_PERIOD_CHOICES, PAYMENT_BEHAVIORS } from "@kelviq/node-sdk";

const subscription = await client.subscriptions.update({
  subscriptionId: "78058918-9746-4280-9b9b-1bd5115eec6e",
  planIdentifier: "premium-plan",
  chargePeriod: CHARGE_PERIOD_CHOICES.MONTHLY,
  paymentBehavior: PAYMENT_BEHAVIORS.ACTIVATE_ON_PAYMENT,
});

const page = await client.subscriptions.list({
  customerId: "cust_789",
  page: 1,
  pageSize: 20,
});

const subscription = await client.subscriptions.retrieve({
  subscriptionId: page.results[0].id,
});

const created = await client.subscriptions.create({
  planIdentifier: "plan-pro-monthly",
  chargePeriod: "MONTHLY",
  customerId: "cust_789",
});

const charge = await client.charges.create({
  planIdentifier: "lifetime-access",
  chargePeriod: "ONE_TIME",
  customerId: "cust_789",
  currencyCode: "USD",
  features: [{ identifier: "seats", quantity: 5 }],
  ipAddress: "103.154.35.20",
});

console.log(charge.id, charge.status, charge.amount);

const client = new Kelviq({
  accessToken: process.env.KELVIQ_API_KEY,
  enableCache: true,   // default true
  cacheTtlMs: 60_000,  // freshness window in ms (default 60000)
});

const remaining = await client.reporting.flush(); // returns count still queued

import { Kelviq, RedisStore } from '@kelviq/node-sdk';

const store = new RedisStore({ url: 'redis://localhost:6379/0', prefix: 'kelviq:prod' });
const client = new Kelviq({ accessToken: process.env.KELVIQ_API_KEY, cacheStore: store });

const response = await client.checkout.createSession({
  planIdentifier: "plan-pro-monthly",
  chargePeriod: "MONTHLY",
  customerId: "cust_789",
  successUrl: "https://example.com/success",
  metadata: {
    orderId: "order_12345",
    referralCode: "SUMMER2026",
  },
});

import { CHARGE_PERIOD_CHOICES } from '@kelviq/node-sdk';

// End the trial now
await client.subscriptions.update({
  subscriptionId: "sub_node_78058918",
  planIdentifier: "premium-plan-node",
  chargePeriod: CHARGE_PERIOD_CHOICES.MONTHLY,
  trialEnd: "now",
});

// Extend the trial to a specific future date
await client.subscriptions.update({
  subscriptionId: "sub_node_78058918",
  planIdentifier: "premium-plan-node",
  chargePeriod: CHARGE_PERIOD_CHOICES.MONTHLY,
  trialEnd: "2025-12-31T23:59:59Z",
});

const response = await client.checkout.createSession({
  planIdentifier: "plan-pro-monthly",
  chargePeriod: "MONTHLY",
  customerId: "cust_789",
  successUrl: "https://example.com/success",
  discountsEnabled: false,
  lockEmail: true,
  defaultBillingCountry: "US",
});

import { validateEvent, WebhookVerificationError } from '@kelviq/node-sdk';
import express from 'express';

const app = express();

app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
  try {
    const event = validateEvent(
      req.body,
      req.headers,
      '<YOUR_WEBHOOK_SECRET>',
    );

    // Process the event
    console.log('Event type:', event.type);

    res.sendStatus(202);
  } catch (err) {
    if (err instanceof WebhookVerificationError) {
      return res.sendStatus(403);
    }
    throw err;
  }
});

const response = await client.license.activate({
    licenseKey: "LIC-XXXX-YYYY-ZZZZ",
    customerId: "cust_789",
    instanceName: "My MacBook Pro",
    metadata: { os: "macOS", arch: "arm64" },
});

console.log(response.instanceId);
console.log(response.license.activationUsage); // e.g. 1
console.log(response.license.plan.product.name); // e.g. "Kelviq Engine"

const response = await client.license.deactivate({
    licenseKey: "LIC-XXXX-YYYY-ZZZZ",
    instanceId: "8f3e2b1a-5c6d-4e9f-8a0b-1c2d3e4f5g6h",
});
console.log(response.message); // "License instance deactivated successfully."

const response = await client.license.validate({
    licenseKey: "LIC-XXXX-YYYY-ZZZZ",
    instanceId: "8f3e2b1a-5c6d-4e9f-8a0b-1c2d3e4f5g6h",
});

if (response.valid) {
    console.log(`Valid — code: ${response.code}`);
} else {
    console.log(`Invalid — ${response.detail}`);
}

const session = await client.portal.createSession({
    customerId: "cust_789",
});

// Redirect the customer — no login required
res.redirect(session.customerPortalUrl);

const entitlement = await client.entitlements.getEntitlement({
  customerId: "cust_123",
  featureId: "email-sends",
});

// Aggregated values across all subscriptions
console.log(entitlement.hasAccess);    // true
console.log(entitlement.usageLimit);   // 1500 (e.g., 1000 from base plan + 500 from top-up)
console.log(entitlement.currentUsage); // 200
console.log(entitlement.remaining);    // 1300

// Per-subscription details
entitlement.items.forEach(item => {
  console.log(item.usageLimit, item.resetAt);
});

const raw = await client.entitlements.getRawEntitlement({
  customerId: "cust_123",
  featureId: "email-sends",
});
// { customerId: "cust_123", entitlements: [/* raw entries for email-sends */] }

const raw = await client.entitlements.getRawEntitlements({
  customerId: "cust_123",
});
// { customerId: "cust_123", entitlements: [/* all raw entries */] }

// Before
const sub = await client.subscription.get({ subscriptionId: "sub_123" });

// After
const sub = await client.subscriptions.get({ subscriptionId: "sub_123" });

// Before
const response = await client.entitlements.getEntitlement({
  customerId: "cust_123",
  featureId: "email-sends",
});
// { customerId: "cust_123", entitlements: [...] }

// After
const entitlement = await client.entitlements.getEntitlement({
  customerId: "cust_123",
  featureId: "email-sends",
});
// { featureId: "email-sends", hasAccess: true, currentUsage: 200, ... }

// Before
const response = await client.entitlements.getAllEntitlements({ customerId: "cust_123" });

// After
const entitlements = await client.entitlements.getEntitlements({ customerId: "cust_123" });
// { "email-sends": Entitlement, "api-calls": Entitlement, ... }

// Before
if (entitlement.featureType === "LIMIT") { ... }

// After
if (entitlement.featureType === "CUSTOMIZABLE") { ... }

// Before
console.log(entitlement.resetAt);

// After
entitlement.items.forEach(item => {
  console.log(item.resetAt); // per-subscription reset date
});