Credits: prepaid usage packs

​

Credit types and bundles

• Name and code — customer-facing label and unique slug
• Unit name — what a single unit is called (e.g., “call”, “scan”)
• Units per pack — how many units are included

​

How credits work

1. Plan grants — a plan includes a recurring credit grant (e.g., “1,000 API calls per month”) that resets each billing cycle
2. Direct purchase — the company buys a standalone credit pack through a payment link or embedded checkout

​

Consumption

// Server-side — authoritative
const result = await client.consumeEntitlement({
  featureKey: "api_calls",
  company: { id: "company_123" },
  idempotencyKey: `api-call-${requestId}`,
});

console.log(result.usage);    // Current usage count
console.log(result.limit);    // Allocated total

// Client-side
import { useConsumeEntitlement } from "@arcenpay/react";

const { consume } = useConsumeEntitlement();
await consume("api_calls");

​

Related

• Plans — attach credit grants to plans
• Entitlements — consuming and tracking credit usage
• Add-ons — one-time purchases vs. prepaid credits