v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Products

Lists all products

Returns sellable products and services for accounts receivable (contracts, invoices). Supports pagination and optional filters such as status and currency.

get/products

Query parameters

statusstring

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

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.

currencystring

Currency code following ISO-4217

Example:USD

Optional ISO currency code filter.

Response

OK

Example response

{
  "products": [
    {
      "name": "English subscription",
      "description": "Subscription to english classes",
      "price": {
        "amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "interval_months": 1
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "account_code": "11112"
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}