Skip to main content
GET
/
subscriptions
Error
A valid request URL is required to generate request examples
[
  {
    "subscriptionId": "68bbe3343faf938adbc22ba8",
    "externalUserId": "abcd123",
    "planCode": "68b74fd80e51671c21e46913",
    "startDate": "2025-09-06T07:31:00.000Z",
    "endDate": "2025-10-06T07:31:00.000Z",
    "device": "android_phone",
    "status": "completed"
  },
  {
    "subscriptionId": "68bbe61d3faf938adbc22bb6",
    "externalUserId": "efgh123",
    "planCode": "68b74fd80e51671c21e46913",
    "startDate": "2025-09-03T11:30:00.000Z",
    "endDate": "2025-12-02T11:30:00.000Z",
    "device": "jio_stb",
    "status": "completed"
  }
]

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