a2ab794dd5f2
Lists all contracts
Returns contracts with pagination and rich filters (subsidiary, customer, status, date ranges). Use this to discover contract ids, check lifecycle state, or drive reporting extracts.
Query parameters
Maximum number of rows to return in the page.
If defined, a cursor to retrieve the next page.
Pagination cursor to navigate through the full response.
Subsidiary to be used when filtering data
Optional status filter (allowed values depend on the resource).
Minimum start date value to filter by (exclusive)
Minimum start date value to filter by (inclusive)
Maximum start date value to filter by (exclusive)
Maximum start date value to filter by (inclusive)
Minimum end date value to filter by (exclusive)
Minimum end date value to filter by (inclusive)
Maximum end date value to filter by (exclusive)
Maximum end date value to filter by (inclusive)
Optional UUID filter by customer.
Response
OK
Example response
{
"contracts": [
{
"name": "New API Contract",
"items": [
{
"price": {
"amount": {
"amount": "1.01",
"currency": "USD"
},
"interval_months": 1
},
"quantity": 1,
"total_value": {
"amount": "1.01",
"currency": "USD"
},
"discount": {
"amount_off": {
"amount": "1.01",
"currency": "USD"
}
},
"tax_rate": {
"tax_amount": {
"amount": "1.01",
"currency": "USD"
},
"country": "US"
},
"external_references": [
{
"type": "xyzSystemId",
"id": "234",
"url": "https://xyzsystempage.com/ids/234"
}
],
"usage_minimum_commitment": {
"amount": {
"amount": "1.01",
"currency": "USD"
},
"revenue_account": "11112"
}
}
],
"invoicing": {
"day": 1
},
"usage_configuration": {
"contract_level_minimum_commitment": {
"amount": {
"amount": "1.01",
"currency": "USD"
},
"revenue_account": "11112"
}
},
"total_value": {
"amount": "1.01",
"currency": "USD"
},
"external_references": [
{
"type": "xyzSystemId",
"id": "234",
"url": "https://xyzsystempage.com/ids/234"
}
],
"exchange_rate": {
"base": "USD",
"target": "USD"
}
}
],
"pagination": {
"next_cursor": "iLQvkEj3sh3UiweC"
}
}