Metered feature limits - Stigg Documentation

This guide shows how to enforce a usage limit on a metered feature, such as “10,000 API calls per month”, using the check, act, track pattern: check the entitlement before the operation, run it, then report the usage. The examples use the Node.js SDK. The same operations are available in every backend SDK and in the REST API.

Check the metered entitlement

Pass requestedUsage to verify that the customer can consume the amount the operation needs, not just that they have some usage left.

const entitlement = await stiggClient.getMeteredEntitlement({
  customerId: 'customer-demo-01',
  featureId: 'feature-api-calls',
  options: { requestedUsage: 1 },
});

if (!entitlement.hasAccess) {
  // Block the operation and show an upsell experience
}

Perform the operation

Run the operation in your application.

Report usage or events to Stigg

Report either calculated usage or raw events. Calculated usage is reflected in the next check immediately; raw events are aggregated by the metering pipeline and suit high-volume streams.

await stiggClient.reportUsage({
  customerId: 'customer-demo-01',
  featureId: 'feature-api-calls',
  value: 1,
  idempotencyKey: 'request-8f2c',
});

await stiggClient.reportEvent({
  customerId: 'customer-demo-01',
  eventName: 'api_call',
  idempotencyKey: 'request-8f2c',
  dimensions: { endpoint: '/v1/search' },
});

Quick start

Credits

Entitlements and access enforcement

Pricing and packaging

Subscriptions and billing

Migration

Enforce metered feature limits