Skip to Content

Cancel subscription

POST /Http/Services/CancelSubscription.aspx

Cancels a subscription on the partner’s initiative. The subscription is identified by SubscriptionID, or Subscriber_MSISDN, or SubscriberID.

Request body

FieldTypeRequiredDescription
NowstringyesCurrent UTC time in yyyyMMddHHmmss format.
SignaturestringyesRequest signature: LOWERCASE(HMACSHA256(SecretKey, SubscriptionProjectID + Now)).
SubscriptionProjectIDinteger (int32)yesSubscription project ID.
SubscriptionIDinteger (int64)—Subscription ID. Pass one of SubscriptionID, Subscriber_MSISDN or SubscriberID.
Subscriber_MSISDNstring—Subscriber MSISDN. Pass one of SubscriptionID, Subscriber_MSISDN or SubscriberID.
SubscriberIDinteger (int64)—Unique subscriber ID in the System. Pass one of SubscriptionID, Subscriber_MSISDN or SubscriberID.
SendSmsNotificationstring—Optional, default true. If true, the user gets an SMS about the cancellation (no more than once).
ClientIPstring—IP address of the user who initiates the request.

Response codes

CodeDescription
200Result in StatusName
500Internal platform error