Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.piriod.com/products/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'
{
  "count": 142,
  "results": [
    {
      "name": "<string>",
      "unit_label": "<string>",
      "id": "<string>",
      "status": "active",
      "archived": "2023-11-07T05:31:56Z",
      "plans": [
        {
          "product": "<string>",
          "name": "<string>",
          "description": "<string>",
          "frequency": "<string>",
          "currency": "<string>",
          "amount": 123,
          "id": "<string>",
          "sku": "<string>",
          "exempt": false,
          "usage_scheme": "licensed",
          "usage_aggregation": "last_record",
          "tiers_mode": "package",
          "tiers": [
            {
              "amount": 123,
              "quantity_from": 123,
              "amount_scheme": "flat",
              "quantity_to": 123,
              "unit_scheme": "all_units"
            }
          ],
          "unit_label": "<string>",
          "status": "active",
          "archived": "2023-11-07T05:31:56Z",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z"
        }
      ],
      "test_mode": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://piriod-d406ac55.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Query Parameters

page
integer
default:1

Page number to retrieve (1-indexed).

Required range: x >= 1
page_size
integer
default:20

Number of items per page.

Required range: 1 <= x <= 100
ordering
string

Field to sort results by. Prefix with - for descending order (e.g. -created).

name
string
plans
string

Response

200 - application/json

Paginated product list.

count
integer
required

Total number of items matching the filter.

Example:

142

results
object[]
required

The items in the current page.

next
string<uri> | null

URL of the next page, or null if last page.

previous
string<uri> | null

URL of the previous page, or null if first page.