Create rate plan

POST /v1/RatePlans

Capabilities and restrictions for SIMs

Body

DataEnabled boolean

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

The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB and the default value is 1000.
DataMetering string

The model used to meter data usage. Can be: payg and quota-1, quota-10, and quota-50. Learn more about the available data metering models.
FriendlyName string

A descriptive string that you create to describe the resource. It does not have to be unique.
InternationalRoaming array[string]

The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: data and messaging.
InternationalRoamingDataLimit integer

The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.
MessagingEnabled boolean

Whether SIMs can make, send, and receive SMS using Commands.
NationalRoamingDataLimit integer

The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See national roaming for more info.
NationalRoamingEnabled boolean

Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See national roaming.
UniqueName string

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.
VoiceEnabled boolean

Deprecated.

Responses

201

Created
Hide response attributes Show response attributes object
- 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

POST /v1/RatePlans

curl \
 -X POST https://wireless.twilio.com/v1/RatePlans \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'DataEnabled=true&DataLimit=42&DataMetering=string&FriendlyName=string&InternationalRoaming=string&InternationalRoamingDataLimit=42&MessagingEnabled=true&NationalRoamingDataLimit=42&NationalRoamingEnabled=true&UniqueName=string&VoiceEnabled=true'

Request example

{
  "DataEnabled": true,
  "DataLimit": 42,
  "DataMetering": "string",
  "FriendlyName": "string",
  "InternationalRoaming": [
    "string"
  ],
  "InternationalRoamingDataLimit": 42,
  "MessagingEnabled": true,
  "NationalRoamingDataLimit": 42,
  "NationalRoamingEnabled": true,
  "UniqueName": "string",
  "VoiceEnabled": true
}

Request examples

{
  "DataEnabled": true,
  "DataLimit": 42,
  "DataMetering": "string",
  "FriendlyName": "string",
  "InternationalRoaming": [
    "string"
  ],
  "InternationalRoamingDataLimit": 42,
  "MessagingEnabled": true,
  "NationalRoamingDataLimit": 42,
  "NationalRoamingEnabled": true,
  "UniqueName": "string",
  "VoiceEnabled": true
}

Response examples (201)

{
  "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
}

Response examples (201)

{
  "account_sid": "string",
  "data_enabled": true,
  "data_limit": 42,
  "data_metering": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-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
}