SuspendSubscription

Overview

Method: POST
Endpoint: /api/SuspendSubscription
Description: Suspends a SIM card and phone number for all traffic.

POST /api/SuspendSubscription
Content-Type: application/json
{
  "subscriptionId": "###3Vp17###7Xg79e",
  "referenceNumber": "Simcard gotlost"
}

Request Body Parameters

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

subscriptionId (string, required if phoneNumber is not provided): Identifier for the subscription to suspend.
phoneNumber (string, required if subscriptionId is not provided): Phone number of the subscription to suspend.
referenceNumber (string, optional, max 15 characters): Reference number for tracking the suspension request.

Info

At least one of the fields subscriptionId or phoneNumber must be provided to identify the subscription to be suspended.

Response Structure

The response returns an Activation object containing the details of the suspension request:

{
    "id": "###giDOB###Vk5P1p",
    "createdAt": "2025-01-31T17:14:22.2765425+01:00",
    "modifiedAt": "2025-01-31T17:14:22.2765425+01:00",
    "status": "INIT",
    "activationType": "SUSPEND",
    "providerEnvironment": "SP16001",
    "referenceNumber": "Simcard ###",
    "providerOrderNumber": "03####0/2##5",
    "subscriptionId": "###3Vp17###7Xg79e",
    "phoneNumber": "06-######969",
    "info": {}
}

Field Descriptions

id: A unique identifier for the suspension request.
createdAt: The timestamp when the suspension request was created.
modifiedAt: The timestamp of the last modification to the request.
status: The current status of the suspension request:
- BUSY: The request is being processed.
- DONE: The suspension has been successfully completed.
- ERROR: The suspension request has failed.
activationType: The type of activation (SUSPEND for this request).
providerOrderNumber: The ordernummer which the service provider assigned to this request.
subscriptionId: The ID of the suspended subscription.
phoneNumber: The phone number of the suspended subscription.
referenceNumber: The reference number provided for tracking.
info: Additional metadata related to the suspension request.

Info

Only optional fields included in the request will appear in the response.

Usage Notes

This endpoint is used to suspend all traffic for a specific SIM card and phone number.
You must provide either subscriptionId or phoneNumber to identify the subscription to suspend.
The referenceNumber can be used for internal tracking.
The response includes a unique id for tracking the suspension request.
Check the info field for additional details or error messages.

Querying Suspension Status

To track the status of the suspension request, use the QueryActivation API until the status field is set to DONE or ERROR.

GET /api/QueryActivation?Id=###giDOB###Vk5P1p

Example Response:

{
    "offset": 0,
    "total": 70,
    "results": [
        {
            "id": "###giDOB###Vk5P1p",
            "createdAt": "2025-01-31T17:14:22.276+01:00",
            "modifiedAt": "2025-01-31T17:17:40.329+01:00",
            "status": "DONE",
            "activationType": "SUSPEND",
            "providerEnvironment": "SP16001",
            "referenceNumber": "Simcard gotlost",
            "providerOrderNumber": "03####0/2##5",
            "subscriptionId": "###3Vp17###7Xg79e",
            "phoneNumber": "06-######969",
            "activatedDate": "2025-01-31T18:15:14+01:00",
            "info": {}
        }
    ],
    "meta": {}
}

Summary

The /api/SuspendSubscription endpoint allows you to temporarily suspend a subscription, preventing all traffic for a SIM card and phone number.

Requires either a subscriptionId or phoneNumber to identify the subscription.
Returns a unique id for tracking.
The suspension status can be queried using QueryActivation.

Use this API to efficiently manage temporary service suspensions.