KORE Super SIM API

openapi: 3.0.1
info:
  title: KORE - Supersim
  description: This is the public KORE REST API.
  termsOfService: https://pardot.korewireless.com/koremsa
  contact:
    name: KORE Support
    url: https://korewireless.service-now.com/csm
    email: support@korewireless.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
components:
  securitySchemes:
    accountSid_authToken:
      scheme: basic
      type: http
    OAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.korewireless.com/api-services/v1/auth/token
          scopes: {}
  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.
          example: HBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) the Super SIM belongs to.
          example: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        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.
          example: HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        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.
          example: '2021-06-09T13:18:15Z'
        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.
          example: '2021-07-09T13:18:15Z'
        period_type:
          $ref: '#/components/schemas/billing_period_enum_bp_type'
        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.
          example: '2021-06-09T13:18:16Z'
        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.
          example: '2021-06-09T13:18:16Z'
    billing_period_enum_bp_type:
      type: string
      nullable: true
      description: The type of Billing Period. Can be `ready` or `active`.
      example: active
      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.
          example: HPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) to which the eSIM Profile resource belongs.
          example: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        iccid:
          type: string
          nullable: true
          description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.
          example: null
          x-kore:
            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://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource) resource that this eSIM Profile controls.
          example: null
        status:
          $ref: '#/components/schemas/esim_profile_enum_status'
        eid:
          type: string
          nullable: true
          description: Identifier of the eUICC that can claim the eSIM Profile.
          example: ''
        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`.
          example: null
        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.
          example: null
        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.
          example: null
        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.
          example: null
        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.
          example: null
        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.
          example: '2020-09-01T20:00:00Z'
        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.
          example: '2020-09-01T20:00:00Z'
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the eSIM Profile resource.
    esim_profile_enum_status:
      type: string
      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://docs.korewireless.com/en-us/v/api/products/supersim/esimprofile-resource#status-values) for a description of each.'
      example: new
      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://docs.korewireless.com/en-us/v/api/global-resources/iam/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
          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:
          $ref: '#/components/schemas/fleet_enum_data_metering'
        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
      nullable: true
      description: The model by which a SIMs usage is metered and billed. Defaults to `payg`.
      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://docs.korewireless.com/en-us/v/api/global-resources/iam/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://docs.korewireless.com/en-us/v/api/products/supersim/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://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource) that this IP Command was sent to or from.
        status:
          $ref: '#/components/schemas/ip_command_enum_status'
        direction:
          $ref: '#/components/schemas/ip_command_enum_direction'
        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
          default: 0
          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:
          $ref: '#/components/schemas/ip_command_enum_payload_type'
        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-kore:
            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
      nullable: true
      description: 'The delivery status of the IP Command. This is one of the following: “queued”, “sent”, “failed” or “received”.'
      enum:
      - queued
      - sent
      - received
      - failed
    ip_command_enum_direction:
      type: string
      nullable: true
      description: Either `to_sim` or `from_sim`. Indicates whether the IP Command resource was sent from or to the Super SIM.
      enum:
      - to_sim
      - from_sim
    ip_command_enum_payload_type:
      type: string
      nullable: true
      description: Indicates how the payload is encoded. 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”.
      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://docs.korewireless.com/en-us/v/api/global-resources/iam/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:
          $ref: '#/components/schemas/settings_update_enum_status'
        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
      nullable: true
      description: The Status of this Settings Update. One of `scheduled`, `in-progress`, `successful` or `failed`.
      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.
          example: HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        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.
          example: My SIM
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: The SID of the [Account](https://docs.korewireless.com/en-us/v/api/global-resources/iam/account) that the Super SIM belongs to.
          example: ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        iccid:
          type: string
          nullable: true
          description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM.
          x-kore:
            pii:
              handling: standard
              deleteSla: 30
          example: 89883070000123460000
        status:
          $ref: '#/components/schemas/sim_enum_status'
        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.
          example: null
        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.
          example: '2021-04-01T20:00:00Z'
        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.
          example: '2021-04-01T20:00:00Z'
        url:
          type: string
          format: uri
          nullable: true
          description: The absolute URL of the Sim Resource.
          example: https://supersim.api.korewireless./v1/Sims/HSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
        links:
          type: object
          format: uri-map
          nullable: true
    sim_enum_status:
      type: string
      nullable: true
      description: The status of the Super SIM. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`. See the [Super SIM Status Values](https://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource#status-values) for a description of each.
      example: new
      enum:
      - new
      - ready
      - active
      - inactive
      - scheduled
    sim_enum_status_update:
      type: string
      description: 'The new status of the resource. Can be: `ready`, `active`, or `inactive`. See the [Super SIM Status Values](https://docs.korewireless.com/en-us/v/api/products/supersim/sim-resource#status-values) for more info.'
      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:
          $ref: '#/components/schemas/sim_ip_address_enum_ip_address_version'
    sim_ip_address_enum_ip_address_version:
      type: string
      nullable: true
      description: IP address version of the corresponding IP address
      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://docs.korewireless.com/en-us/v/api/global-resources/iam/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://docs.korewireless.com/en-us/v/api/products/supersim/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-kore:
            pii:
              handling: standard
              deleteSla: 30
        status:
          $ref: '#/components/schemas/sms_command_enum_status'
        direction:
          $ref: '#/components/schemas/sms_command_enum_direction'
        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
      nullable: true
      description: 'The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [SMS Command Status Values](https://docs.korewireless.com/en-us/v/api/products/supersim/smscommand-resource#status-values) for a description of each.'
      enum:
      - queued
      - sent
      - delivered
      - received
      - failed
    sms_command_enum_direction:
      type: string
      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`.
      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://docs.korewireless.com/en-us/v/api/global-resources/iam/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 KORE's billing system. Refer to [Data Usage Processing](https://docs.korewireless.com/en-us/v/api/products/supersim/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://docs.korewireless.com/en-us/v/api/products/supersim/usage-record-resource#data-usage-processing) for more details.
    usage_record_enum_granularity:
      type: string
      enum:
      - hour
      - day
      - all
    usage_reco

# --- truncated at 32 KB (241 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kore-wireless/refs/heads/main/openapi/kore-wireless-supersim.yml