Orders API
The Orders API enables enterprise and compliance customers to manage their subscriptions independently. It supports key operations such as provisioning new subscriptions, swapping physical xSIMs with eSIMs, and suspending or resuming services. This allows our customers to self-serve without relying on support teams, increasing speed and agility across their organizations.
Supported Actions
-
Creates a new subscription by assigning an eSIM profile to a designated user. This operation supports template-based provisioning, allowing predefined service bundles (e.g., data, voice, SMS, call recording) to be assigned via a template ID.
Use Case: Activating a new line for an employee or service endpoint.
-
This operation allows transitions between existing xSIM subscriptions to eSIMs, assigning a new ICCID while retaining the original service configuration. The original xSIM remains active until the eSIM is successfully installed, ensuring service continuity during the change process.
Use Case: The user now has a device compatible with eSIM technology and needs to switch from a physical SIM to an eSIM.
-
Temporarily disables a subscription without terminating it. The xSIM remains assigned but cannot be used until resumed. Commonly used during leaves of absence or device loss.
Use Case: Pause services during employee sabbaticals or pending investigations.
-
Reactivates a previously suspended subscription restoring all services prior to the suspension.
Use Case: Resume service after an employee returns from leave or a lost device is recovered.