API reference
Every endpoint, grouped by what it acts on. Each page shows a real request, a real response, and what each field means.
Build an integration, in order
These nine objects are the path a real customer walks. Start at the top.
- 1 Customers The people who use your product.
- 2 Billable metrics The named things you charge for.
- 3 Metering rules What one unit of a metric costs.
- 4 Plans What a customer can buy, and what it grants.
- 5 Subscriptions A customer on a plan, over time.
- 6 Entitlements Can this customer do this, right now?
- 7 Usage Record what a customer used.
- 8 Credits What a customer spends. QuotaStack tracks a balance for each one.
- 9 Webhooks QuotaStack sends you an event for each change. See the log, send a test, or retry one.
Everything else
Reservations
Hold credits while a long job runs.
Topups
A customer buys credits once. No subscription is involved.
Overrides
Change one customer without a new plan.
Imports
Move customers off your old system.
Audit log
QuotaStack writes every change to a log. No one can edit it.
Stats
QuotaStack adds up what customers used. See the totals here.
Account & provisioning
Sign up, get an API key, set your webhook URL, go live. Dashboard session, not your API key.
81 of 81 product operations documented in full. The account and provisioning calls are summarised on their own page rather than documented one by one.