CancelNewSubscription

Overview

• Method: POST
• Endpoint: /api/CancelNewSubscription
• Description: Cancels a new subscription request. This endpoint is used to terminate an ongoing subscription activation request, optionally providing a reason for the cancellation.

POST /api/CancelNewSubscription
Content-Type: application/json
{
  "activationId": "###gxhI5###Zvz9Js",
  "note": "services not set"
}

---

Request Body Parameters

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

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

Info

You received the activationId in response to your NewSubscription request, but you can also retrieve it using the QueryActivation endpoint.

---

Response Structure

The response will contain the existing Activation object (from the NewSubscription that you are canceling) with the following structure:

{
    "id": "###gxhI5###Zvz9Js",
    "createdAt": "2025-01-30T15:57:19.93+01:00",
    "modifiedAt": "2025-01-30T18:06:32.7363195+01:00",
    "status": "CANCELLING",
    "activationType": "ACTIVATENEW",
    "providerEnvrionment": "SP16001",
    "referenceNumber": "Test ###",
    "providerOrderNumber": "03####0/2##5",
    "subscriptionId": "###mPuAf###WJmSPv",
    "info": {
        "simCardNumber": "89310836########76",
        "eSim": false,
        "subscriptionType": "VOICEDATA",
        "accessType": "INTERNETACCESS",
        "customerId": "###A1",
        "stnCustomerId": "###Sc3iA###MQCmA89",
        "wishDate": "2025-02-01T00:00:00+01:00"
    }
}

Field Descriptions

• id: The unique identifier for the activation request.
• createdAt: The timestamp when the activation request was created.
• modifiedAt: The timestamp when the activation request was last modified.
• status: The current status of the activation request. Possible values:
  • BUSY: The activation request is being processed.
  • DONE: The activation request has been successfully completed.
  • ERROR: The activation request has failed.
  • CANCELLING: The activation request is in the process of being canceled.
• activationType: The type of activation (e.g., ACTIVATENEW).
• providerEnvironment: The Envirionment where the sim is registered at the provider.
• providerOrderNumber: The ordernummer which the service provider assigned to this request.
• subscriptionId: The ID of the associated subscription.
• phoneNumber: The phone number associated with the activation request (if applicable).
• activatedDate: The date and time when the activation was completed (if applicable).
• info: Additional metadata related to the activation request.

Info

The response includes the updated status field, reflecting the cancellation request.

---

Usage Notes

• The activationId must correspond to an existing activation request.
• Use the note parameter to provide a detailed reason for the cancellation, if applicable.

---

Example Requests

Cancel a new subscription request with a note:

POST /api/CancelNewSubscription
Content-Type: application/json

{
  "activationId": "ACT12345",
  "note": "Customer requested to cancel the subscription."
}

Cancel a new subscription request without a note:

POST /api/CancelNewSubscription
Content-Type: application/json

{
  "activationId": "ACT54321"
}

---

Summary

The /api/CancelNewSubscription endpoint allows for canceling an active subscription request before it is completed.

• Requires an activationId to identify the subscription request.
• Optionally includes a cancellation note.
• Returns the updated activation status reflecting the cancellation process.

Use this API to efficiently manage subscription requests and handle cancellations as needed.