Payrexx Octri Demo
GET/Subscription/

List subscriptions

Lists subscription records with their contact, invoice, status, and start and end information. Use limit and offset to control the result range, and orderByStartDate to sort by start date.

3 body fields

Subscription list options for controlling the result range and sort order.

limitintegeroptional
Max row count
Default:10
offsetintegeroptional
Row count to be used as offset
Default:0
orderByStartDatestringoptional
ASC (ascending) or DESC (descending) for ordering by start date of the transaction
Allowed:ASCDESCDefault:ASC

3 status codes
200Returns an object containing a `data` array of subscription records and a `status` field.
dataarray<object>optional
statusstringoptional
400Returned when a request value is invalid.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional
404Returned when no matching subscriptions are found.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

orderByStartDate must be ASC or DESC; invalid request values return a 400. A 404 is returned when no matching subscriptions are found.