@radzor/usage-metering

Track and bill usage-based metrics. Record usage events against named meters, query usage summaries over time periods, and trigger threshold alerts for overage billing.

Paymentv0.1.0typescriptpythonServerusagemeteringbillingconsumptionpay-per-usesaasby Radzor

Install

View source on GitHub →

$npx radzor@latest add usage-metering

⚠ Constraints: In-memory storage is not persistent across restarts. For production, use 'stripe' backend with a valid Stripe secret key. Meters must be created before recording usage. Threshold events fire once per threshold crossing per period.

Inputs

Name	Type	Default	Description
secretKey	string	—	Stripe secret API key for reporting metered usage to Stripe Billing.STRIPE_SECRET_KEY
flushIntervalMs	number	60000	Interval in milliseconds for flushing batched usage records.
storageBackend	'memory' \| 'stripe'	memory	Where to store usage records. 'memory' for local tracking, 'stripe' to also report to Stripe Billing.

secretKeystring

Stripe secret API key for reporting metered usage to Stripe Billing.

STRIPE_SECRET_KEY

flushIntervalMsnumber

Interval in milliseconds for flushing batched usage records.

{ "llm": { "constraints": "In-memory storage is not persistent across restarts. For production, use 'stripe' backend with a valid Stripe secret key. Meters must be created before recording usage. Threshold events fire once per threshold crossing per period.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/usage-metering", "tags": [ "usage", "metering", "billing", "consumption", "pay-per-use", "saas" ], "events": [ { "name": "onThresholdReached", "payload": { "meterId": "string", "threshold": "number", "customerId": "string", "currentUsage": "number" }, "description": "Fired when a customer's usage crosses a configured threshold." } ], "inputs": [ { "name": "secretKey", "type": "string", "envVar": "STRIPE_SECRET_KEY", "required": false, "description": "Stripe secret API key for reporting metered usage to Stripe Billing." }, { "name": "flushIntervalMs", "type": "number", "default": 60000, "required": false, "description": "Interval in milliseconds for flushing batched usage records." }, { "name": "storageBackend", "type": "'memory' | 'stripe'", "default": "memory", "required": false, "description": "Where to store usage records. 'memory' for local tracking, 'stripe' to also report to Stripe Billing." } ], "radzor": "1.0.0", "actions": [ { "name": "recordUsage", "params": [ { "name": "customerId", "type": "string", "description": "Customer identifier." }, { "name": "meterId", "type": "string", "description": "Meter identifier to record usage against." }, { "name": "quantity", "type": "number", "default": 1, "required": false, "description": "Usage quantity to record." } ], "returns": "Promise<void>", "description": "Record a usage event against a meter for a customer." }, { "name": "getUsageSummary", "params": [ { "name": "customerId", "type": "string", "description": "Customer identifier." }, { "name": "meterId", "type": "string", "description": "Meter identifier." }, { "name": "periodStart", "type": "string", "required": false, "description": "Start of the period (ISO 8601 date string)." }, { "name": "periodEnd", "type": "string", "required": false, "description": "End of the period (ISO 8601 date string)." } ], "returns": "Promise<UsageSummary>", "description": "Get aggregated usage for a customer and meter over a time period." }, { "name": "createMeter", "params": [ { "name": "meterId", "type": "string", "description": "Unique meter identifier." }, { "name": "displayName", "type": "string", "description": "Human-readable meter name." }, { "name": "unit", "type": "string", "description": "Unit of measurement (e.g. 'api_calls', 'gb', 'tokens')." }, { "name": "threshold", "type": "number", "required": false, "description": "Usage threshold that triggers onThresholdReached." } ], "returns": "void", "description": "Create a named meter with optional threshold for alerts." } ], "outputs": [ { "name": "usageSummary", "type": "UsageSummary", "fields": [ { "name": "meterId", "type": "string", "description": "Meter identifier." }, { "name": "customerId", "type": "string", "description": "Customer identifier." }, { "name": "totalQuantity", "type": "number", "description": "Total usage quantity in the queried period." }, { "name": "periodStart", "type": "string", "description": "Start of the reporting period (ISO 8601)." }, { "name": "periodEnd", "type": "string", "description": "End of the reporting period (ISO 8601)." }, { "name": "recordCount", "type": "number", "description": "Number of individual usage records in the period." } ], "description": "Aggregated usage data for a customer and meter." } ], "runtime": "server", "version": "0.1.0", "category": "payment", "languages": [ "typescript", "python" ], "description": "Track and bill usage-based metrics. Record usage events against named meters, query usage summaries over time periods, and trigger threshold alerts for overage billing.", "dependencies": { "radzor": [], "packages": {} }, "composability": { "connectsTo": [ { "event": "onThresholdReached", "description": "Alert customer when usage threshold reached", "compatibleWith": [ "@radzor/email-send.action.send.message", "@radzor/notification-hub.action.send.body", "@radzor/slack-bot.action.sendMessage.text" ] }, { "output": "usageSummary", "mapField": "meterId", "compatibleWith": [ "@radzor/invoice-generator.action.addLineItem.description", "@radzor/csv-export.action.generate.data" ] } ] } }

@radzor/usage-metering

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json