Skip to main content
← back to extensions

Twilio/supersim

@keeb/twilio/supersimv2026.08.25.2· 16d agoMODELS
01README

Twilio supersim API models

02Release Notes
  • Updated: billing_period, esim_profile, fleet, ip_command, network_access_profile_network, network_access_profile, network, settings_update, sim_ip_address, sim, sms_command, usage_record
03Models12
@keeb/twilio/supersim/billing-periodv2026.08.25.2billing_period.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
sim_sidstringPath scope for the billing period: sim_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(max_items?: number)
List billing periods and record each as a data artifact (capped at 200 by default; writes a billing_period_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the billing_period_lookup record reports truncated: true.

Resources

state(infinite)— Billing period resource state
billing_period_lookup(infinite)— Billing period lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/esim-profilev2026.08.25.2esim_profile.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
callback_url?stringThe URL we should call using the `callback_method` when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from `reserving` to `available`.
callback_method?enumThe HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
generate_matching_id?booleanWhen set to `true`, a value for `Eid` does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the `matching_id` property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the prof
eid?stringIdentifier of the eUICC that will claim the eSIM Profile.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a esim profile
fn get(id: string)
Get a esim profile
ArgumentTypeDescription
idstringThe sid of the esim profile
fn lookup(eid?: string, sim_sid?: string, status?: enum, max_items?: number)
List esim profiles and record each as a data artifact (capped at 200 by default; writes a esim_profile_lookup record with the coverage of the walk)
ArgumentTypeDescription
eid?stringList the eSIM Profiles that have been associated with an EId.
sim_sid?stringFind the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.
status?enumList the eSIM Profiles that are in a given status.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the esim_profile_lookup record reports truncated: true.
fn sync()
Sync esim profile state from Twilio

Resources

state(infinite)— Esim profile resource state
esim_profile_lookup(infinite)— Esim profile lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/fleetv2026.08.25.2fleet.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
unique_name?stringAn 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.
network_access_profilestringThe SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.
ip_commands_url?stringThe URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
ip_commands_method?enumA string representing the HTTP method to use when making a request to `ip_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
sms_commands_url?stringThe URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.
sms_commands_method?enumA string representing the HTTP method to use when making a request to `sms_commands_url`. Can be one of `POST` or `GET`. Defaults to `POST`.
data_limit?numberThe total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).
data_enabled?booleanDefines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`.
sms_commands_enabled?booleanDefines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a fleet
fn get(id: string)
Get a fleet
ArgumentTypeDescription
idstringThe sid of the fleet
fn lookup(network_access_profile?: string, max_items?: number)
List fleets and record each as a data artifact (capped at 200 by default; writes a fleet_lookup record with the coverage of the walk)
ArgumentTypeDescription
network_access_profile?stringThe SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the fleet_lookup record reports truncated: true.
fn update()
Update fleet attributes
fn sync()
Sync fleet state from Twilio

Resources

state(infinite)— Fleet resource state
fleet_lookup(infinite)— Fleet lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/ip-commandv2026.08.25.2ip_command.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
simstringThe `sid` or `unique_name` of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to.
payloadstringThe data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64.
device_portnumberThe device port to which the IP Command will be sent.
payload_type?enumEither “text” or “binary”. For an IP Command sent to a Super SIM, `payload_type` is configurable. For an IP Command sent from a Super SIM, `payload_type` is always “binary”.
callback_url?stringThe URL we should call using the `callback_method` after we have sent the IP Command.
callback_method?enumThe HTTP method we should use to call `callback_url`. Can be `GET` or `POST`, and the default is `POST`.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a ip command
fn get(id: string)
Get a ip command
ArgumentTypeDescription
idstringThe sid of the ip command
fn lookup(sim?: string, sim_iccid?: string, status?: enum, direction?: enum, max_items?: number)
List ip commands and record each as a data artifact (capped at 200 by default; writes a ip_command_lookup record with the coverage of the walk)
ArgumentTypeDescription
sim?stringThe SID or unique name of the Sim resource that IP Command was sent to or from.
sim_iccid?stringThe ICCID of the Sim resource that IP Command was sent to or from.
status?enumThe status of the IP Command. Can be: `queued`, `sent`, `received` or `failed`. See the [IP Command Status Values](https://www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.
direction?enumThe direction of the IP Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the ip_command_lookup record reports truncated: true.
fn sync()
Sync ip command state from Twilio

Resources

state(infinite)— Ip command resource state
ip_command_lookup(infinite)— Ip command lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/networkv2026.08.25.2network.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a network
ArgumentTypeDescription
idstringThe sid of the network
fn lookup(iso_country?: string, mcc?: string, mnc?: string, max_items?: number)
List networks and record each as a data artifact (capped at 200 by default; writes a network_lookup record with the coverage of the walk)
ArgumentTypeDescription
iso_country?stringThe [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources to read.
mcc?stringThe 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.
mnc?stringThe 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the network_lookup record reports truncated: true.
fn sync()
Sync network state from Twilio

Resources

state(infinite)— Network resource state
network_lookup(infinite)— Network lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/network-access-profilev2026.08.25.2network_access_profile.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
unique_name?stringAn 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.
networks?arrayList of Network SIDs that this Network Access Profile will allow connections to.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a network access profile
fn get(id: string)
Get a network access profile
ArgumentTypeDescription
idstringThe sid of the network access profile
fn lookup(max_items?: number)
List network access profiles and record each as a data artifact (capped at 200 by default; writes a network_access_profile_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the network_access_profile_lookup record reports truncated: true.
fn update()
Update network access profile attributes
fn sync()
Sync network access profile state from Twilio

Resources

state(infinite)— Network access profile resource state
network_access_profile_lookup(infinite)— Network access profile lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/network-access-profile-networkv2026.08.25.2network_access_profile_network.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
network_access_profile_sidstringPath scope for the network access profile network: network_access_profile_sid
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
networkstringThe SID of the Network resource to be added to the Network Access Profile resource.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a network access profile network
fn get(id: string)
Get a network access profile network
ArgumentTypeDescription
idstringThe sid of the network access profile network
fn lookup(max_items?: number)
List network access profile networks and record each as a data artifact (capped at 200 by default; writes a network_access_profile_network_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the network_access_profile_network_lookup record reports truncated: true.
fn delete(id: string)
Delete the network access profile network
ArgumentTypeDescription
idstringThe sid of the network access profile network
fn sync()
Sync network access profile network state from Twilio

Resources

state(infinite)— Network access profile network resource state
network_access_profile_network_lookup(infinite)— Network access profile network lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/settings-updatev2026.08.25.2settings_update.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(sim?: string, status?: enum, max_items?: number)
List settings updates and record each as a data artifact (capped at 200 by default; writes a settings_update_lookup record with the coverage of the walk)
ArgumentTypeDescription
sim?stringFilter the Settings Updates by a Super SIM's SID or UniqueName.
status?enumFilter the Settings Updates by status. Can be `scheduled`, `in-progress`, `successful`, or `failed`.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the settings_update_lookup record reports truncated: true.

Resources

state(infinite)— Settings update resource state
settings_update_lookup(infinite)— Settings update lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/simv2026.08.25.2sim.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
unique_name?stringAn 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.
status?enum
fleet?stringThe SID or unique name of the Fleet to which the SIM resource should be assigned.
callback_url?stringThe URL we should call using the `callback_method` after an asynchronous update has finished.
callback_method?enumThe HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
iccidstringThe [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the Super SIM to be added to your Account.
registration_codestringThe 10-digit code required to claim the Super SIM for your Account.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a sim
fn get(id: string)
Get a sim
ArgumentTypeDescription
idstringThe sid of the sim
fn lookup(status?: enum, fleet?: string, iccid?: string, max_items?: number)
List sims and record each as a data artifact (capped at 200 by default; writes a sim_lookup record with the coverage of the walk)
ArgumentTypeDescription
status?enumThe status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`.
fleet?stringThe SID or unique name of the Fleet to which a list of Sims are assigned.
iccid?stringThe [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sim_lookup record reports truncated: true.
fn update()
Update sim attributes
fn sync()
Sync sim state from Twilio

Resources

state(infinite)— Sim resource state
sim_lookup(infinite)— Sim lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/sim-ip-addressv2026.08.25.2sim_ip_address.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
sim_sidstringPath scope for the sim ip address: sim_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(max_items?: number)
List sim ip addresss and record each as a data artifact (capped at 200 by default; writes a sim_ip_address_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sim_ip_address_lookup record reports truncated: true.

Resources

state(infinite)— Sim ip address resource state
sim_ip_address_lookup(infinite)— Sim ip address lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/sms-commandv2026.08.25.2sms_command.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
simstringThe `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the SMS Command to.
payloadstringThe message body of the SMS Command.
callback_method?enumThe HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
callback_url?stringThe URL we should call using the `callback_method` after we have sent the command.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a sms command
fn get(id: string)
Get a sms command
ArgumentTypeDescription
idstringThe sid of the sms command
fn lookup(sim?: string, status?: enum, direction?: enum, max_items?: number)
List sms commands and record each as a data artifact (capped at 200 by default; writes a sms_command_lookup record with the coverage of the walk)
ArgumentTypeDescription
sim?stringThe SID or unique name of the Sim resource that SMS Command was sent to or from.
status?enumThe status of the SMS Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [SMS Command Status Values](https://www.twilio.com/docs/iot/supersim/api/smscommand-resource#status-values) for a description of each.
direction?enumThe direction of the SMS Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sms_command_lookup record reports truncated: true.
fn sync()
Sync sms command state from Twilio

Resources

state(infinite)— Sms command resource state
sms_command_lookup(infinite)— Sms command lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/supersim/usage-recordv2026.08.25.2usage_record.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(sim?: string, fleet?: string, network?: string, iso_country?: string, group?: enum, granularity?: enum, start_time?: string, end_time?: string, max_items?: number)
List usage records and record each as a data artifact (capped at 200 by default; writes a usage_record_lookup record with the coverage of the walk)
ArgumentTypeDescription
sim?stringSID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
fleet?stringSID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
network?stringSID of a Network resource. Only show UsageRecords representing usage on this network.
iso_country?stringAlpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
group?enumDimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
granularity?enumTime-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
start_time?stringOnly include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
end_time?stringOnly include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the usage_record_lookup record reports truncated: true.

Resources

state(infinite)— Usage record resource state
usage_record_lookup(infinite)— Usage record lookup coverage — whether the page walk exhausted the collection
04Stats
B
85 / 100
Downloads
0
Archive size
55.7 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository0/2missing
05Platforms
06Labels
#twilio#supersim#communications#saas