Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: Rate Plans(料金プラン)

To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.

A Rate Plan determines the capabilities and restrictions of each and every Sim instance associated with it.

https://wireless.twilio.com/v1/RatePlans

Any number of Sim's can be assigned to the same Rate Plan. Each of those Sim's inherits the same capabilities and restrictions, such as whether or not each SIM can use data or SMS via Commands, how much data each SIM can use each month, and how usage will be billed. To change a SIM's capabilities and restrictions, it's Sim must be assigned to a different Rate Plan.

A Rate Plan instance can be referenced in the API either by its unique Sid or user-defined UniqueName.

https://wireless.twilio.com/v1/RatePlans/{Sid}
https://wireless.twilio.com/v1/RatePlans/{UniqueName}

RatePlan properties

Names in PHP format
sid
sid<WP> Not PII

The unique string that we created to identify the RatePlan resource.

uniqueName
文字列 Not PII

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.

accountSid
sid<AC> Not PII

The SID of the Account that created the RatePlan resource.

friendlyName
文字列 Not PII

The string that you assigned to describe the resource.

dataEnabled
boolean Not PII

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

dataMetering
文字列 Not PII

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.

dataLimit
integer Not PII

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.

messagingEnabled
boolean Not PII

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

voiceEnabled
boolean Not PII

Whether SIMs can make and receive voice calls.

nationalRoamingEnabled
boolean Not PII

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

nationalRoamingDataLimit
integer Not PII

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.

internationalRoaming
string[] Not PII

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

internationalRoamingDataLimit
integer Not PII

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.

dateCreated
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the resource.

PAYG vs Quota Data Plans

Quota Data Plans offer you a self-serve way to receive discounted data pricing in exchange for committing to a minimum dollar spend for each active SIM using the Rate Plan.

For low usage devices, the "Pay as you go" (PAYG) Data Plan is available. With PAYG data, you'll only pay for the data you consume, with no minimum data spend per SIM per month.

For higher usage devices, it is probably more cost effective to use a Quota-based Data Plan. With a Quota-based plan, you agree to a minimum data spend, or "Quota" level per SIM per month. In return, you will receive discount rates in every country, with more significant discounts for higher Quotas.

Even on a Quota plan, data is still priced per megabyte and metered at byte-level. But at the end of your SIM's billing month, you either pay for exactly what you consumed, or the Quota price, whichever is higher.

See Pricing for more information.

Data Limits

Each SIM's usage is measured independently. Data Limits specified by the Rate Plan are on a per SIM basis. For example, if a Rate Plan specifies a Data Limit of 5MB, every SIM on that Rate Plan will be allowed to consume 5MB of data.

国内ローミング

National roaming grants a SIM the ability to roam onto other carrier networks in the United States in certain low coverage situations. This will allow a SIM to roam onto regional US networks like GCI in Alaska. The SIM will prioritize T-Mobile USA, the 'home' network, when coverage is available.

National roaming pricing is different to standard data and Commands pricing. Before enabling national roaming on your Rate Plan, it is recommended to review the pricing.

Create a RatePlan resource

post
https://wireless.twilio.com/v1/RatePlans
パラメーター
Names in None format
unique_name
オプション
post 文字列 Not PII

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.

friendly_name
オプション
post 文字列 Not PII

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

data_enabled
オプション
post boolean Not PII

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

data_limit
オプション
post integer Not PII

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.

data_metering
オプション
post 文字列 Not PII

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.

messaging_enabled
オプション
post boolean Not PII

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

voice_enabled
オプション
post boolean Not PII

Whether SIMs can make and receive voice calls.

national_roaming_enabled
オプション
post boolean Not PII

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

international_roaming
オプション
post string[] Not PII

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

national_roaming_data_limit
オプション
post integer Not PII

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.

international_roaming_data_limit
オプション
post integer Not PII

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.

例 1
        
        
        
        

        Fetch a RatePlan resource

        GET
        https://wireless.twilio.com/v1/RatePlans/{Sid}
        パラメーター
        Names in None format
        sid
        必須
        GET sid_like<WP> Not PII

        The SID of the RatePlan resource to fetch.

        例 1
              
              
              
              

              Read Rate Plans

              GET
              https://wireless.twilio.com/v1/RatePlans
              例 1
                    
                    
                    
                    

                    Update a RatePlan resource

                    post
                    https://wireless.twilio.com/v1/RatePlans/{Sid}

                    The only fields that can be updated on a Rate Plan after it has been created is its Unique Name and Friendly Name. If you need to alter your SIM's capabilities you must create a new Rate Plan and reassign the Sim to the new Rate Plan.

                    パラメーター
                    Names in None format
                    sid
                    必須
                    post sid_like<WP> Not PII

                    The SID of the RatePlan resource to update.

                    unique_name
                    オプション
                    post 文字列 Not PII

                    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.

                    friendly_name
                    オプション
                    post 文字列 Not PII

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

                    例 1
                          
                          
                          
                          

                          Delete a RatePlan resource

                          削除する
                          https://wireless.twilio.com/v1/RatePlans/{Sid}

                          You cannot delete a Rate Plan if there are any Sims assigned to it that have active or ready statuses.

                          パラメーター
                          Names in None format
                          sid
                          必須
                          削除する sid_like<WP> Not PII

                          The SID of the RatePlan resource to delete.

                          例 1
                                
                                
                                
                                
                                Rate this page:

                                ヘルプが必要ですか?

                                誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。