v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-051615131.3 KB
WirelessV1RatePlan

get/v1/RatePlans/{Sid}

Path parameters

Sidstring required

The SID of the RatePlan resource to fetch.

Response

OK

sidstring nullable

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

unique_namestring nullable

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.

account_sidstring nullable

The SID of the Account that created the RatePlan resource.

friendly_namestring nullable

The string that you assigned to describe the resource.

data_enabledboolean nullable

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

data_meteringstring nullable

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.

data_limitinteger

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.

messaging_enabledboolean nullable

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

voice_enabledboolean nullable

Deprecated. Whether SIMs can make and receive voice calls.

national_roaming_enabledboolean nullable

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

national_roaming_data_limitinteger

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.

international_roamingstring[] nullable

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.

international_roaming_data_limitinteger

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.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

urlstring uri nullable

The absolute URL of the resource.