Skip to main content
POST
Search 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.

Body

application/json
per_page
integer | null

Number of results per page. Must be at least 1. Must not be greater than 100.

Example:

10

page
integer | null

Page number for pagination. Must be at least 1.

Example:

1

sort
string | null

Sort by field. Prefix with - for descending order.

Example:

"-created_at"

include
string | null

Comma-separated list of relationships to include.

Example:

"discountCode,currentPhase,processingRenewalOrder"

filter
object | null

Object containing filter criteria.

Example:

Response

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