RIrillet
Products

Lists all products

Changed on

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

get/products

Request

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.

typeProductType[]

Optional product type filter.

Response

OK

Example response

{
  "products": [
    {
      "name": "English subscription",
      "description": "Subscription to english classes",
      "price": {
        "amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "interval_months": 1
      },
      "progress_plan_template": {
        "milestones": [
          {
            "key": "design-approved",
            "name": "Design approved",
            "sequence": 1,
            "value": "30",
            "expected_offset": {
              "count": 1,
              "unit": "MONTHS"
            }
          }
        ]
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "account_code": "11112",
      "bundle": {
        "components": [
          {
            "quantity": "1"
          }
        ]
      }
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes

  • c393d0102005Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      added the new optional query request parameter type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      removed the DAILY enum value from the // response property for the response status

    • info

      removed the EVEN_PERIOD enum value from the // response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status