supersim.v1.fleet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twilio/main/json-schema/twilio-supersim-v1-fleet-schema.json",
  "title": "supersim.v1.fleet",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/twilio-fleets-api-openapi.yml#/components/schemas/supersim.v1.fleet",
  "type": "object",
  "properties": {
    "account_sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^AC[0-9a-fA-F]{32}$",
      "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Fleet resource."
    },
    "sid": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^HF[0-9a-fA-F]{32}$",
      "description": "The unique string that we created to identify the Fleet resource."
    },
    "unique_name": {
      "type": [
        "string",
        "null"
      ],
      "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",
        "null"
      ],
      "format": "date-time",
      "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",
        "null"
      ],
      "format": "date-time",
      "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",
        "null"
      ],
      "format": "uri",
      "description": "The absolute URL of the Fleet resource."
    },
    "data_enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "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",
        "null"
      ],
      "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",
        "null"
      ],
      "$ref": "#/$defs/fleet_enum_data_metering",
      "description": "The model by which a SIMs usage is metered and billed. Defaults to `payg`."
    },
    "sms_commands_enabled": {
      "type": [
        "boolean",
        "null"
      ],
      "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",
        "null"
      ],
      "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."
    },
    "sms_commands_method": {
      "type": [
        "string",
        "null"
      ],
      "format": "http-method",
      "enum": [
        "HEAD",
        "GET",
        "POST",
        "PATCH",
        "PUT",
        "DELETE"
      ],
      "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",
        "null"
      ],
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^HA[0-9a-fA-F]{32}$",
      "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",
        "null"
      ],
      "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."
    },
    "ip_commands_method": {
      "type": [
        "string",
        "null"
      ],
      "format": "http-method",
      "enum": [
        "HEAD",
        "GET",
        "POST",
        "PATCH",
        "PUT",
        "DELETE"
      ],
      "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`."
    }
  },
  "$defs": {
    "fleet_enum_data_metering": {
      "type": "string",
      "enum": [
        "payg"
      ]
    }
  }
}