v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Subscriptions

List Subscriptions

get/api/v1/subscriptions/

Query parameters

customerinteger
pageinteger

A page number within the paginated result set.

planinteger
record_idstring

ID

referencestring
status'ACTIVE' | 'CANCELED' | 'COMPLETE' | 'FAILED' | 'PENDING'
  • PENDING - PENDING
  • ACTIVE - ACTIVE
  • CANCELED - CANCELED
  • COMPLETE - COMPLETE
  • FAILED - FAILED
updated_at_afterstring date
updated_at_beforestring date

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}