Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Sim Resource


(information)

Info

To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.

A Sim instance represents a single physical Super SIM:


_10
https://supersim.twilio.com/v1/Sims

A Sim instance can be referenced in the API either by its unique sid or a user-defined unique_name:


_10
https://supersim.twilio.com/v1/Sims/{sid}
_10
https://supersim.twilio.com/v1/Sims/{uniqueName}

Before a Super SIM can begin using data or sending/receiving SMS via Commands, the corresponding Sim instance must be assigned to a Fleet and activated.

(information)

Sim Properties

sim-properties page anchor
sidSID<HS>
Not PII

The unique string that identifies the Sim resource.

Pattern: ^HS[0-9a-fA-F]{32}$Min length: 34Max length: 34

unique_namestring

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.


account_sidSID<AC>

The SID of the Account(link takes you to an external page) that the Super SIM belongs to.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

iccidstring
PII MTL: 30 days

The ICCID(link takes you to an external page) associated with the SIM.


statusenum<string>

The status of the Super SIM. Can be new, ready, active, inactive, or scheduled. See the Super SIM Status Values(link takes you to an external page) for a description of each.

Possible values:
newreadyactiveinactivescheduled

fleet_sidSID<HF>

The unique ID of the Fleet configured for this SIM.

Pattern: ^HF[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time>

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedstring<date-time>

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.


urlstring<uri>

The absolute URL of the Sim Resource.


linksobject<uri-map>

The table below describes the available status values of a Sim instance:

StatusDescription
newThe SIM has never been enabled and is waiting to be activated so that it can connect to the network. A Sim resource can exist in new status indefinitely at no charge, but once it is transitioned to ready or active, it cannot be returned to new.
readyThe SIM can connect to the network and is capable of consuming network resources in accordance with its Fleet, but no monthly subscription fee will be charged . A Sim resource's status can only be updated to ready if it is currently new.Once the SIM has consumed 250KB of data, five SMS Commands have been sent to or received from the SIM, or three months have passed, the Sim resource's status will automatically transition to active.Use ready to enable and test your connectivity before devices are sent to customers or deployed into the field without incurring monthly fees.
activeThe SIM can connect to the network and is capable of consuming network resources in accordance with its Fleet.
inactiveThe SIM is blocked from connecting to the network.
scheduledThe update is queued and will be processed when the network operator is ready. The Sim resource's status will automatically transition to the requested status when the update operation is completed.

Add a Super SIM to your Account

add-a-super-sim-to-your-account page anchor
POST https://supersim.twilio.com/v1/Sims

(warning)

Warning

All Super SIMs purchased through Console(link takes you to an external page) arrive pre-registered to the Twilio account which placed the order. To receive an unregistered Super SIM that is eligible to be added to your Account, you will have received the SIM either at an in-person event, such as a developer conference, or from an independent partner as part of their solution.

If you are interested in ordering unregistered SIMs for your use case, please contact sales-wireless@twilio.com to speak with an IoT Sales Specialist.

If you have a Super SIM that has not yet been registered to a Twilio Account, you can add it to your Account by providing the SIM's ICCID and the registration code. On a plastic multi-size SIM card, these two values are printed on the card. For an embedded SIM (MFF2), if you have a registrable SIM, you will need to obtain this information either from your vendor or from Twilio.

Request body parameters

request-body-parameters page anchor
Iccidstringrequired

The ICCID(link takes you to an external page) of the Super SIM to be added to your Account.


RegistrationCodestringrequired

The 10-digit code required to claim the Super SIM for your Account.

Add a Super SIM to your Account

add-a-super-sim-to-your-account-1 page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.supersim.v1.sims
_13
.create({
_13
iccid: '89883070000123456789',
_13
registrationCode: 'H3LL0W0RLD'
_13
})
_13
.then(sim => console.log(sim.sid));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": "",
_15
"status": "new",
_15
"fleet_sid": null,
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}


GET https://supersim.twilio.com/v1/Sims/{Sid}

Sidstringrequired

The SID of the Sim resource to fetch.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims('HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')
_10
.fetch()
_10
.then(sim => console.log(sim.uniqueName));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": "My SIM",
_15
"status": "new",
_15
"fleet_sid": null,
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}

(warning)

Warning

You can fetch a Sim resource by either its sid or unique_name. To find a Sim resource by a Super SIM's ICCID, use the iccid query parameter while reading from the Sims resource.


Read multiple Sim resources

read-multiple-sim-resources page anchor
GET https://supersim.twilio.com/v1/Sims

Statusenum<string>

The status of the Sim resources to read. Can be new, ready, active, inactive, or scheduled.

Possible values:
newreadyactiveinactivescheduled

Fleetstring

The SID or unique name of the Fleet to which a list of Sims are assigned.


Iccidstring

The ICCID(link takes you to an external page) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.


PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

Pageinteger

The page index. This value is simply for client state.

Minimum: 0

PageTokenstring

The page token. This is provided by the API.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims.list({limit: 20})
_10
.then(sims => sims.forEach(s => console.log(s.sid)));

Output

_28
{
_28
"meta": {
_28
"first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_28
"key": "sims",
_28
"next_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=1",
_28
"page": 0,
_28
"page_size": 50,
_28
"previous_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_28
"url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0"
_28
},
_28
"sims": [
_28
{
_28
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"unique_name": "My SIM",
_28
"status": "new",
_28
"fleet_sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"iccid": "89883070000123456789",
_28
"date_created": "2015-07-30T20:00:00Z",
_28
"date_updated": "2015-07-30T20:00:00Z",
_28
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"links": {
_28
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_28
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_28
}
_28
}
_28
]
_28
}


Find a Sim resource by a Super SIM's ICCID

find-a-sim-resource-by-a-super-sims-iccid page anchor

You may need to find a Sim resource with just a Super SIM's ICCID. You can read the Sim resource by an ICCID using the iccid query parameter. If a Sim resource for that ICCID is found, a list with one record will be returned. If a Sim resource for that ICCID is not found on your Account, an empty list will be returned.

Read a Sim Resource by its ICCID

read-a-sim-resource-by-its-iccid page anchor

Read a Sim resource by its ICCID. Returns a list with one or no records.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims.list({iccid: '11111111111111111111', limit: 20})
_10
.then(sims => sims.forEach(s => console.log(s.iccid)));

Output

_28
{
_28
"meta": {
_28
"first_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_28
"key": "sims",
_28
"next_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=1",
_28
"page": 0,
_28
"page_size": 50,
_28
"previous_page_url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_28
"url": "https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0"
_28
},
_28
"sims": [
_28
{
_28
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"unique_name": "My SIM",
_28
"status": "new",
_28
"fleet_sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"iccid": "89883070000123456789",
_28
"date_created": "2015-07-30T20:00:00Z",
_28
"date_updated": "2015-07-30T20:00:00Z",
_28
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_28
"links": {
_28
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_28
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_28
}
_28
}
_28
]
_28
}


POST https://supersim.twilio.com/v1/Sims/{Sid}

Sidstringrequired

The SID of the Sim resource to update.

UniqueNamestring

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.


Statusenum<string>

The new status of the resource. Can be: ready, active, or inactive. See the Super SIM Status Values(link takes you to an external page) for more info.

Possible values:
readyactiveinactive

Fleetstring

The SID or unique name of the Fleet to which the SIM resource should be assigned.


CallbackUrlstring<uri>

The URL we should call using the callback_method after an asynchronous update has finished.


CallbackMethodenum<http-method>

The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

Possible values:
GETPOST

AccountSidstring

The SID of the Account to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a Subaccount of the requesting Account. Only valid when the Sim resource's status is new.


Some Sim resource updates will be completed asynchronously. To receive a notification when a Sim resource has finished updating, provide a callback_url and a callback_method with your initial HTTP request.

When an update is handled asynchronously, the Sim resource will undergo multiple updates:

  • First, the Sim resource's status will be set to scheduled as the update is placed in a queue.
  • Finally, the Sim resource's status will transition to the final state.

If a Sim resource's Fleet is changed as part of an asynchronous update, the existing value of the fleet_sid property will be returned when the update request is accepted. When the update completes, the new value will be shown on the Sim resource.

(information)

Info

In the scenarios below, "activating" means updating the Sim resource's status to a value that will allow the Super SIM to use cellular network resources: either ready or active. Please refer to Status values for descriptions of each status.

The following update scenarios will be handled asynchronously:


Activating a Sim resource

activating-a-sim-resource page anchor

When a Sim resource's status is updated from new to ready or active.


Deactivating a Sim resource

deactivating-a-sim-resource page anchor

When a Sim resource's status is updated from active to inactive.


Reactivating a Sim resource

reactivating-a-sim-resource page anchor

When a Sim resource's status is updated from inactive to active.


Changing an activated Sim resource's Fleet

changing-an-activated-sim-resources-fleet page anchor

When a Sim resource is already ready or active and its Fleet is updated. When the update request is accepted, the Sim resource's status will change to scheduled. The Sim resource's fleet_sid property will be unchanged at this point. If the update succeeds, the Sim resource's status returns to ready or active and the Sim resource's fleet_sid property now returns the new Fleet resource's SID.


If you provided a value for the callback_url parameter in your update request, the asynchronous request made to that URL will contain the following parameters.

SimSidThe unique SID of the Sim resource that this callback is in reference to.
SimUniqueNameThe Sim resource's unique_name if it has one.
SimStatusA string representing the Sim resource's status after the update completed.
AccountSidThe unique SID of the Account that the Sim resource belongs to.

If the callback_method was set to POST or not provided, the callback parameters will be delivered as HTML form parameters. If the callback_method was set to GET, the callback parameters will be delivered as a query string.

Update a Sim's Unique Name

update-a-sims-unique-name page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims('HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({uniqueName: 'My SIM'})
_10
.then(sim => console.log(sim.uniqueName));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": "My SIM",
_15
"status": "new",
_15
"fleet_sid": null,
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}

Your Super SIM's permissions are controlled by its Fleet.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims('HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({fleet: 'HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
_10
.then(sim => console.log(sim.fleetSid));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": null,
_15
"status": "new",
_15
"fleet_sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}

Update a Sim's Fleet by Unique Name

update-a-sims-fleet-by-unique-name page anchor

You can refer to a Fleet by its Unique Name when updating your Sim.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims('HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({fleet: 'My Fleet'})
_10
.then(sim => console.log(sim.fleetSid));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": null,
_15
"status": "new",
_15
"fleet_sid": "HFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}

Activate your Super SIM to connect to the network.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims('HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({status: 'active'})
_10
.then(sim => console.log(sim.status));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": null,
_15
"status": "active",
_15
"fleet_sid": null,
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}

Move Super SIMs between Subaccounts

move-super-sims-between-subaccounts page anchor

If you are using Subaccounts, you can transfer new Super SIMs between your accounts.

While using the primary Account's credentials, use the account_sid parameter to provide the Account SID of the Account you wish to own that Super SIM. Super SIMs can be moved between Accounts the following ways:

  • From the primary Account to a Subaccount.
  • From a Subaccount to the primary Account.
  • From a subaccount to another Subaccount.
(warning)

Warning

If the Super SIM you are moving is assigned to a Fleet, you must also pass the sid or unique_name of a Fleet resource that belongs to the new Account, or null, in the fleet parameter of your Update request.

Transfer a Super SIM to a Subaccount

transfer-a-super-sim-to-a-subaccount page anchor

Sim resource must have the status new.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.supersim.v1.sims('HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({accountSid: 'ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'})
_10
.then(sim => console.log(sim.accountSid));

Output

_15
{
_15
"sid": "HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"unique_name": "MySIM",
_15
"status": "new",
_15
"fleet_sid": null,
_15
"iccid": "89883070000123456789",
_15
"date_created": "2015-07-30T20:00:00Z",
_15
"date_updated": "2015-07-30T20:00:00Z",
_15
"url": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_15
"links": {
_15
"billing_periods": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/BillingPeriods",
_15
"sim_ip_addresses": "https://supersim.twilio.com/v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/IpAddresses"
_15
}
_15
}

Moving Inactive SIMs Between Subaccounts

moving-inactive-sims-between-subaccounts page anchor
(warning)

Warning

It is possible to move inactive SIMs between your accounts; however that feature is currently in Private Beta . If you need access to this feature, please contact your IoT Sales Specialist or contact support to request this feature be unlocked for your account. Please review the considerations below for your related resources may behave when an inactive SIM is transferred.

You can also move inactive SIMs between your primary Account and its Subaccounts by updating the account_sid property.

Considerations when Moving Inactive SIMs

considerations-when-moving-inactive-sims page anchor

When you move a non-new SIM to a new Account, you will not get any results from the Sim BillingPeriod subresource until the current active Billing Period expires and a new one is created that will belong to the new Account, even if you reactivate the SIM. If the Billing Period on the previous Account has already expired (e.g. the SIM was left in inactive for a couple of months and is now going to be used again on the new Account), then a new Billing Period will be created on the new Account when the SIM is reactivated. Not knowing the Sim resource's Billing Period start and end dates will prevent you from being able to accurately determine how much of the SIM's data limit you've utilized unless you have saved this information outside of Twilio.

When you move a SIM to a new Account, the counter tracking data usage towards the SIM's data limit does not reset. This usage counter is tied to the SIM's Billing Period. If the SIM's status was active within the last 30 days, it's most recent active billing period may not have expired yet. Any usage incurred when the SIM belonged to the previous Account will still be counted towards the data limit inherited from the SIM's current Fleet. However, you will not see that usage on the new Account as the SIM's Usage Records do not transfer to the new Account.

Let's look at an example. If you have a SIM that belongs to Account A and its Billing Periods start/end on the 2nd of the month because that's when it was originally activated a few months ago and you use 5 MB between the 2nd and the 10th of the month. On the 10th you want to move it to Account B, a subaccount of Account A. You update the SIM's status to inactive and then move it to Account B. You assign it to a Fleet with a 15 MB data limit and reactivate the SIM and begin using it. Because the SIM was reactivated before it's current Billing Period expired, that existing Billing Period is re-used and it will continue to start/end on the 2nd of the month. However, because the same Billing Period is used and your data usage towards the data limit is linked to the Billing Period, the 5 MB's you used earlier in Billing Period (between the 2nd and the 10th) count towards the 15 MB data limit.

Settings Updates History

settings-updates-history page anchor

If you move a SIM between Accounts, the entire history of Settings Updates follows the SIM and will be returned from the SettingsUpdates resource when querying it with the new Account's credentials. You will no longer be able to view the Settings Updates for the SIM in the previous Account's results when querying the Settings Updates resource.


Rate this page: