Skip to main content
GET
List subscriptions

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).

customer
string
status
enum<string>
Available options:
active,
paused,
cancelled,
finalized,
needs_attention
next_billing
string<date>
date_start
string<date>
document
integer
lines
string

Filter by linked line ID.

addons
integer
coupon
string
cancelled
string<date-time>
cancel_reason
string
paused
string<date-time>
paused_reason
string
needs_attention
string<date-time>
needs_attention_reason
string
instant
boolean

Compute on-the-fly billing for the response.

Response

200 - application/json

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