Twilio Super SIM API

The Twilio Super SIM API is a powerful tool that enables developers to easily provision and manage SIM cards for cellular devices. With this API, developers can programmatically activate, deactivate, and modify SIM cards, as well as monitor their data usage and set custom pricing plans. This allows for seamless connectivity across multiple networks and countries, making it ideal for IoT devices, fleet management, and other applications that require reliable, global cellular connectivity.

OpenAPI Specification

super-sim-openapi-original.yml Raw ↑
components:
  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
          nullable: true
          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:
            - HEAD
            - GET
            - POST
            - PATCH
            - PUT
            - DELETE
          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:
            - HEAD
            - GET
            - POST
            - PATCH
            - PUT
            - DELETE
          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:
            “queued”, “sent”, “failed” or “received”.
        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 “sent”, 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
          nullable: true
          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 “text” or “binary”. For an IP Command sent to a Super SIM,
            `payload_type` is configurable. For an IP Command sent from a Super
            SIM, `payload_type` is always “binary”.
        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.


            For an IP Command sent to a Super SIM, the payload is appended to
            the IP/UDP message “as is”. The payload should not exceed 1300
            bytes.


            For 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 da

# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/super-sim-openapi-original.yml