github.com/twilio/twilio-go@v1.20.1/rest/wireless/v1/docs/RatePlansApi.md (about)

     1  # RatePlansApi
     2  
     3  All URIs are relative to *https://wireless.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateRatePlan**](RatePlansApi.md#CreateRatePlan) | **Post** /v1/RatePlans | 
     8  [**DeleteRatePlan**](RatePlansApi.md#DeleteRatePlan) | **Delete** /v1/RatePlans/{Sid} | 
     9  [**FetchRatePlan**](RatePlansApi.md#FetchRatePlan) | **Get** /v1/RatePlans/{Sid} | 
    10  [**ListRatePlan**](RatePlansApi.md#ListRatePlan) | **Get** /v1/RatePlans | 
    11  [**UpdateRatePlan**](RatePlansApi.md#UpdateRatePlan) | **Post** /v1/RatePlans/{Sid} | 
    12  
    13  
    14  
    15  ## CreateRatePlan
    16  
    17  > WirelessV1RatePlan CreateRatePlan(ctx, optional)
    18  
    19  
    20  
    21  
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateRatePlanParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **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.
    35  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It does not have to be unique.
    36  **DataEnabled** | **bool** | Whether SIMs can use GPRS/3G/4G/LTE data connectivity.
    37  **DataLimit** | **int** | 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`.
    38  **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](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).
    39  **MessagingEnabled** | **bool** | Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/iot/wireless/api/command-resource).
    40  **VoiceEnabled** | **bool** | Deprecated.
    41  **NationalRoamingEnabled** | **bool** | Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming).
    42  **InternationalRoaming** | **[]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`.
    43  **NationalRoamingDataLimit** | **int** | 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](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming) for more info.
    44  **InternationalRoamingDataLimit** | **int** | 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.
    45  
    46  ### Return type
    47  
    48  [**WirelessV1RatePlan**](WirelessV1RatePlan.md)
    49  
    50  ### Authorization
    51  
    52  [accountSid_authToken](../README.md#accountSid_authToken)
    53  
    54  ### HTTP request headers
    55  
    56  - **Content-Type**: application/x-www-form-urlencoded
    57  - **Accept**: application/json
    58  
    59  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    60  [[Back to Model list]](../README.md#documentation-for-models)
    61  [[Back to README]](../README.md)
    62  
    63  
    64  ## DeleteRatePlan
    65  
    66  > DeleteRatePlan(ctx, Sid)
    67  
    68  
    69  
    70  
    71  
    72  ### Path Parameters
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    78  **Sid** | **string** | The SID of the RatePlan resource to delete.
    79  
    80  ### Other Parameters
    81  
    82  Other parameters are passed through a pointer to a DeleteRatePlanParams struct
    83  
    84  
    85  Name | Type | Description
    86  ------------- | ------------- | -------------
    87  
    88  ### Return type
    89  
    90   (empty response body)
    91  
    92  ### Authorization
    93  
    94  [accountSid_authToken](../README.md#accountSid_authToken)
    95  
    96  ### HTTP request headers
    97  
    98  - **Content-Type**: Not defined
    99  - **Accept**: Not defined
   100  
   101  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   102  [[Back to Model list]](../README.md#documentation-for-models)
   103  [[Back to README]](../README.md)
   104  
   105  
   106  ## FetchRatePlan
   107  
   108  > WirelessV1RatePlan FetchRatePlan(ctx, Sid)
   109  
   110  
   111  
   112  
   113  
   114  ### Path Parameters
   115  
   116  
   117  Name | Type | Description
   118  ------------- | ------------- | -------------
   119  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   120  **Sid** | **string** | The SID of the RatePlan resource to fetch.
   121  
   122  ### Other Parameters
   123  
   124  Other parameters are passed through a pointer to a FetchRatePlanParams struct
   125  
   126  
   127  Name | Type | Description
   128  ------------- | ------------- | -------------
   129  
   130  ### Return type
   131  
   132  [**WirelessV1RatePlan**](WirelessV1RatePlan.md)
   133  
   134  ### Authorization
   135  
   136  [accountSid_authToken](../README.md#accountSid_authToken)
   137  
   138  ### HTTP request headers
   139  
   140  - **Content-Type**: Not defined
   141  - **Accept**: application/json
   142  
   143  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   144  [[Back to Model list]](../README.md#documentation-for-models)
   145  [[Back to README]](../README.md)
   146  
   147  
   148  ## ListRatePlan
   149  
   150  > []WirelessV1RatePlan ListRatePlan(ctx, optional)
   151  
   152  
   153  
   154  
   155  
   156  ### Path Parameters
   157  
   158  This endpoint does not need any path parameter.
   159  
   160  ### Other Parameters
   161  
   162  Other parameters are passed through a pointer to a ListRatePlanParams struct
   163  
   164  
   165  Name | Type | Description
   166  ------------- | ------------- | -------------
   167  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   168  **Limit** | **int** | Max number of records to return.
   169  
   170  ### Return type
   171  
   172  [**[]WirelessV1RatePlan**](WirelessV1RatePlan.md)
   173  
   174  ### Authorization
   175  
   176  [accountSid_authToken](../README.md#accountSid_authToken)
   177  
   178  ### HTTP request headers
   179  
   180  - **Content-Type**: Not defined
   181  - **Accept**: application/json
   182  
   183  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   184  [[Back to Model list]](../README.md#documentation-for-models)
   185  [[Back to README]](../README.md)
   186  
   187  
   188  ## UpdateRatePlan
   189  
   190  > WirelessV1RatePlan UpdateRatePlan(ctx, Sidoptional)
   191  
   192  
   193  
   194  
   195  
   196  ### Path Parameters
   197  
   198  
   199  Name | Type | Description
   200  ------------- | ------------- | -------------
   201  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   202  **Sid** | **string** | The SID of the RatePlan resource to update.
   203  
   204  ### Other Parameters
   205  
   206  Other parameters are passed through a pointer to a UpdateRatePlanParams struct
   207  
   208  
   209  Name | Type | Description
   210  ------------- | ------------- | -------------
   211  **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.
   212  **FriendlyName** | **string** | A descriptive string that you create to describe the resource. It does not have to be unique.
   213  
   214  ### Return type
   215  
   216  [**WirelessV1RatePlan**](WirelessV1RatePlan.md)
   217  
   218  ### Authorization
   219  
   220  [accountSid_authToken](../README.md#accountSid_authToken)
   221  
   222  ### HTTP request headers
   223  
   224  - **Content-Type**: application/x-www-form-urlencoded
   225  - **Accept**: application/json
   226  
   227  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   228  [[Back to Model list]](../README.md#documentation-for-models)
   229  [[Back to README]](../README.md)
   230