Sign in
Contracts

Get a list of contracts

Retrieves a customer's contracts, fetched live from the connected billing provider, each enriched with a preview of its upcoming (next) invoice when available. Returns an empty list when no billing provider is connected or the customer is not synced.

get/api/v1/customers/{id}/contracts

Path parameters

idstring required

The external identifier of the customer the contract belongs to

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

The customer's contracts, each with its next-invoice preview when available.

Changes

Changed in 2 of the 115 revisions of this API.2