v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Contract Items

Lists all contract item usage records

Returns historical usage quantities for a contract item, newest first, with optional pagination cursors. Use before upsert-a-usage-record or delete-a-usage-record to understand existing coverage for each date.

get/contract-items/{contract_item_id}/usage

Path parameters

contract_item_idstring required

UUID of the contract line item whose usage rows are being listed.

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.

Response

OK

Example response

{
  "usage": [
    {
      "quantity": 1
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}