v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Billing

List subscriptions

get/subscriptions/

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

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

customerstring

status'active' | 'paused' | 'cancelled' | 'finalized' | 'needs_attention'

next_billingstring date

date_startstring date

documentinteger

linesstring

Filter by linked line ID.

addonsinteger

couponstring

cancelledstring date-time

cancel_reasonstring

pausedstring date-time

paused_reasonstring

needs_attentionstring date-time

needs_attention_reasonstring

instantboolean

Compute on-the-fly billing for the response.

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

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

Paginated subscription list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

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

previousstring uri nullable

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

{
  "count": 142
}