v1

latestOpenAPI 3.0.22026-07-24184452.0 KB
Assets

Update Asset

Update details of a specific asset by its serial number, UUID, SIM SID, or SIM ICCID.

<div style="background-color: rgba(0, 123, 255, 0.1); border-left: 5px solid #007bff; padding: 10px;"> Updating the top-level <b>status</b> field acts as a master switch for assets that have multiple SIMs (Super SIM and PRO SIM). Setting the asset to <code>active</code> will activate all attached SIMs, while setting an asset to <code>inactive</code> will automatically deactivate all attached SIMs (Super SIM and PRO SIM). </div>

<b>Update Scope</b>

All fields are optional, but at least one field must be provided.

  • name (string, optional)
    Updates the display name.
  • status (string, optional)
    Updates the status of all attached SIMs.
  • supersim.network_group (string, optional)
    Updates the network group for the Super SIM only.

Available network groups:

  • default_100mb: Default networks with 100MB data usage restrictions.
  • default_1gb: Default networks with 1GB data usage restrictions.
  • default_10gb: Default networks with 10GB data usage restrictions.
  • default_unlimited: Default networks without data usage restrictions.

Note: Either choose a predefined network group above or use one of your existing custom network groups with the network group name.

Super SIM

When the asset is Activated

  • The SIM is allowed to connect to base stations.
  • If the SIM has not been charged for the current month yet, we will charge the monthly SIM fee:
    • $2 per month
    • $1.6 per month for customers with more than 10 active SIMs.

When the asset is Inactive

  • The SIM is prevented from connecting to base stations.
  • As long as the SIM remains inactive, no monthly charges will apply.

PRO SIM

When the asset is Activated

  • The SIM is allowed to connect to base stations and use data.
  • If the SIM has not been charged for the current month yet, we will charge the monthly price of the assigned service profile.

Default service profile:

  • Europe + USA: $2 per month

When the asset is Inactive

  • The SIM is prevented from connecting to base stations, but it will still retain connection priorities.
  • A minimal maintenance fee of $0.1 per month will be charged while the SIM remains inactive.

Grace Period

  • If the PRO SIM has never been activated, no charges will apply for the first 6 months.
  • After the grace period, if the SIM is still inactive, the $0.1 monthly maintenance fee will begin.

Note: If the asset has both Super SIM and PRO SIM, activating the asset will activate both SIMs and charge the corresponding asset fee e.g. $6 for an ALPON device.

patch/assets/{asset_id}

Path parameters

asset_idstring required

Serial Number, UUID, SIM SID or SIM ICCID

Serial Number, UUID, SIM SID or SIM ICCID

Headers

x-forwarded-forstring

Request body

namestring

Name of the asset

status'active' | 'inactive'

Status of the asset

Response

Success

messagestring
updated_fieldsstring[] required

List of fields that were updated