Skip to main content

​
Requests and responses

Nozle APIs use JSON request and response bodies. Send:
Timestamps use ISO 8601 UTC strings. Monetary amounts use integer minor units, such as cents, unless an endpoint explicitly documents a decimal string.

​
Pagination

Collection endpoints use page and per_page query parameters. Paginated responses include metadata with the current page, adjacent pages, total pages, and total record count.

​
External identifiers

Prefer stable external identifiers from your own system when an endpoint accepts them. They make reconciliation easier and prevent your application from depending on database-generated UUIDs.

​
Idempotency and retries

For metered events and credit operations, generate a unique transaction or idempotency identifier and reuse it when retrying the same logical operation. Do not generate a new identifier after a timeout unless you intend to create a second operation. Retry transient network failures and HTTP 429 or 5xx responses with exponential backoff and jitter. Do not automatically retry validation or authorization failures.

​
Errors

Use the HTTP status code as the primary error category and log the response body for diagnosis. Common statuses include: See Errors for retry guidance and application-safe handling.

​
Compatibility names

Some inherited response properties and webhook headers retain compatibility names from the underlying billing contract. Use the exact names displayed in the generated endpoint schemas; they remain stable even when the product-facing terminology differs.