Cancel (Asynchronous)

Description

Version:

v4

Use Cases

Scenario 1: Terminate all plans under a SIM card prematurely.

Scenario 2: Terminate a specific plan prematurely based on its order_id. (The order_id from the Add Plan API response).

Scenario 3: Terminate a specific plan via order_id and immediately activate the next available (chronologically) inactive plan (controlled by the keep_alive parameter).

Prerequisites

Only SIM cards belonging to the enterprise associated with the API key can be operated on.

Only non-OTA SIM cards are supported.

Business Rules

Scenario 1: When order_id is not provided:

If the SIM card is in an active state, a successful operation will prematurely terminate the current in-use plan (including top-up plans/data packs). The SIM card's final state will be "Suspended (Service Protection)".

If the SIM card is in a suspended state, a successful operation will prematurely terminate the suspended plan. The SIM card's final state will be "Suspended (Service Protection)".

For a SIM in any state, a successful operation will prematurely terminate any inactive plans.

Scenario 2: When order_id is provided:

Only the corresponding plan will be terminated.

Scenario 3: When order_id is provided and keep_alive is true:

Terminates the plan with the specified order_id.

If there is no active plan but there are inactive plans, the next available inactive plan will be activated.

Notes

The operation is processed asynchronously. A successful synchronous API response indicates that the Linke system has successfully received the request.

How to get the asynchronous processing result:

Use the request_id from the API response to query the result via the Query Asynchronous Processing Result endpoint.

Obtain the result via a notification API callback (pending).

Before the asynchronous operation is complete, the card will be in a locked state. During this time, operations such as activation, suspension, reactivation, or reset on the same SIM are prohibited.

The asynchronous process usually completes within a few seconds. However, if the carrier's system experiences network congestion or other exceptions, the processing time may extend to tens of minutes or even longer.

If the asynchronous operation fails, the user can retry the operation.

SDK API Call Method

Scenario 1: Cancel all plans. Minimum supported SDK version: 1.0.10

Scenario 2: Cancel a specific plan by order_id. Minimum supported SDK version: 1.0.13

Scenario 3: Cancel a specific plan by order_id and set the keep_alive parameter to true. Minimum supported SDK version: 1.0.14

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Description#

Version:#

Use Cases#

Prerequisites#

Business Rules#

Notes#

SDK API Call Method#

Request