Documentation

HUME is a headless billing engine with an HTTP API, StatsD ingestion, and a dashboard with a billing rule editor. It meters usage, evaluates entitlements, and produces invoice JSON — you pass those lines to your payment gateway, acquirer, or other payment layer.

Not sure where to start? Open Recipes — pick a real-world scenario (freemium API, per-seat, peak/off-peak, …) and copy a ready-made plan payload.

Two interfaces

• HTTP API — catalog, subscriptions, usage, entitlements, invoice generation
• StatsD (UDP) — high-frequency usage ingestion with zero application overhead

Documentation map

Use the sidebar to browse by topic:

• Quickstart — end-to-end curl walkthrough
• Recipes — real-world pricing scenarios by complexity
• Concepts — tenants, entities, identifiers, billing units
• Catalog vs plans — what is shared in the catalog vs configured per plan
• Pricing — packages, bootstrap, plan extensions, Luau, MTU
• Plan extensions — groups, pools, JSON classify, stairstep, seats
• Luau pricing ctx — fields passed to pricing(ctx)
• Luau classify ctx — fields passed to classify(ctx)
• Subscriptions — lifecycle, plan change policies
• Usage & entitlements — metering, feature checks, StatsD
• Billing — adjustments, refunds, invoices
• Webhooks — outbound event notifications
• HTTP API — every endpoint and event type

New here? Start with Recipes or Quickstart.