---
title: "API reference"
description: "Every QuotaStack endpoint, grouped by what it acts on."
---

# API reference

Every endpoint, grouped by what it acts on. Each object page shows a real request, a real response, and what each field means — the same content its HTML twin shows, as markdown.

## Build an integration, in order

These nine objects are the path a real customer walks, in order. If you are wiring up QuotaStack for the first time, read them top to bottom rather than alphabetically — that is also why this list is not sorted by name.

- [Customers](/docs/api/customers.md) — The people who use your product. (8/8 operations documented in full.)
- [Billable metrics](/docs/api/billable-metrics.md) — The named things you charge for. (4/4 operations documented in full.)
- [Metering rules](/docs/api/metering-rules.md) — What one unit of a metric costs. (2/2 operations documented in full.)
- [Plans](/docs/api/plans.md) — What a customer can buy, and what it grants. (14/14 operations documented in full.)
- [Subscriptions](/docs/api/subscriptions.md) — A customer on a plan, over time. (10/10 operations documented in full.)
- [Entitlements](/docs/api/entitlements.md) — Can this customer do this, right now? (10/10 operations documented in full.)
- [Usage](/docs/api/usage.md) — Record what a customer used. (2/2 operations documented in full.)
- [Credits](/docs/api/credits.md) — What a customer spends. QuotaStack tracks a balance for each one. (10/10 operations documented in full.)
- [Webhooks](/docs/api/webhooks.md) — QuotaStack sends you an event for each change. See the log, send a test, or retry one. (3/3 operations documented in full.)

## Everything else

Objects outside the main integration path — used less often, or only once, during setup.

- [Reservations](/docs/api/reservations.md) — Hold credits while a long job runs. (6/6 operations documented in full.)
- [Topups](/docs/api/topups.md) — A customer buys credits once. No [subscription](/docs/concepts/subscriptions) is involved. (6/6 operations documented in full.)
- [Overrides](/docs/api/overrides.md) — Change one customer without a new plan. (4/4 operations documented in full.)
- [Imports](/docs/api/imports.md) — Move customers off your old system. (1/1 operations documented in full.)
- [Audit log](/docs/api/audit-log.md) — QuotaStack writes every change to a log. No one can edit it. (1/1 operations documented in full.)
- [Stats](/docs/api/stats.md) — QuotaStack adds up what customers used. See the totals here. (1/1 operations documented in full.)
- [Account & provisioning](/docs/api/account.md) — Sign up, get an API key, set your [webhook](/docs/concepts/webhooks) URL, go live. Dashboard session, not your API key. (0/14 operations documented in full.)

## Also here

- [Errors](/docs/api/errors.md) — every error QuotaStack returns, why, and how to fix it.
- [Events](/docs/api/events.md) — every webhook QuotaStack sends, and when it does not.
- [openapi.yaml](/openapi.yaml) — the machine-readable spec. Use this for type-correct integrations.
- [API Explorer](/docs/api/explorer) — an interactive, authenticated try-it surface over the raw spec. HTML only, not useful to fetch as markdown.

82 of 96 operations documented in full. The rest show their generated field tables — the same tables the explorer shows, fetched as markdown instead of rendered as HTML.