Skip to main content
GET
/
addons
List addons
curl --request GET \
  --url https://api.piriod.com/addons/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'
{
  "count": 142,
  "results": [
    {
      "name": "<string>",
      "description": "<string>",
      "currency": "<string>",
      "amount": 123,
      "id": "<string>",
      "sku": "<string>",
      "apply_scheme": "one_time",
      "duration_times": 123,
      "unit_label": "<string>",
      "status": "active",
      "archived": "2023-11-07T05:31:56Z",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

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
​
apply_scheme
enum<string>
Available options:
one_time,
recurring
​
amount
number
​
currency
string

Response

200 - application/json

Paginated addon 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.