Skip to main content

Overview

The Orders API together with Order Templates API enables enterprise and compliance customers to self-provision and manage subscriptions independently. It supports key operations such as provisioning new subscriptions, swapping physical xSIMs with eSIMs, and suspending or resuming services.

Supported Actions​

  1. Retrieve Available Provisioning Templates (Order Templates API)

    Returns the list of provisioning templates available. Each template includes predefined service bundles with associated products and configurations, ready to be used for subscription activation.

  2. Provision a New eSIM (Orders API)

    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.

  3. Replace a xSIM (Orders API)

    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.

  4. Suspend Subscription (Orders API)

    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.

  5. Resume Subscription (Orders API)

    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.