API reference

Create a one-time invoice. Returns a hosted, non-custodial checkout_url to send the customer; no money moves until they pay, then an invoice.paid webhook fires.

List invoices, newest first. Standard list envelope with cursor pagination.

Create a subscription plan (product + price + platform-signed on-chain plan). Returns a hosted checkout_url for subscribers; the first successful charge fires subscription.active. Minimum price is 1.00 USDC. Plans are create-only; there is no GET /v1/plans yet.

List confirmed on-chain payments, newest first.

List subscriptions, newest first.

List the event feed backing your webhooks, newest first. Poll it or reconcile deliveries against it. Event types are listed in Webhooks and events.

Create a meter — the named thing usage is recorded against. Its key is the event_name you send events with. Idempotent by key (a repeat returns the existing meter). Create a meter before a metered plan or a metered feature can reference it.

Create a feature — a capability you gate with entitlements. boolean (has it or not) or metered (has it, up to an allowance enforced against a meter). Idempotent by key. Create a feature before granting or checking it.

List your usage meters, newest first. Standard list envelope.

Ingest usage: one event, or a batch of up to 500 as { "events": [...] }. Idempotent per idempotency_key (a body field per event, or an Idempotency-Key header for single events): retrying with the same key returns 200 with deduplicated: true instead of double-counting. The meter must exist first, or you get 404 unknown_meter. Rate limit: 600 requests/min.

Top up a customer's prepaid credit balance. One of customer_id / external_customer_id is required (400 customer_required otherwise). Emits a credit.granted event.

Draw down a customer's prepaid credits for usage. By default the debit covers only what the balance allows and returns the remainder as shortfall for you to bill separately; pass allow_negative: true to let the balance go below zero instead. The customer must already have a credit account (404 no_credit_account otherwise). Emits a credit.debited event. Rate limit: 120 requests/min.

The customer's current prepaid balance plus ledger totals. A customer with no credit account returns a plain zero balance. Rate limit: 240 requests/min.

Grant a feature to a customer, optionally with a usage limit and an expiry. The feature must exist (404 unknown_feature), and one of customer_id / external_customer_id is required. Emits an entitlement.granted event.

The access-control check your backend calls before serving a feature answers two questions: is this customer entitled right now, and for metered features, how much of the limit remains? reason is one of active, grace, no_grant, not_started, revoked, expired, limit_exceeded. Built for the hot path: 600 requests/min.