MoveEnvironmentSubscription

Overview

Method: POST
Endpoint: /api/MoveEnvironmentSubscription
Description: The MoveEnvironmentSubscription endpoint allows you to transfer a subscription between environments of KPN. Specifically, this endpoint handles transfers between:
- SP16001: Regular environment
- SP16002: Unlimited environment

POST /api/MoveEnvironmentSubscription
{
    "subscriptionId": "string",
    "phoneNumber": "string",
    "newProviderEnvironment": "string",
    "wishDate": "SO 8601 datetime",
    "referenceNumber":"string"
}

Request Body Parameters

Parameter	Type	Required	Description
subscriptionId	String	No ^*1	The subscription ID associated with the subscription to be moved.
phoneNumber	String	No	The phone number associated with the subscription to be moved.
newProviderEnvironment	String	Yes	The target environment code to which the subscription will be moved. Valid values are "SP16001" (Regular) or "SP16002" (Unlimited).
wishDate	String	No	The requested date and time for the move to take effect, in ISO 8601 format (YYYY-MM-DDThh:mm:ss).
referenceNumber	String	No	A reference identifier for the move request, useful for tracking and identification purposes.

*1 Use either subscriptionId or phoneNumber.

Info

Moving a subscription is only allowed once every 2 months.

Response Structure

The response returns an Activation object with the following fields:

{
  "id": "string",
  "createdAt": "ISO 8601 datetime",
  "modifiedAt": "ISO 8601 datetime",
  "status": "string",
  "activationType": "string",
  "referenceNumber": "string",
  "subscriptionId": "string",
  "phoneNumber": "string",
  "activatedDate": "ISO 8601 datetime",
  "info": {}
}

Field Descriptions

Parameter	Type	Description
id	String	Unique identifier for the move request.
createdAt	String	Timestamp when the move request was created (ISO 8601 format).
modifiedAt	String	Timestamp when the move request was last modified (ISO 8601 format).
status	String	Current status of the move request (e.g., "PENDING", "COMPLETED", "FAILED").
activationType	String	Type of activation - will always be "MOVEENVIRONMENT" for this endpoint.
referenceNumber	String	The reference number provided in the request, echoed back in the response.
subscriptionId	String	The identifier of the subscription being moved.
phoneNumber	String	The phone number associated with the subscription, echoed back from the request.
activatedDate	String	The timestamp when the move was or will be activated (ISO 8601 format).
info	Object	Additional information related to the move request (can be empty).

Usage Notes

If wishDate is omitted, the subscription is move as soon as possible.

Example Requests

{
    "phoneNumber": "06-123456789",
    "newProviderEnvironment": "SP16002",
    "wishDate": "2025-05-21T12:00:00",
    "referenceNumber": "Move to unlimited"
}

Response:

{
    "id": "DLO0ZpqHCcA6MJmrH",
    "createdAt": "2025-05-19T07:15:06.875+02:00",
    "modifiedAt": "2025-05-02T16:15:09.831+02:00",
    "status": "INIT",
    "activationType": "MOVEENVIRONMENT",
    "providerEnvironment": "SP16002",
    "referenceNumber": "Move to unlimited",
    "subscriptionId": "6d80v6i4mI5Fidb3B",
    "phoneNumber": "06-123456789",
    "info": {
        "newProviderEnvironment": "SP16001",
        "wishDate": "2025-05-21T12:00:00"
    }
}