CancelTerminateSubscription

Overview

• Method: POST
• Endpoint: /api/CancelTerminateSubscription
• Description: Cancels an ongoing subscription termination request. This endpoint allows stopping a termination process and optionally providing a reason for the cancellation.

POST /api/CancelTerminateSubscription
Content-Type: application/json
{
  "id": "###eP7ds###WQJoIE",
  "note": "Customer decided to retain the subscription."
}

---

Request Body Parameters

The request body should be a JSON object with the following structure:

• activationId (string, required): Identifier of the termination request to cancel.
• note (string, optional, max 164 characters): Additional information or reason for the cancellation.

Info

The activationId is the id received in the response of the TerminateSubscription request.

---

Response Structure

The response will include details about the cancelled termination request:

{
    "id": "###rPVb5###27v8e7",
    "createdAt": "2025-02-10T14:31:26.101+01:00",
    "modifiedAt": "2025-02-10T14:45:07.9191095+01:00",
    "status": "BUSY",
    "activationType": "TERMINATE",
    "providerEnvironment": "SP16001",
    "referenceNumber": "Test ###",
    "subscriptionId": "###3Vp17###7Xg79e",
    "phoneNumber": "06-######969",
    "info": {
        "wishDate": "2025-04-01T10:01:01+02:00"
    }
}

Field Descriptions

• id: The unique identifier for the activation request.
• createdAt: The timestamp when the cancellation request was created.
• modifiedAt: The timestamp of the last modification.
• status: The current status of the cancellation request:
  • BUSY: The request is being processed.
  • DONE: The cancellation was successfully completed.
  • ERROR: The request failed.
• activationType: The type of activation, always TERMINATE for this request.
• providerEnvironment: The Envirionment where the sim is registered at the provider.
• subscriptionId: The ID of the subscription being terminated.
• phoneNumber: The phone number associated with the termination request.
• activatedDate: The timestamp when the cancellation process was completed.
• info: Additional metadata regarding the cancellation.

Info

Optional fields will only be included in the response if they were provided in the request.

---

Usage Notes

• The activationId parameter is mandatory and must correspond to an active termination request.
• Use the note parameter to provide additional context or the reason for cancellation, if applicable.
• Store the response id to track the cancellation request.

---

Example Requests

Cancel a termination request with a reason

POST /api/CancelTerminateSubscription
Content-Type: application/json
{
  "id": "###eP7ds###WQJoIE",
  "note": "Customer decided to retain the subscription."
}

Cancel a termination request without a note

POST /api/CancelTerminateSubscription
Content-Type: application/json
{
  "id": "###eP7ds###WQJoIE"
}

---

Summary

The /api/CancelTerminateSubscription endpoint allows canceling an active subscription termination request.

• Requires activationId to identify the request.
• Optionally includes a note for tracking purposes.
• Returns a tracking id to monitor cancellation status via QueryActivation.

Use this API to efficiently manage and track termination cancellations.