Skip to main content
DELETE
/
subscriptions
Delete Subscription
curl --request DELETE \
  --url {scheme}://{domain}/api/v1/aggregator/subscriptions \
  --header 'x-api-key: <api-key>'
{
  "subscriptionId": "68bbe3343faf938adbc22ba8",
  "externalUserId": "abcd123",
  "planCode": "68b74fd80e51671c21e46913",
  "startDate": "2025-09-06T07:31:00.000Z",
  "endDate": "2025-10-06T07:31:00.000Z",
  "status": "cancelled"
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
subscriptionId
string
required

The subscriptionId to cancel.

Response

Deleted (cancelled) successfully

​
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