Skip to main content
GET
List Subscriptions

Authorizations

x-api-key
string
header
required

Query Parameters

externalUserId
string

Filter by aggregator's user identifier. If provided (and subscriptionId is not), the response is an array.

subscriptionId
string

Returns a single subscription by its ID. If provided, it takes precedence over externalUserId.

Response

OK

subscriptionId
string
required
externalUserId
string
required
planCode
string
required
startDate
string<date-time>
required
endDate
string<date-time>
required
status
enum<string>
required
Available options:
completed,
pending,
cancelled,
expired
device
enum<string>
Available options:
web_browser,
android_phone,
ios_phone,
android_tablet,
ios_tablet,
android_tv,
smart_tv,
roku,
fire_tv,
apple_tv,
jio_stb,
other