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 このリソースを一意に識別する 34 文字の文字列です。
`uniqueName`	文字列 Not PII このリソースを`sid`の代わりに一意に識別する、ユーザー提供の文字列です。
`accountSid`	sid<AC> Not PII このRate Planの属するアカウントの一意な識別子です。
`friendlyName`	文字列 Not PII このリソースを識別するユーザー提供の文字列です。一意ではありません。
`dataEnabled`	boolean Not PII Defines whether SIMs are capable of using GPRS/3G/4G/LTE data connectivity.
`dataMetering`	文字列 Not PII The model by which to meter data usage, in accordance with the available data metering models. Valid options are `payg` and `quota-1`, `quota-10`, and `quota-50`.
`dataLimit`	integer Not PII Network-enforced limit specifying the total Megabytes of data usage (download and upload combined) allowed during one month on the 'home' (T-Mobile USA) network. Metering begins on the day of activation and ends on the same day of the following month. Max value is 2TB.
`messagingEnabled`	boolean Not PII SIMがCommand経由でSMSの送受信を行えるかどうかを指定します。
`voiceEnabled`	boolean Not PII SIMが音声通話の発着信を行えるかどうかを指定します。
`nationalRoamingEnabled`	boolean Not PII Defines whether SIMs can roam onto networks other than the 'home' (T-Mobile USA) network in the United States. See 'national' roaming.
`nationalRoamingDataLimit`	integer Not PII Network-enforced limit specifying the total Megabytes of 'national roaming' data usage (download and upload combined) allowed during one month on networks in the United States other than the 'home' (T-Mobile USA) network. See 'national' roaming. Max value is 2TB.
`internationalRoaming`	string[] Not PII Defines whether SIMs are capable of using GPRS/3G/4G/LTE data connectivity and messaging outside of the United States. May include `data` and `messaging`.
`internationalRoamingDataLimit`	integer Not PII Network-enforced limit specifying the total Megabytes of 'international roaming' (non-US) data usage (download and upload combined) allowed during one month. Max value is 2TB
`dateCreated`	date_time<iso8601> Not PII このリソースの作成された日時で、ISO 8601形式のGMTで取得可能です。
`dateUpdated`	date_time<iso8601> Not PII このリソースが最後に更新された日時で、ISO 8601形式のGMTで取得可能です。
`url`	url Not PII このリソースに対するURLです。

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 このリソースを一意に識別する、Sidの代替としてユーザーが指定した文字列です。
`friendly_name` オプション	post 文字列 Not PII このリソースを識別するユーザー提供の文字列です。一意ではありません。
`data_enabled` オプション	post boolean Not PII SIMがGPRS/3G/LTEデータ接続を使用できるかどうかを指定します。
`data_limit` オプション	post integer Not PII Network-enforced limit specifying the total Megabytes of data usage (download and upload combined) allowed during one month on the 'home' (T-Mobile USA) network. Metering begins on the day of activation and ends on the same day of the following month. Max value is 2TB. Default value is `1000`.
`data_metering` オプション	post 文字列 Not PII The model by which to meter data usage, in accordance with the available data metering models. Valid options are `payg` and `quota-1`, `quota-10`, and `quota-50`. Defaults to `payg`.
`messaging_enabled` オプション	post boolean Not PII SIMがCommand、またはProgrammable SMS APIのどちらを経由してSMSメッセージを作成、送信、および受信できるか指定します。
`voice_enabled` オプション	post boolean Not PII SIMが音声通話の発着信を行えるかどうかを指定します。
`national_roaming_enabled` オプション	post boolean Not PII Defines whether SIMs can roam onto networks other than the 'home' (T-Mobile USA) network in the United States. See 'national' roaming.
`international_roaming` オプション	post string[] Not PII Defines whether SIMs are capable of using GPRS/3G/4G/LTE data connectivity and messaging outside of the United States. Acceptable values are `data` and `messaging`.
`national_roaming_data_limit` オプション	post integer Not PII Network-enforced limit specifying the total Megabytes of national roaming data usage (download and upload combined) allowed during one month on networks in the United States other than the 'home' (T-Mobile USA) network. See 'national' roaming. Max value is 2TB.
`international_roaming_data_limit` オプション	post integer Not PII Network-enforced limit specifying the total Megabytes of international roaming (non-US) data usage (download and upload combined) allowed during one month. Max value is 2TB. Default value is the lesser of `DataLimit` and `1000`MB.

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Rate Planを作成する

Fetch a RatePlan resource

GET

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

パラメーター

Names in None format

Names in None format
`sid` 必須	GET sid_like<WP> Not PII このリソースを一意に識別する 34 文字の文字列です。

sid

必須

GET sid_like<WP> Not PII

このリソースを一意に識別する 34 文字の文字列です。

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Fetch Rate Plan

Read Rate Plans

GET

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

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Read Rate Plans

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

Names in None format
`sid` 必須	post sid_like<WP> Not PII このリソースを一意に識別する 34 文字の文字列です。
`unique_name` オプション	post 文字列 Not PII このリソースを一意に識別する、Sidの代替としてユーザーが指定した文字列です。
`friendly_name` オプション	post 文字列 Not PII このリソースを識別するユーザー提供の文字列です。一意ではありません。

sid

必須

post sid_like<WP> Not PII

このリソースを一意に識別する 34 文字の文字列です。

unique_name

オプション

post 文字列 Not PII

このリソースを一意に識別する、Sidの代替としてユーザーが指定した文字列です。

friendly_name

オプション

post 文字列 Not PII

このリソースを識別するユーザー提供の文字列です。一意ではありません。