Skip to main content
GET
List subscriptions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
string

Filter by customer ID or alias

plan_id
string<MeteroidId>
Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

statuses
enum<string>[]
Available options:
PENDING_ACTIVATION,
PENDING_CHARGE,
TRIAL_ACTIVE,
ACTIVE,
TRIAL_EXPIRED,
PAUSED,
SUSPENDED,
CANCELLED,
ABORTED,
COMPLETED,
SUPERSEDED,
ERRORED
order_by
string

Sort order. Format: column.direction. Allowed columns: customer_name, plan_name, mrr_cents, billing_start_date, end_date, status, created_at. Direction: asc or desc. Default: created_at.desc.

page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of subscriptions

data
object[]
required
pagination_meta
object
required