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.

Path Parameters

user_id
string
required

The ID of the user.

Query Parameters

filter[status]
enum<string>
Available options:
active,
pending,
expired,
draft,
terminated,
pending_termination
Example:

"active"

filter[name]
string
Example:

"some_name"

filter[current_period_end]
string
Example:

"2023-10-07T12:16:27+00:00"

include
enum<string>

A comma-separated list of relationships to include. Multiple parameters are allowed.

Available options:
discountCode,
currentPhase,
processingRenewalOrder
Example:

"discountCode"

sort
enum<string>

A comma-separated list of fields to sort. Multiple allowed. Prefix with - to sort descending.

Available options:
created_at
Example:

"created_at"

Response

200 - application/json
data
object[]
Example:
meta
object