Skip to main content
POST
List customer contracts (v2)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Customer ID and optional filters

customer_id
string<uuid>
required
include_ledgers
boolean

Include commit/credit ledgers in the response. Setting this flag may cause the response to be slower.

include_archived
boolean

Include archived contracts in the response.

include_balance
boolean

Include the balance of credits and commits in the response. Setting this flag may cause the response to be slower.

starting_at
string<date-time>

Optional RFC 3339 timestamp. Only include contracts that started on or after this date. This cannot be provided if covering_date filter is provided.

covering_date
string<date-time>

Optional RFC 3339 timestamp. Only include contracts active on the provided date. This cannot be provided if starting_at filter is provided.

limit
number

Max number of contracts to return per page. Range: 1-20. Default: 20.

Required range: x >= 1
cursor
string

Cursor from a previous response to fetch the next page of contracts.

Response

Success

data
object[]
required
cursor
string | null

Pass this value as cursor in a subsequent request to fetch the next page of contracts. Null if there are no more contracts.