List rate plan

GET /v1/RatePlans

Capabilities and restrictions for SIMs

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • rate_plans array[object]
      Hide rate_plans attributes Show rate_plans attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • data_enabled boolean | null

        Whether SIMs can use GPRS/3G/4G/LTE data connectivity

      • data_limit integer | null

        The total data usage in Megabytes that the Network allows during one month on the home network

      • data_metering string | null

        The model used to meter data usage

      • date_created string(date-time) | null

        The date when the resource was created, given as GMT in ISO 8601 format

      • date_updated string(date-time) | null

        The date when the resource was last updated, given as GMT in ISO 8601 format

      • friendly_name string | null

        The string that you assigned to describe the resource

      • international_roaming array[string] | null

        The services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States

      • international_roaming_data_limit integer | null

        The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States

      • messaging_enabled boolean | null

        Whether SIMs can make, send, and receive SMS using Commands

      • national_roaming_data_limit integer | null

        The total data usage in Megabytes that the Network allows during one month on non-home networks in the United States

      • national_roaming_enabled boolean | null

        Whether SIMs can roam on networks other than the home network in the United States

      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WP[0-9a-fA-F]{32}$.

      • unique_name string | null

        An application-defined string that uniquely identifies the resource

      • url string(uri) | null

        The absolute URL of the resource

      • voice_enabled boolean | null

        Deprecated. Whether SIMs can make and receive voice calls
GET /v1/RatePlans 
curl \
 -X GET https://wireless.twilio.com/v1/RatePlans \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "rate_plans": [
    {
      "account_sid": "string",
      "data_enabled": true,
      "data_limit": 42,
      "data_metering": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "international_roaming": [
        "string"
      ],
      "international_roaming_data_limit": 42,
      "messaging_enabled": true,
      "national_roaming_data_limit": 42,
      "national_roaming_enabled": true,
      "sid": "string",
      "unique_name": "string",
      "url": "https://example.com",
      "voice_enabled": true
    }
  ]
}