Skip to main content
POST

Authorizations

Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Body

application/json
page
integer | null
default:1
Required range: x >= 1
per_page
integer | null
default:20
Required range: 1 <= x <= 1000
sort
enum<string> | null
default:subscriptions.createdAt
Available options:
customers.email,
customers.fullName,
subscriptions.status,
subscriptions.price,
subscriptions.createdAt,
subscriptions.billing_period,
subscriptions.nextBillingDate,
subscriptions.processorName,
paymentType
sort_order
enum<string> | null
default:desc
Available options:
asc,
desc
filters
object

Response

Successful response

items
object[]
required
pagination
object
required