Skip to main content
POST
/
subscriptions
curl --request POST \
  --url {scheme}://{domain}/api/v1/aggregator/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "externalUserId": "abcd123",
  "planCode": "68b74fd80e51671c21e46913",
  "startDate": "2025-09-03T11:30:00.000Z",
  "endDate": "2025-12-02T11:30:00.000Z",
  "device": "android_phone"
}
'
{
  "subscriptionId": "sub_01J8Z3Z2Y6M3X4",
  "externalUserId": "aysgte536d8sgh",
  "planCode": "configuredPlanCode",
  "startDate": "2020-09-04T11:23:42.958Z",
  "endDate": "2020-10-04T11:22:23.958Z",
  "device": "android_phone",
  "status": "completed"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
externalUserId
string
required

Aggregator's user identifier (stable across calls).

​
planCode
string
required

AscendOTT planCode to subscribe to.

​
startDate
string<date-time>

UTC ISO8601. Optional. Defaults to current date/time.

​
endDate
string<date-time>

UTC ISO8601. Optional. Defaults to plan duration.

​
device
enum<string>
default:web_browser

Origin device of the purchase. Optional.

Available options:
web_browser,
android_phone,
ios_phone,
android_tablet,
ios_tablet,
android_tv,
smart_tv,
roku,
fire_tv,
apple_tv,
jio_stb,
other

Response

Created

​
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