Features

This chapter covers the core features and capabilities of Usage Metering.

Features

• Event recording — Track any metric (API calls, storage, compute, custom)
• Quota enforcement — Per-plan limits with configurable overage policies
• Idempotency — Dedup protection prevents double-counting on retries
• Usage summaries — Aggregate by tenant, metric, and billing period
• Billing reports — Generate billing-ready reports with overage calculations
• Top users — Identify heaviest users within a tenant
• Batch recording — Record multiple events in one call
• Plan management — Define usage plans with per-metric quotas

Requirements

• Python 3.10+
• No external dependencies (stdlib only)

Quick Start

Follow this guide to get Usage Metering up and running in your environment.

Quick Start

python src/main.py --init-demo

# Record usage
curl -X POST http://localhost:8005/api/events \
  -H "Content-Type: application/json" \
  -d '{"tenant_id": "tenant_acme", "metric": "api_calls", "quantity": 1, "user_id": "user_1"}'

# Check usage
curl http://localhost:8005/api/usage/tenant_acme/api_calls

# Check quota
curl http://localhost:8005/api/quota/tenant_acme/api_calls

# Generate billing report
curl -X POST http://localhost:8005/api/billing-report \
  -H "Content-Type: application/json" \
  -d '{"tenant_id": "tenant_acme"}'

API Endpoints