components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: supersim.v1.sim.billing_period: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HB[0-9a-fA-F]{32}$ nullable: true description: The SID of the Billing Period. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) the Super SIM belongs to. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Super SIM the Billing Period belongs to. start_time: type: string format: date-time nullable: true description: The start time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. end_time: type: string format: date-time nullable: true description: The end time of the Billing Period specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. period_type: type: string $ref: '#/components/schemas/billing_period_enum_bp_type' nullable: true description: The type of Billing Period. Can be `ready` or `active`. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. billing_period_enum_bp_type: type: string enum: - ready - active supersim.v1.esim_profile: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HP[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the eSIM Profile resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the eSIM Profile resource belongs. iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource. x-twilio: pii: handling: standard deleteSla: 30 sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls. status: type: string $ref: '#/components/schemas/esim_profile_enum_status' nullable: true description: 'The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each.' eid: type: string nullable: true description: Identifier of the eUICC that can claim the eSIM Profile. smdp_plus_address: type: string format: uri nullable: true description: Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status `available`. matching_id: type: string nullable: true description: Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if `generate_matching_id` is set to `true` when creating the eSIM profile reservation. activation_code: type: string nullable: true description: Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile. error_code: type: string nullable: true description: Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state. error_message: type: string nullable: true description: Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in `failed` state. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the eSIM Profile resource. esim_profile_enum_status: type: string enum: - new - reserving - available - downloaded - installed - failed supersim.v1.fleet: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Fleet resource. sid: type: string minLength: 34 maxLength: 34 pattern: ^HF[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Fleet resource. unique_name: type: string nullable: true description: 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. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Fleet resource. data_enabled: type: boolean nullable: true description: Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`. data_limit: type: integer default: 0 description: The 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 250MB. data_metering: type: string $ref: '#/components/schemas/fleet_enum_data_metering' nullable: true description: The model by which a SIMs usage is metered and billed. Defaults to `payg`. sms_commands_enabled: type: boolean nullable: true description: Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `false`. sms_commands_url: type: string format: uri nullable: true description: The 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: type: string format: http-method enum: - GET - POST nullable: true description: A 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`. network_access_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ nullable: true description: The SID of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to. ip_commands_url: type: string format: uri nullable: true description: The 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: type: string format: http-method enum: - GET - POST nullable: true description: A 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`. fleet_enum_data_metering: type: string enum: - payg supersim.v1.ip_command: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HG[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the IP Command resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IP Command resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from. sim_iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from. status: type: string $ref: '#/components/schemas/ip_command_enum_status' nullable: true description: "The delivery status of the IP Command. This is one of the\ \ following: \u201Cqueued\u201D, \u201Csent\u201D, \u201Cfailed\u201D\ \ or \u201Creceived\u201D." direction: type: string $ref: '#/components/schemas/ip_command_enum_direction' nullable: true description: Either `to_sim` or `from_sim`. Indicates whether the IP Command resource was sent from or to the Super SIM. device_ip: type: string nullable: true description: "The IP address of the device that the IP Command was sent\ \ to or received from. For an IP Command sent to a Super SIM, `device_ip`\ \ starts out as `null`, and once the IP Command is \u201Csent\u201D, the\ \ `device_ip` will be filled out. An IP Command sent from a Super SIM\ \ have its `device_ip` always set." device_port: type: integer default: 0 description: For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message. payload_type: type: string $ref: '#/components/schemas/ip_command_enum_payload_type' nullable: true description: "Either \u201Ctext\u201D or \u201Cbinary\u201D. 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 \u201Cbinary\u201D." payload: type: string nullable: true description: "The payload that is carried in the IP/UDP message. The payload\ \ can be encoded in either text or binary format. For text payload, UTF-8\ \ encoding must be used.\n\nFor an IP Command sent to a Super SIM, the\ \ payload is appended to the IP/UDP message \u201Cas is\u201D. The payload\ \ should not exceed 1300 bytes.\n\nFor an IP Command sent from a Super\ \ SIM, the payload from the received IP/UDP message is extracted and sent\ \ in binary encoding. For an IP Command sent from a Super SIM, the payload\ \ should not exceed 1300 bytes. If it is larger than 1300 bytes, there\ \ might be fragmentation on the upstream and the message may appear truncated." x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the IP Command resource. ip_command_enum_status: type: string enum: - queued - sent - received - failed ip_command_enum_direction: type: string enum: - to_sim - from_sim ip_command_enum_payload_type: type: string enum: - text - binary supersim.v1.network: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Network resource. friendly_name: type: string nullable: true description: A human readable identifier of this resource. url: type: string format: uri nullable: true description: The absolute URL of the Network resource. iso_country: type: string nullable: true description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource. identifiers: type: array items: {} nullable: true description: Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource. supersim.v1.network_access_profile: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Network Access Profile resource. unique_name: type: string nullable: true description: 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_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Network Access Profile belongs to. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Network Access Profile resource. links: type: object format: uri-map nullable: true supersim.v1.network_access_profile.network_access_profile_network: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Network resource. network_access_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Network resource's Network Access Profile resource. friendly_name: type: string nullable: true description: A human readable identifier of the Network this resource refers to. iso_country: type: string nullable: true description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resource. identifiers: type: array items: {} nullable: true description: Array of objects identifying the [MCC-MNCs](https://en.wikipedia.org/wiki/Mobile_country_code) that are included in the Network resource. url: type: string format: uri nullable: true description: The absolute URL of the Network resource. supersim.v1.settings_update: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^OB[0-9a-fA-F]{32}$ nullable: true description: The unique identifier of this Settings Update. iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Super SIM to which this Settings Update was applied. status: type: string $ref: '#/components/schemas/settings_update_enum_status' nullable: true description: The Status of this Settings Update. One of `scheduled`, `in-progress`, `successful` or `failed`. packages: type: array items: {} nullable: true description: Array containing the different Settings Packages that will be applied to the SIM after the update completes. Each object within the array indicates the name and the version of the Settings Package that will be on the SIM if the update is successful. date_completed: type: string format: date-time nullable: true description: The time, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, when the update successfully completed and the new settings were applied to the SIM. date_created: type: string format: date-time nullable: true description: The date that this Settings Update was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Settings Update was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. settings_update_enum_status: type: string enum: - scheduled - in-progress - successful - failed supersim.v1.sim: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the Sim resource. unique_name: type: string nullable: true description: 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_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Super SIM belongs to. iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM. x-twilio: pii: handling: standard deleteSla: 30 status: type: string $ref: '#/components/schemas/sim_enum_status' nullable: true description: The status of the Super SIM. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for a description of each. fleet_sid: type: string minLength: 34 maxLength: 34 pattern: ^HF[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the Fleet configured for this SIM. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Sim Resource. links: type: object format: uri-map nullable: true sim_enum_status: type: string enum: - new - ready - active - inactive - scheduled sim_enum_status_update: type: string enum: - ready - active - inactive supersim.v1.sim.sim_ip_address: type: object properties: ip_address: type: string nullable: true description: IP address assigned to the given Super SIM ip_address_version: type: string $ref: '#/components/schemas/sim_ip_address_enum_ip_address_version' nullable: true description: IP address version of the corresponding IP address sim_ip_address_enum_ip_address_version: type: string enum: - IPv4 - IPv6 supersim.v1.sms_command: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HC[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the SMS Command resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SMS Command resource. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) that this SMS Command was sent to or from. payload: type: string nullable: true description: The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters. x-twilio: pii: handling: standard deleteSla: 30 status: type: string $ref: '#/components/schemas/sms_command_enum_status' nullable: true description: 'The 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: type: string $ref: '#/components/schemas/sms_command_enum_direction' nullable: true description: The 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`. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the SMS Command resource. sms_command_enum_status: type: string enum: - queued - sent - delivered - received - failed sms_command_enum_direction: type: string enum: - to_sim - from_sim supersim.v1.usage_record: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that incurred the usage. sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true description: SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the `Sim` query parameter is provided or when UsageRecords are grouped by `sim`. Otherwise, the value will be `null`. network_sid: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ nullable: true description: SID of the Network resource the usage occurred on. Value will only be present when either a value for the `Network` query parameter is provided or when UsageRecords are grouped by `network`. Otherwise, the value will be `null`. fleet_sid: type: string minLength: 34 maxLength: 34 pattern: ^HF[0-9a-fA-F]{32}$ nullable: true description: SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the `Fleet` query parameter is provided or when UsageRecords are grouped by `fleet`. Otherwise, the value will be `null`. iso_country: type: string format: iso-country-code nullable: true description: Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the `IsoCountry` query parameter is provided or when UsageRecords are grouped by `isoCountry`. Otherwise, the value will be `null`. period: nullable: true description: The time period for which the usage is reported. The period is represented as a pair of `start_time` and `end_time` timestamps specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. data_upload: type: integer format: int64 nullable: true description: Total data uploaded in bytes, aggregated by the query parameters. data_download: type: integer format: int64 nullable: true description: Total data downloaded in bytes, aggregated by the query parameters. data_total: type: integer format: int64 nullable: true description: Total of data_upload and data_download. data_total_billed: type: number nullable: true description: Total amount in the `billed_unit` that was charged for the data uploaded or downloaded. Will return 0 for usage prior to February 1, 2022. Value may be 0 despite `data_total` being greater than 0 if the data usage is still being processed by Twilio's billing system. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details. billed_unit: type: string format: currency nullable: true description: The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. `USD`, `EUR`, `JPY`). This can be null when data_toal_billed is 0 and we do not yet have billing information for the corresponding data usage. Refer to [Data Usage Processing](https://www.twilio.com/docs/iot/supersim/api/usage-record-resource#data-usage-processing) for more details. usage_record_enum_granularity: type: string enum: - hour - day - all usage_record_enum_group: type: string enum: - sim - fleet - network - isoCountry usage_record_enum_sort_by: type: string enum: - time info: title: Twilio - Supersim description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v1/Sims/{SimSid}/BillingPeriods: servers: - url: https://supersim.twilio.com description: Billing Period for an IoT Super SIM x-twilio: defaultOutputProperties: - sid - sim_sid - start_time - end_time - period_type parent: /Sims/{Sid} pathType: list get: description: Retrieve a list of Billing Periods for a Super SIM. tags: - SupersimV1BillingPeriod parameters: - name: SimSid in: path description: The SID of the Super SIM to list Billing Periods for. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: billing_periods: type: array items: $ref: '#/components/schemas/supersim.v1.sim.billing_period' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListBillingPeriodResponse examples: readEmpty: value: billing_periods: [] meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 next_page_url: null key: billing_periods readFullActivePeriod: value: billing_periods: - sid: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa period_type: active start_time: '2021-06-09T13:18:15Z' end_time: '2021-07-09T13:18:15Z' date_created: '2021-06-09T13:18:16Z' date_updated: '2021-06-09T13:18:16Z' meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 next_page_url: null key: billing_periods readFullReadyPeriod: value: billing_periods: - sid: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa period_type: ready start_time: '2021-06-09T13:18:15Z' end_time: '2021-07-09T13:18:15Z' date_created: '2021-06-09T13:18:16Z' date_updated: '2021-06-09T13:18:16Z' meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods?PageSize=50&Page=0 next_page_url: null key: billing_periods headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListBillingPeriod /v1/ESimProfiles: servers: - url: https://supersim.twilio.com description: eSIM Profiles that can be loaded onto consumer eUICC SIMs x-twilio: defaultOutputProperties: - sid - status mountName: esim_profiles pathType: list post: description: Order an eSIM Profile. tags: - SupersimV1EsimProfile responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.esim_profile' examples: createDefaultSmdp: value: sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: null sim_sid: null status: new eid: 89049032005008882600033489aaaaaa smdp_plus_address: null matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createActivationCode: value: sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: null sim_sid: null status: new eid: null smdp_plus_address: null matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithCallback: value: sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: null sim_sid: null status: reserving eid: 89049032005008882600033489aaaaaa smdp_plus_address: null matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateEsimProfile requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateEsimProfileRequest properties: CallbackUrl: type: string description: The 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`. CallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.' GenerateMatchingId: type: boolean description: When 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 profile. Eid: type: string description: Identifier of the eUICC that will claim the eSIM Profile. examples: createDefaultSmdp: value: Eid: 89049032005008882600033489aaaaaa createActivationCode: value: GenerateMatchingId: true createWithCallback: value: Eid: 89049032005008882600033489aaaaaa CallbackUrl: http://callback.twilio.com CallbackMethod: POST get: description: Retrieve a list of eSIM Profiles. tags: - SupersimV1EsimProfile parameters: - name: Eid in: query description: List the eSIM Profiles that have been associated with an EId. schema: type: string examples: readByEid: value: 89049032005008882600033489aaaaaa - name: SimSid in: query description: Find 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. schema: type: string examples: readBySimSid: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: List the eSIM Profiles that are in a given status. schema: type: string $ref: '#/components/schemas/esim_profile_enum_status' examples: readByStatus: value: downloaded - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: esim_profiles: type: array items: $ref: '#/components/schemas/supersim.v1.esim_profile' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEsimProfileResponse examples: readAll: value: esim_profiles: - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: 8988307aaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: available eid: 89049032005008882600033489aaaaaa smdp_plus_address: sm-dp-plus.twilio.com matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0 key: esim_profiles next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/ESimProfiles?PageSize=50&Page=0 readByEid: value: esim_profiles: - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: 8988307aaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: available eid: 89049032005008882600033489aaaaaa smdp_plus_address: sm-dp-plus.twilio.com matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0 key: esim_profiles next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/ESimProfiles?Eid=89049032005008882600033489aaaaaa&PageSize=50&Page=0 readBySimSid: value: esim_profiles: - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: 8988307aaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: available eid: 89049032005008882600033489aaaaaa smdp_plus_address: sm-dp-plus.twilio.com matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: esim_profiles next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/ESimProfiles?SimSid=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 readByStatus: value: esim_profiles: - sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: 8988307aaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: downloaded eid: 89049032005008882600033489aaaaaa smdp_plus_address: sm-dp-plus.twilio.com matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0 key: esim_profiles next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/ESimProfiles?Status=downloaded&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEsimProfile /v1/ESimProfiles/{Sid}: servers: - url: https://supersim.twilio.com description: eSIM Profiles that can be loaded onto consumer eUICC SIMs x-twilio: defaultOutputProperties: - sid - status mountName: esim_profiles pathType: instance get: description: Fetch an eSIM Profile. tags: - SupersimV1EsimProfile parameters: - name: Sid in: path description: The SID of the eSIM Profile resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.esim_profile' examples: fetchDefaultSmdp: value: sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: 8988307aaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: available eid: 89049032005008882600033489aaaaaa smdp_plus_address: sm-dp-plus.twilio.com matching_id: null activation_code: null error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fetchActivationCode: value: sid: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: 8988307aaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: available eid: null smdp_plus_address: sm-dp-plus.twilio.com matching_id: AAAAA-BBBBB-CCCCC-DDDDD-EEEEE activation_code: 1$SM-DP-PLUS.TWILIO.COM$AAAAA-BBBBB-CCCCC-DDDDD-EEEEE error_code: null error_message: null date_created: '2020-09-01T20:00:00Z' date_updated: '2020-09-01T20:00:00Z' url: https://supersim.twilio.com/v1/ESimProfiles/HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEsimProfile /v1/Fleets: servers: - url: https://supersim.twilio.com description: Configure shared settings inherited by all Super SIMs assigned to the Fleet x-twilio: defaultOutputProperties: - sid - unique_name - data_metering pathType: list post: description: Create a Fleet tags: - SupersimV1Fleet responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name data_enabled: true data_limit: 500 data_metering: payg date_created: '2019-07-30T20:00:00Z' date_updated: '2019-07-30T20:00:00Z' sms_commands_enabled: true sms_commands_method: GET sms_commands_url: https://google.com ip_commands_method: GET ip_commands_url: https://google.com network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateFleet requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateFleetRequest properties: NetworkAccessProfile: type: string description: The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to. UniqueName: type: string description: 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. DataEnabled: type: boolean description: Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`. DataLimit: type: integer description: The 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). IpCommandsUrl: type: string format: uri description: The 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. IpCommandsMethod: type: string format: http-method enum: - GET - POST description: A 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`. SmsCommandsEnabled: type: boolean description: Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to `true`. SmsCommandsUrl: type: string format: uri description: The 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. SmsCommandsMethod: type: string format: http-method enum: - GET - POST description: A 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`. required: - NetworkAccessProfile examples: create: value: UniqueName: unique_name DataEnabled: true DataLimit: 500 SmsCommandsEnabled: true SmsCommandsMethod: GET SmsCommandsUrl: https://google.com IpCommandsMethod: GET IpCommandsUrl: https://google.com NetworkAccessProfile: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of Fleets from your account. tags: - SupersimV1Fleet parameters: - name: NetworkAccessProfile in: query description: The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to. schema: type: string examples: readEmpty: value: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readFull: value: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: fleets: type: array items: $ref: '#/components/schemas/supersim.v1.fleet' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListFleetResponse examples: readEmpty: value: fleets: [] meta: first_page_url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: fleets next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 readFull: value: meta: first_page_url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: fleets next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 fleets: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: Pilot Fleet data_enabled: true data_limit: 1000 data_metering: payg date_created: '2019-10-15T20:00:00Z' date_updated: '2019-10-15T20:00:00Z' sms_commands_enabled: true sms_commands_method: POST sms_commands_url: null ip_commands_method: POST ip_commands_url: null network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListFleet /v1/Fleets/{Sid}: servers: - url: https://supersim.twilio.com description: Configure shared settings inherited by all Super SIMs assigned to the Fleet x-twilio: defaultOutputProperties: - sid - unique_name - data_metering pathType: instance get: description: Fetch a Fleet instance from your account. tags: - SupersimV1Fleet parameters: - name: Sid in: path description: The SID of the Fleet resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name data_enabled: true data_limit: 1000 data_metering: payg date_created: '2019-07-30T20:00:00Z' date_updated: '2019-07-30T20:00:00Z' sms_commands_enabled: true sms_commands_method: POST sms_commands_url: null ip_commands_method: POST ip_commands_url: null network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchFleet post: description: Updates the given properties of a Super SIM Fleet instance from your account. tags: - SupersimV1Fleet parameters: - name: Sid in: path description: The SID of the Fleet resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.fleet' examples: updateUniqueNameAndDataLimit: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: GPS Trackers Fleet 5GB data_enabled: true data_limit: 5000 data_metering: payg date_created: '2019-10-15T20:00:00Z' date_updated: '2019-10-15T20:00:00Z' sms_commands_enabled: true sms_commands_method: POST sms_commands_url: null ip_commands_method: POST ip_commands_url: null network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateFleet requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateFleetRequest properties: UniqueName: type: string description: 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. NetworkAccessProfile: type: string description: The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to. IpCommandsUrl: type: string format: uri description: The 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. IpCommandsMethod: type: string format: http-method enum: - GET - POST description: A 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`. SmsCommandsUrl: type: string format: uri description: The 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. SmsCommandsMethod: type: string format: http-method enum: - GET - POST description: A 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`. DataLimit: type: integer description: The 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). examples: updateUniqueNameAndDataLimit: value: UniqueName: GPS Trackers Fleet 5GB NetworkAccessProfile: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DataLimit: 5000 /v1/IpCommands: servers: - url: https://supersim.twilio.com description: Machine-to-machine IP Commands sent to/from Super SIMs x-twilio: defaultOutputProperties: - sid - status - date_created pathType: list post: description: Send an IP Command to a Super SIM. tags: - SupersimV1IpCommand responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.ip_command' examples: createFull: value: sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_iccid: '89883070000123456789' status: queued direction: to_sim device_ip: 100.64.0.123 device_port: 100 payload_type: text payload: 'checkin: firmware update' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createMinimal: value: sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_iccid: '89883070000123456789' status: queued direction: to_sim device_ip: 100.64.0.123 device_port: 100 payload_type: text payload: 'checkin: firmware update' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateIpCommand requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateIpCommandRequest properties: Sim: type: string description: The `sid` or `unique_name` of the [Super SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to. Payload: type: string description: The 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. DevicePort: type: integer description: The device port to which the IP Command will be sent. PayloadType: type: string $ref: '#/components/schemas/ip_command_enum_payload_type' description: Indicates how the payload is encoded. Either `text` or `binary`. Defaults to `text`. CallbackUrl: type: string format: uri description: The URL we should call using the `callback_method` after we have sent the IP Command. CallbackMethod: type: string format: http-method enum: - GET - POST description: The HTTP method we should use to call `callback_url`. Can be `GET` or `POST`, and the default is `POST`. required: - Sim - Payload - DevicePort examples: createFull: value: Sim: sim Payload: 'checkin: firmware update' DevicePort: 100 PayloadType: text CallbackUrl: http://www.example.com CallbackMethod: GET createMinimal: value: Sim: sim Payload: 'checkin: firmware update' DevicePort: 100 get: description: Retrieve a list of IP Commands from your account. tags: - SupersimV1IpCommand parameters: - name: Sim in: query description: The SID or unique name of the Sim resource that IP Command was sent to or from. schema: type: string examples: readEmpty: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readFull: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: SimIccid in: query description: The ICCID of the Sim resource that IP Command was sent to or from. schema: type: string - name: Status in: query description: 'The 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.' schema: type: string $ref: '#/components/schemas/ip_command_enum_status' examples: readEmpty: value: received readFull: value: received - name: Direction in: query description: The 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`. schema: type: string $ref: '#/components/schemas/ip_command_enum_direction' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: ip_commands: type: array items: $ref: '#/components/schemas/supersim.v1.ip_command' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListIpCommandResponse examples: readEmpty: value: ip_commands: [] meta: first_page_url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: ip_commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 readFull: value: meta: first_page_url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: ip_commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/IpCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 ip_commands: - sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_iccid: '89883070000123456789' status: received direction: from_sim device_ip: 100.64.0.123 device_port: 100 payload_type: text payload: 'checkin: firmware update' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListIpCommand /v1/IpCommands/{Sid}: servers: - url: https://supersim.twilio.com description: Machine-to-machine IP Commands sent to/from Super SIMs x-twilio: defaultOutputProperties: - sid - status - date_created pathType: instance get: description: Fetch IP Command instance from your account. tags: - SupersimV1IpCommand parameters: - name: Sid in: path description: The SID of the IP Command resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^HG[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.ip_command' examples: fetch: value: sid: HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_iccid: '89883070000123456789' status: queued direction: to_sim device_ip: 100.64.0.123 device_port: 100 payload_type: text payload: 'checkin: firmware update' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/IpCommands/HGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchIpCommand /v1/Networks/{Sid}: servers: - url: https://supersim.twilio.com description: Mobile operator networks to which Super SIMs can connect x-twilio: defaultOutputProperties: - sid pathType: instance get: description: Fetch a Network resource. tags: - SupersimV1Network parameters: - name: Sid in: path description: The SID of the Network resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network' examples: fetch: value: friendly_name: AT&T iso_country: US identifiers: - mcc: '310' mnc: '410' sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchNetwork /v1/Networks: servers: - url: https://supersim.twilio.com description: Mobile operator networks to which Super SIMs can connect x-twilio: defaultOutputProperties: - sid pathType: list get: description: Retrieve a list of Network resources. tags: - SupersimV1Network parameters: - name: IsoCountry in: query description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Network resources to read. schema: type: string examples: readWithFilters: value: US - name: Mcc in: query description: The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read. schema: type: string examples: readWithFilters: value: '310' - name: Mnc in: query description: The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read. schema: type: string examples: readWithFilters: value: '410' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: networks: type: array items: $ref: '#/components/schemas/supersim.v1.network' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListNetworkResponse examples: read: value: meta: first_page_url: https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0 key: networks next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Networks?PageSize=50&Page=0 networks: - friendly_name: AT&T iso_country: US identifiers: - mcc: '310' mnc: '410' sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readWithFilters: value: meta: first_page_url: https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0 key: networks next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Networks?IsoCountry=US&Mnc=410&Mcc=310&PageSize=50&Page=0 networks: - friendly_name: AT&T iso_country: US identifiers: - mcc: '310' mnc: '410' sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://supersim.twilio.com/v1/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListNetwork /v1/NetworkAccessProfiles: servers: - url: https://supersim.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - fleets_count dependentProperties: networks: mapping: network_access_profile_sid: sid resource_url: /v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks pathType: list post: description: Create a new Network Access Profile tags: - SupersimV1NetworkAccessProfile responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' examples: createMinimal: value: unique_name: null sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-05-01T20:00:00Z' date_updated: '2020-05-01T20:00:00Z' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks createWithNameAndNetworks: value: unique_name: My Network Access Profile sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-05-01T20:00:00Z' date_updated: '2020-05-01T20:00:00Z' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateNetworkAccessProfile requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateNetworkAccessProfileRequest properties: UniqueName: type: string description: 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. Networks: type: array items: type: string description: List of Network SIDs that this Network Access Profile will allow connections to. examples: createMinimal: value: {} createWithNameAndNetworks: value: UniqueName: My Network Access Profile Networks: - HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab get: description: Retrieve a list of Network Access Profiles from your account. tags: - SupersimV1NetworkAccessProfile parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: network_access_profiles: type: array items: $ref: '#/components/schemas/supersim.v1.network_access_profile' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListNetworkAccessProfileResponse examples: readEmpty: value: network_access_profiles: [] meta: first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 key: network_access_profiles next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 readFull: value: meta: first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 key: network_access_profiles next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/NetworkAccessProfiles?PageSize=50&Page=0 network_access_profiles: - unique_name: My Network Access Profile sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-05-01T20:00:00Z' date_updated: '2020-05-01T20:00:00Z' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListNetworkAccessProfile /v1/NetworkAccessProfiles/{Sid}: servers: - url: https://supersim.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - fleets_count dependentProperties: networks: mapping: network_access_profile_sid: sid resource_url: /v1/NetworkAccessProfiles/{network_access_profile_sid}/Networks pathType: instance get: description: Fetch a Network Access Profile instance from your account. tags: - SupersimV1NetworkAccessProfile parameters: - name: Sid in: path description: The SID of the Network Access Profile resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' examples: fetch: value: unique_name: My Network Access Profile sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-05-01T20:00:00Z' date_updated: '2020-05-01T20:00:00Z' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchNetworkAccessProfile post: description: Updates the given properties of a Network Access Profile in your account. tags: - SupersimV1NetworkAccessProfile parameters: - name: Sid in: path description: The SID of the Network Access Profile to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile' examples: updateUniqueName: value: unique_name: My Network Access Profile sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-05-01T20:00:00Z' date_updated: '2020-05-01T20:00:00Z' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: networks: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateNetworkAccessProfile requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateNetworkAccessProfileRequest properties: UniqueName: type: string description: The new unique name of the Network Access Profile. examples: updateUniqueName: value: UniqueName: My Network Access Profile /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks: servers: - url: https://supersim.twilio.com description: Mobile operator networks which Network Access Profiles allow access to x-twilio: defaultOutputProperties: - sid parent: /NetworkAccessProfiles/{Sid} className: network_access_profile_network pathType: list get: description: Retrieve a list of Network Access Profile resource's Network resource. tags: - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path description: The unique string that identifies the Network Access Profile resource. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: networks: type: array items: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListNetworkAccessProfileNetworkResponse examples: readFull: value: meta: first_page_url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0 key: networks next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks?PageSize=50&Page=0 networks: - sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: AT&T iso_country: us identifiers: - mcc: '310' mnc: '410' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListNetworkAccessProfileNetwork post: description: Add a Network resource to the Network Access Profile resource. tags: - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path description: The unique string that identifies the Network Access Profile resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' examples: create: value: sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: AT&T iso_country: us identifiers: - mcc: '310' mnc: '410' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateNetworkAccessProfileNetwork requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateNetworkAccessProfileNetworkRequest properties: Network: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ description: The SID of the Network resource to be added to the Network Access Profile resource. required: - Network examples: create: value: Network: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/NetworkAccessProfiles/{NetworkAccessProfileSid}/Networks/{Sid}: servers: - url: https://supersim.twilio.com description: Mobile operator networks which Network Access Profiles allow access to x-twilio: defaultOutputProperties: - sid parent: /NetworkAccessProfiles/{Sid} className: network_access_profile_network pathType: instance delete: description: Remove a Network resource from the Network Access Profile resource's. tags: - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path description: The unique string that identifies the Network Access Profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^HA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Network resource to be removed from the Network Access Profile resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteNetworkAccessProfileNetwork get: description: Fetch a Network Access Profile resource's Network resource. tags: - SupersimV1NetworkAccessProfileNetwork parameters: - name: NetworkAccessProfileSid in: path description: The unique string that identifies the Network Access Profile resource. schema: type: string required: true - name: Sid in: path description: The SID of the Network resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.network_access_profile.network_access_profile_network' examples: fetch: value: sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa network_access_profile_sid: HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: AT&T iso_country: us identifiers: - mcc: '310' mnc: '410' url: https://supersim.twilio.com/v1/NetworkAccessProfiles/HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Networks/HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchNetworkAccessProfileNetwork /v1/SettingsUpdates: servers: - url: https://supersim.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - iccid - sim_sid - status pathType: list get: description: Retrieve a list of Settings Updates. tags: - SupersimV1SettingsUpdate parameters: - name: Sim in: query description: Filter the Settings Updates by a Super SIM's SID or UniqueName. schema: type: string examples: readSimOnly: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readFull: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: Filter the Settings Updates by status. Can be `scheduled`, `in-progress`, `successful`, or `failed`. schema: type: string $ref: '#/components/schemas/settings_update_enum_status' examples: readStatusOnly: value: scheduled readFull: value: scheduled - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: settings_updates: type: array items: $ref: '#/components/schemas/supersim.v1.settings_update' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSettingsUpdateResponse examples: readEmpty: value: settings_updates: [] meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0 next_page_url: null key: settings_updates readSimOnly: value: settings_updates: - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: successful packages: - name: base-settings version: 1.0.0 more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings date_completed: '2015-07-30T20:00:00Z' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: settings_updates readStatusOnly: value: settings_updates: - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: scheduled packages: - name: base-settings version: 1.0.0 more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings date_completed: null date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0 next_page_url: null key: settings_updates readFull: value: settings_updates: - sid: OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: scheduled packages: - name: base-settings version: 1.0.0 more_info: https://twilio.com/docs/iot/supersim/settings-packages/base-settings date_completed: null date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' meta: page: 0 page_size: 50 first_page_url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: settings_updates headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSettingsUpdate /v1/Sims: servers: - url: https://supersim.twilio.com description: Individual IoT Super SIMs x-twilio: defaultOutputProperties: - sid - unique_name - status dependentProperties: billing_periods: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/BillingPeriods sim_ip_addresses: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/IpAddresses pathType: list post: description: Register a Super SIM to your Account tags: - SupersimV1Sim responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' examples: create: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: '' status: new fleet_sid: null iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateSim requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateSimRequest properties: Iccid: type: string description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the Super SIM to be added to your Account. RegistrationCode: type: string description: The 10-digit code required to claim the Super SIM for your Account. required: - Iccid - RegistrationCode examples: create: value: Iccid: '89883070000123456789' RegistrationCode: H3LL0W0RLD get: description: Retrieve a list of Super SIMs from your account. tags: - SupersimV1Sim parameters: - name: Status in: query description: The status of the Sim resources to read. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`. schema: type: string $ref: '#/components/schemas/sim_enum_status' examples: readEmpty: value: new readFullByFleetSid: value: new readFullByFleetName: value: new - name: Fleet in: query description: The SID or unique name of the Fleet to which a list of Sims are assigned. schema: type: string examples: readEmpty: value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readFullByFleetSid: value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readFullByFleetName: value: MyFleet - name: Iccid in: query description: The [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. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 examples: readByIccid: value: '89883070000123456789' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: sims: type: array items: $ref: '#/components/schemas/supersim.v1.sim' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSimResponse examples: readEmpty: value: sims: [] meta: first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: sims next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 readFullByFleetSid: value: meta: first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: sims next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 sims: - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My SIM status: new fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses readFullByFleetName: value: meta: first_page_url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0 key: sims next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Sims?Status=new&Fleet=MyFleet&PageSize=50&Page=0 sims: - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My SIM status: new fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses readByIccid: value: meta: first_page_url: https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0 key: sims next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Sims?Iccid=89883070000123456789&PageSize=50&Page=0 sims: - sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My SIM status: new fleet_sid: null iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSim /v1/Sims/{Sid}: servers: - url: https://supersim.twilio.com description: Individual IoT Super SIMs x-twilio: defaultOutputProperties: - sid - unique_name - status dependentProperties: billing_periods: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/BillingPeriods sim_ip_addresses: mapping: sim_sid: sid resource_url: /v1/Sims/{sim_sid}/IpAddresses pathType: instance get: description: Fetch a Super SIM instance from your account. tags: - SupersimV1Sim parameters: - name: Sid in: path description: The SID of the Sim resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' examples: fetch: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: My SIM status: new fleet_sid: null iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSim post: description: Updates the given properties of a Super SIM instance from your account. tags: - SupersimV1Sim parameters: - name: Sid in: path description: The SID of the Sim resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' examples: updateUniqueName: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: MySIM status: new fleet_sid: null iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses updateFleetWithSid: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: null status: new fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses updateFleetWithUniqueName: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: null status: new fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses transferSimToAnotherAccount: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb unique_name: null status: new fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK '202': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sim' examples: updateStatus: value: sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: null status: scheduled fleet_sid: null iccid: '89883070000123456789' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: billing_periods: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/BillingPeriods sim_ip_addresses: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: UpdateSim requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateSimRequest properties: UniqueName: type: string description: 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. Status: type: string $ref: '#/components/schemas/sim_enum_status_update' description: 'The new status of the resource. Can be: `ready`, `active`, or `inactive`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for more info.' Fleet: type: string description: The SID or unique name of the Fleet to which the SIM resource should be assigned. CallbackUrl: type: string format: uri description: The URL we should call using the `callback_method` after an asynchronous update has finished. CallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.' AccountSid: type: string description: 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. examples: updateUniqueName: value: UniqueName: MySIM updateStatus: value: Status: active CallbackUrl: http://127.0.0.1:9876/path CallbackMethod: POST updateFleetWithSid: value: Fleet: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa CallbackUrl: http://127.0.0.1:9876/path CallbackMethod: POST updateFleetWithUniqueName: value: Fleet: My Fleet CallbackUrl: http://127.0.0.1:9876/path CallbackMethod: POST transferSimToAnotherAccount: value: AccountSid: ACbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb Fleet: My Fleet /v1/Sims/{SimSid}/IpAddresses: servers: - url: https://supersim.twilio.com description: IP Addresses for a Super SIM configured to use a VPN connection x-twilio: defaultOutputProperties: - ip_address - ip_address_version parent: /Sims/{Sid} mountName: sim_ip_addresses pathType: list get: description: Retrieve a list of IP Addresses for the given Super SIM. tags: - SupersimV1SimIpAddress parameters: - name: SimSid in: path description: The SID of the Super SIM to list IP Addresses for. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: ip_addresses: type: array items: $ref: '#/components/schemas/supersim.v1.sim.sim_ip_address' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSimIpAddressResponse examples: readEmpty: value: meta: key: ip_addresses first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 ip_addresses: [] readNonEmpty: value: meta: key: ip_addresses first_page_url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/Sims/HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses?PageSize=50&Page=0 ip_addresses: - ip_address: 8.8.8.8 ip_address_version: IPv4 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSimIpAddress /v1/SmsCommands: servers: - url: https://supersim.twilio.com description: Machine-to-machine SMS Commands sent to/from SIMs x-twilio: defaultOutputProperties: - sid - status - date_created pathType: list post: description: Send SMS Command to a Sim. tags: - SupersimV1SmsCommand responses: '201': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sms_command' examples: createCommandMinimal: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa payload: 'checkin: firmware update' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued direction: to_sim url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createCommandFull: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa payload: 'Report location: (52.520008, 13.404954)' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued direction: to_sim url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateSmsCommand requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateSmsCommandRequest properties: Sim: type: string description: The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the SMS Command to. Payload: type: string description: The message body of the SMS Command. CallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.' CallbackUrl: type: string format: uri description: The URL we should call using the `callback_method` after we have sent the command. required: - Sim - Payload examples: createCommandMinimal: value: Payload: 'checkin: firmware update' Sim: SimSidOrUniqueName createCommandFull: value: Payload: 'Report location: (52.520008, 13.404954)' Sim: SimSidOrUniqueName CallbackMethod: POST CallbackUrl: http://blahblah.com/go get: description: Retrieve a list of SMS Commands from your account. tags: - SupersimV1SmsCommand parameters: - name: Sim in: query description: The SID or unique name of the Sim resource that SMS Command was sent to or from. schema: type: string examples: readEmpty: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readFull: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: 'The 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.' schema: type: string $ref: '#/components/schemas/sms_command_enum_status' examples: readEmpty: value: received readFull: value: received - name: Direction in: query description: The 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`. schema: type: string $ref: '#/components/schemas/sms_command_enum_direction' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: sms_commands: type: array items: $ref: '#/components/schemas/supersim.v1.sms_command' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListSmsCommandResponse examples: readEmpty: value: sms_commands: [] meta: first_page_url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: sms_commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 readFull: value: meta: first_page_url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 key: sms_commands next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/SmsCommands?Status=received&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 sms_commands: - sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa payload: content of the command sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: received direction: from_sim date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListSmsCommand /v1/SmsCommands/{Sid}: servers: - url: https://supersim.twilio.com description: Machine-to-machine SMS Commands sent to/from SIMs x-twilio: defaultOutputProperties: - sid - status - date_created pathType: instance get: description: Fetch SMS Command instance from your account. tags: - SupersimV1SmsCommand parameters: - name: Sid in: path description: The SID of the SMS Command resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^HC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/supersim.v1.sms_command' examples: fetch: value: sid: HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa payload: content of the command sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: queued direction: to_sim date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://supersim.twilio.com/v1/SmsCommands/HCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSmsCommand /v1/UsageRecords: servers: - url: https://supersim.twilio.com description: Usage information for Sim resources x-twilio: defaultOutputProperties: - account_sid - period pathType: list get: description: List UsageRecords tags: - SupersimV1UsageRecord parameters: - name: Sim in: query description: SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM. schema: type: string examples: readDaySimFilter: value: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Fleet in: query description: SID 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. schema: type: string examples: readDayFleetFilter: value: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Network in: query description: SID of a Network resource. Only show UsageRecords representing usage on this network. schema: type: string minLength: 34 maxLength: 34 pattern: ^HW[0-9a-fA-F]{32}$ examples: readDayNetworkFilter: value: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: IsoCountry in: query description: Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country. schema: type: string format: iso-country-code examples: readDayCountryFilter: value: FR readDayGroupBySimAndFilterByCountry: value: FR - name: Group in: query description: 'Dimension 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.' schema: type: string $ref: '#/components/schemas/usage_record_enum_group' examples: readDayGroupBySim: value: sim readDayGroupByFleet: value: fleet readDayGroupByNetwork: value: network readDayGroupByIsoCountry: value: isoCountry readDayGroupBySimAndFilterByCountry: value: sim - name: Granularity in: query description: 'Time-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.' schema: type: string $ref: '#/components/schemas/usage_record_enum_granularity' examples: readAllDay: value: day readAllHour: value: hour readDaySimFilter: value: day readDayNetworkFilter: value: day readDayCountryFilter: value: day readDayFleetFilter: value: day - name: StartTime in: query description: Only 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`. schema: type: string format: date-time - name: EndTime in: query description: Only 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. schema: type: string format: date-time - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: usage_records: type: array items: $ref: '#/components/schemas/supersim.v1.usage_record' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListUsageRecordResponse examples: readAll: value: usage_records: - period: start_time: '2015-05-01T20:00:00Z' end_time: '2015-06-01T20:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 readAllDay: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: null - period: start_time: '2019-05-02T00:00:00Z' end_time: '2019-05-03T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Granularity=day&PageSize=50&Page=0 readAllHour: value: usage_records: - period: start_time: '2019-05-01T01:00:00Z' end_time: '2019-05-01T02:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: null - period: start_time: '2019-05-01T00:00:00Z' end_time: '2019-05-01T01:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Granularity=hour&PageSize=50&Page=0 readDaySimFilter: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD fleet_sid: null network_sid: null iso_country: null - period: start_time: '2019-05-02T00:00:00Z' end_time: '2019-05-03T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fleet_sid: null network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 readDayNetworkFilter: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iso_country: null - period: start_time: '2019-05-02T00:00:00Z' end_time: '2019-05-03T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Network=HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 readDayCountryFilter: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: FR - period: start_time: '2019-05-02T00:00:00Z' end_time: '2019-05-03T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: FR meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Granularity=day&PageSize=50&Page=0 readDayFleetFilter: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa network_sid: null iso_country: null - period: start_time: '2019-05-02T00:00:00Z' end_time: '2019-05-03T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Fleet=HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Granularity=day&PageSize=50&Page=0 readDayGroupBySim: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fleet_sid: null network_sid: null iso_country: null - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb fleet_sid: null network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Group=sim&PageSize=50&Page=0 readDayGroupByFleet: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa network_sid: null iso_country: null - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: HFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Group=fleet&PageSize=50&Page=0 readDayGroupByNetwork: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: HWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa iso_country: null - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: HWbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Group=network&PageSize=50&Page=0 readDayGroupByIsoCountry: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: FR - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: null fleet_sid: null network_sid: null iso_country: US meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?Group=isoCountry&PageSize=50&Page=0 readDayGroupBySimAndFilterByCountry: value: usage_records: - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fleet_sid: null network_sid: null iso_country: FR - period: start_time: '2019-05-03T00:00:00Z' end_time: '2019-05-04T00:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 150000 data_download: 150000 data_total: 300000 data_total_billed: '0.03' billed_unit: USD sim_sid: HSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb fleet_sid: null network_sid: null iso_country: FR meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?IsoCountry=FR&Group=sim&PageSize=50&Page=0 readAllNoBilling: value: usage_records: - period: start_time: '2015-05-01T20:00:00Z' end_time: '2015-06-01T20:00:00Z' account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa data_upload: 1000 data_download: 1000 data_total: 2000 data_total_billed: '0' billed_unit: null sim_sid: null fleet_sid: null network_sid: null iso_country: null meta: first_page_url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 key: usage_records next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://supersim.twilio.com/v1/UsageRecords?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListUsageRecord servers: - url: https://supersim.twilio.com tags: - name: SupersimV1BillingPeriod - name: SupersimV1EsimProfile - name: SupersimV1Fleet - name: SupersimV1IpCommand - name: SupersimV1Network - name: SupersimV1NetworkAccessProfile - name: SupersimV1NetworkAccessProfileNetwork - name: SupersimV1Ota - name: SupersimV1SettingsUpdate - name: SupersimV1Sim - name: SupersimV1SimIpAddress - name: SupersimV1SmsCommand - name: SupersimV1UsageRecord security: - accountSid_authToken: []