get http://{{url}}/v1/subscriptions
Returns all subscriptions for the account
Request query params
Pagination
| field | required [flow] | type | description |
|---|---|---|---|
| skip | - | number | A pagination parameter to skip the first N subscriptions from the list, default = 0 |
| limit | - | number | A pagination parameter to limit the output to N, default = 100, maximum value = 1000 |
| sortkey | - | string | A sorting key parameter, i.e. created_at |
| sortdirection | - | string | A sorting order direction parameter ASC or DESC (DESC by default) |
Filters
| field | required [flow] | type | description |
|---|---|---|---|
| gateway_id | - | string (24 hex characters) | An ID of a gateway used for creating a subscription |
| customer_id | - | string (24 hex characters) | An ID of a customer for whom a subscription was created |
| status | - | string | See Status table |
Other
| field | required [flow] | type | description |
|---|---|---|---|
| search | - | string | A word or phrase used for searching created subscriptions (search works by fields: First Name, Last Name and Email) |