JS SDK

const client = kelviqSDK({
  productId: 'your-product-id',
  accessToken: 'your-access-token',
});

const pricing = await client.fetchPricing();
console.log(pricing.plans, pricing.currencyCode, pricing.billingPeriods);
 
await client.fetchPricing(true); // bypass cache

const pricing = client.getPricing();

const plan = client.getPlan('pro-plan');
console.log(plan?.displayName, plan?.price.priceType);

if (client.isPricingLoading()) { /* show spinner */ }

const err = client.getLastPricingError();

client.clearPricingCache();

<span data-kq-price="pro-plan" data-kq-period="MONTHLY">Loading...</span>

await client.fetchPricing();
client.renderPricing();
 
// Scope to a container
client.renderPricing({ container: document.getElementById('pricing-section') });
 
// With format options
client.renderPricing({ formatOptions: { compact: true } });

import { kqFormatPrice } from '@kelviq/js-sdk';
 
kqFormatPrice(9.99, '$', { pricingLocale: 'en-US' });                  // "$9.99"
kqFormatPrice(1200, '€', { compact: true, pricingLocale: 'de-DE' });   // "€1,2K"
kqFormatPrice(9.99, '$', { includeCurrencySymbol: false });             // "9.99"

export { kqFormatPrice } from './formatPrice';
export type { KQFormatPriceOptions } from './formatPrice';
export type {
  RawPricingFeature,
  RawPricingCharge,
  RawPricingPrice,
  RawPricingPlan,
  RawPricingBillingPeriod,
  RawPricingApiResponse,
} from './types';

const entitlements = kq.getEntitlements();
// { "email-sends": Entitlement, "api-calls": Entitlement, ... }

const rawItems = kq.getRawEntitlement("email-sends");
// [{ featureId: 'email-sends', featureType: 'METER', hasAccess: true, ... }, ...]

const raw = kq.getRawEntitlements();
// { customerId: 'cust_123', entitlements: [...] }

const kq = kelviqSDK({
  customerId: "cust_123",
  accessToken: "your-access-token",
});

await kq.ready();
// Entitlements are now available
const emails = kq.getEntitlement("email-sends");
console.log(emails.hasAccess, emails.remaining);

interface Entitlement {
  featureId: string;
  featureType: "METER" | "BOOLEAN" | "CUSTOMIZABLE";
  hasAccess: boolean;      // true if at least one item grants access
  hardLimit: boolean;      // true if any item has hardLimit set
  currentUsage: number;    // SUM of all items' currentUsage (METER only)
  usageLimit: number | null; // SUM of all items' usageLimit (METER only)
  remaining: number | null;  // usageLimit - currentUsage
  items: RawEntitlement[];   // Original API objects for this featureId
}

// Before
const emailQuota = kq.getEntitlement<MeteredEntitlement>("email-sends", "metered");
console.log(emailQuota.used, emailQuota.limit);

// After
const emailQuota = kq.getEntitlement("email-sends");
console.log(emailQuota.currentUsage, emailQuota.usageLimit);