Products

Lists the products of your account, newest first, one page at a time.

To get the next page, send the nextCursor of the response as cursor. When there are no more items, the response has no nextCursor. The last page can still carry one, and the next call then returns no items.

A product you just created can take a moment to appear in the list. Get Product returns it at once.

get/products

Request

Query parameters

limitinteger

Number of items in one page, from 1 to 100.

cursorstring

The nextCursor of the previous page. Omit it to get the first page.

Response

One page of products, newest first

nextCursorstring

Pass this value as cursor to get the next page. Absent when there are no more items. The last page can still carry it, and the next call then returns no items.

Example response

{
  "items": [
    {
      "id": "8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60",
      "name": "Gold plan",
      "description": "Unlimited access to every course",
      "images": [
        "https://example.com/images/gold-plan.png"
      ],
      "slug": "gold-plan",
      "unitLabel": "seat",
      "descriptor": "MONEI GOLD",
      "defaultPriceId": "3c5a1f8e-2b7d-4e9a-9c41-7d2e6b0f5a13",
      "active": true,
      "metadata": {
        "systemId": "12345"
      },
      "createdAt": 1636366897,
      "updatedAt": 1636366897
    }
  ],
  "nextCursor": "eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ"
}

Changes