Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Draft Contracts

Lists all draft contracts

Returns draft contracts with cursor pagination. Draft contracts are staged records that appear in the Rillet UI under "Draft" for a human to approve or reject before they become active contracts.

get/draft-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

customer_idstring uuid

Optional UUID filter by customer.

Response

OK

Example response

{
  "draft_contracts": [
    {
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "items": [
        {
          "price": {
            "amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "interval_months": 1
          },
          "discount": {
            "amount_off": {
              "amount": "1.01",
              "currency": "USD"
            }
          }
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}