Charge credits for metered usage

Estimate the credit cost

Ask Stigg how many credits the usage would consume, without reporting it. The response includes, per credit currency, the estimated cost, the current balance, the balance after the estimate, and whether the usage would overdraft the balance.

const estimate = await stiggClient.estimateUsageCost({
  customerId: 'customer-demo-01',
  featureId: 'feature-ai-tokens',
  value: estimatedTokens,
});

const [credits] = estimate.estimates;
if (!credits) {
  // The feature isn't credit-based: check estimate.warnings
} else if (credits.wouldOverdraft) {
  // Block the operation or prompt for a top-up
}

estimateUsageCost has a much lower rate limit (3,000 requests per minute) than getCreditEntitlement, which is served from the SDK’s local cache. Take this into account in high-volume flows.

Check the credit entitlement (optional)

The estimate already tells you whether the customer has enough credits, so this step isn’t required. To check against the balance directly, pass the estimated cost as requestedUsage. hasAccess is true only when the remaining balance covers it.

const entitlement = await stiggClient.getCreditEntitlement({
  customerId: 'customer-demo-01',
  currencyId: credits.currencyId,
  options: { requestedUsage: credits.estimatedCost },
});

if (!entitlement.hasAccess) {
  // Block the operation or prompt for a top-up
}

Perform the operation

Run the operation in your application.

Report usage of the metered feature

Report usage against the feature, not the credit currency. Stigg applies the consumption mapping and deducts the matching amount of credits. For credit-backed features, the response includes a credit object with the credits this call deducted and the updated total consumption.

const result = await stiggClient.reportUsage({
  customerId: 'customer-demo-01',
  featureId: 'feature-ai-tokens',
  value: tokensUsed,
  idempotencyKey: 'generation-41a7',
});

// result.credit.consumed: credits deducted by this call
// result.credit.currentUsage: total credits consumed in the current period

Quick start

Credits

Entitlements and access enforcement

Pricing and packaging

Subscriptions and billing

Migration