v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB

Contracts

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.

get/contracts

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

subsidiary_idstring uuid

Subsidiary to be used when filtering data

status'ACTIVE' | 'IN_EFFECT' | 'CANCELLED' | 'ENDED' | 'AMENDED'

Optional status filter (allowed values depend on the resource).

start_date.gtstring date

Minimum start date value to filter by (exclusive)

start_date.gtestring date

Minimum start date value to filter by (inclusive)

start_date.ltstring date

Maximum start date value to filter by (exclusive)

start_date.ltestring date

Maximum start date value to filter by (inclusive)

end_date.gtstring date

Minimum end date value to filter by (exclusive)

end_date.gtestring date

Minimum end date value to filter by (inclusive)

end_date.ltstring date

Maximum end date value to filter by (exclusive)

end_date.ltestring date

Maximum end date value to filter by (inclusive)

customer_idstring uuid

Optional UUID filter by customer.

Response

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"
  }
}