Skip to main content

OpenAPI reference

Explore endpoints, parameters, request bodies, response codes, and schemas in the visual API reference:

Open the interactive API reference

The interactive reference contains only public integration endpoints available through the production and sandbox /v1 hosts. See API hosts and surfaces for the boundary between public integrations, dashboard operations, and the hosted customer portal.

Machine-readable contract​

The public OpenAPI 3.1 contract contains only endpoints available through the production and sandbox /v1 hosts. Use this contract for SDK or client generation.

curl https://api.usagey.com/v1/openapi \
  --output usagey-openapi.json

The Download JSON action in the interactive reference returns this same public-only contract. Dashboard /api/billing/* and customer-portal /api/customer-portal/* routes are intentionally excluded because they require browser sessions on https://usagey.com.