Skip to main content
GET
List subscriptions

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer
default:20

Rows per page. Values above 100 are rejected.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response's pagination.nextCursor. Omit for the first page.

status

Filter by status.

Available options:
ACTIVE,
FAILING,
PAUSED,
CANCELLED,
COMPLETED
billingPeriod
enum<string>

Filter by billing period.

Available options:
WEEKLY,
BIWEEKLY,
MONTHLY,
QUARTERLY,
SEMIANNUAL,
YEARLY
createdAtFrom
string<date-time>

Inclusive lower bound.

createdAtTo
string<date-time>

Inclusive upper bound.

Response

Success.

data
object[]
required
pagination
object
required