Get Rate Plans

Description

Returns detailed information about all rate plans associated with your account, including account-specific and shared rate plans. Control Center returns only published rate plans. Retail rate plans are excluded from the list.

You must have the AccountAdmin role to perform this function.

Resource URL

GET rws/api/v{apiVersion}/rateplans

Request Parameters

Parameters and Descriptions
Parameter	Description
apiVersion	The version number for this API. The current version for all functions is 1.
accountId	(Optional) If you use this parameter, the account ID must match your own account ID. If you omit this parameter, the API automatically supplies your account ID.
shared	(Optional) This attribute is not applicable for account users. An error will occur if you include this attribute.
pageSize	(Optional) Specifies the number of records returned in each response page. The maximum value is 50. The value defaults to 50. See Pagination.
pageNumber	(Optional) Specifies the number of response pages to return. This value defaults to 1. See Pagination.

Response Parameters

Different rate plan types use different parameters. The function returns the parameters that apply to each rate plan. Be aware that some parameters appear in different arrays, depending on the rate plan type.

For more information about each rate plan type, refer to the Rate Plan Types section in the Knowledge Base or Control Center User Guide.

Rate Plan Return Values and Descriptions
Return Value	Description
operatorName	The name of the operator associated with the logged in user.
operatorId	The identification number of the operator.
timeStamp	The point in time when the rate plan information was returned. The date format is yyyy-MM-ddTHH:mm:ss.SSSZ. See Date Formats for more details.
pageNumber	An integer specifying the number of the current response page. See Pagination.
Rate Plans
ratePlans	An array of rate plans.
name	Descriptive rate plan name. Names are unique within an operator.
id	Identifies a particular rate plan. Because a rate plan can have multiple versions, this value might not be unique. Version ID is the only unique rate plan identifier.
accountName	The name of the account using the rate plan. If the rate plan is available for multiple accounts to use, this value is Shared.
versionId	Uniquely identifies a particular version of a rate plan in relation to every other rate plan version in the system, including different versions of the same rate plan and different versions of other rate plans. Because a rate plan may have multiple active versions at any one time, the versionId, not the id, is the only truly unique rate plan identifier.
version	Specifies the version of the current rate plan. Two different versions of the same rate plan may coexist if there are billable devices assigned to each version (for prepaid plans only). All rate plans use the same version number sequence (1, 2, 3, and so on).
status	The function returns only published rate plans with the Published status value. Published rate plans are approved and available for use by devices.
type	The type refers to the payment method (monthly vs. prepaid) and included usage type (individual vs. pooled vs. event).
subscriptionCharge	For monthly rate plans, this charge is the monthly subscription fee for each of the subscribers in the tier. For prepaid rate plans, this is a one-time charge per subscriber that covers the entire term of the plan.
numberOfTiers	The number of tiers specifies how many subscription tiers the rate plan has. Each tier can have different subscription fees, account charges (for certain plan types), usage allotments, and overage charges.
tierTreatment	If this value is Retroactive, then all subscribers are charged the rate defined in the highest tier used. If the value is Incremental, each subscriber is charged the fee for its own tier. Fixed pool plans are limited to retroactive tier treatment only.
tiers	See Tiers.
expireTermBasedOnUsage	For prepaid rate plans, if set to true the rate plan is capped. When the device uses up the included usage allotment in the first zone, Control Center blocks network access and ends the subscription term.
lengthOfTerm	For prepaid rate plans, length of term is the term length measured in days or minutes. For monthly plans or add-on plans, which are limited to the current billing cycle only, this parameter has a zero value.
lengthOfTermUnit	The unit of measure for the term length. This parameter appears only if lengthOfTerm is present and has a non-zero value.
frequencyOfPerSubscriberCharge	For prepaid fixed pool rate plans, this value specifies how often the per-subscriber fee is charged: once during the term or at the end of each month. The subscriber must be active at the beginning of the month in order for the per subscriber charge to be charged at month-end. This parameter appears for prepaid fixed pool rate plans only.
subscriptionChargeUnit	The currency associated with the subscription. For more information about valid currency values, see Getting Started.
zones	See Zones.
dataUsage	See Data Usage.
smsUsage	See SMS Usage.
voiceUsage	See Voice Usage.
lastPage	(Optional) A true or false value indicating whether the current response page is the last in the series. See Pagination.

Tiers

Subscription Tier Parameters and Descriptions
Parameter	Description
tiers	An array of tiers that specify subscription charges.
tierLevel	This number identifies the tier level (1 - 5). If no tiers are used, the value is 0.
subscriberThreshold	This number identifies the first subscriber in the tier.
subscriberCapacity	This number identifies the last subscriber in the tier.
accountCharge	Fixed pool (both monthly and prepaid) and add-on rate plans may have an account charge. This parameter appears only when there is a non-zero value.
perSubscriberCharge	This charge is the monthly subscription fee for each of the subscribers in the tier. For prepaid rate plans, this is a one-time charge that covers the entire term of the plan.

Zones

Zone Parameters and Descriptions
Parameter	Description
zones	Indicates an array of zones will follow.
reportOverageAsRoaming	An array of zones. This array contains the default zone (called "default zone") as well as any others defined for the rate plan.
<zone name>	Each zone has a value of true or false that indicates whether or not Control Center categorizes the usage in the zone as roaming on the invoice.

Data Usage

Data Usage Parameters and Descriptions
Parameter	Description
dataUsage	The rates and settings for data usage.
useDefaultRating	If true, Control Center uses the rates and settings specified in the operator default pricing rate plan. Be aware there are no subscriber tiers or zones in the default pricing rate plan. If false, Control Center uses the rates and settings specified in the rate plan. See Data Default Pricing.
usageLimit	This parameter restricts the total amount of data a device can send or receive during a billing cycle. When a device reaches the usage limit, Control Center shuts down data access to the system for the rest of the billing cycle. If this parameter is missing, there is no usage limit.
usageLimitUnit	The data usage limit unit is MB per billing cycle (MB per cycle).
Zones
zones	An array of zones associated with the rate plan.
<zone name>	The name of a particular zone.
includedData	The included data value specifies the amount of data a device receives as part of the subscription fee. For fixed-pool rate plans, the included data appears in the sharedData parameter in each tier. The includedData parameter does not appear at all.
includedDataUnit	The included data unit is MB for monthly rate plans and MB per term for prepaid rate plans. This parameter is not included for fixed-pool plans.
zoneUsageLimitUnit	The zone usage limit unit is MB per subscriber (MB per subscriber).
bulkOverageEnabled	The bulk overage feature is available for monthly plans only. If set to true, the rate plan charges for data overage in discrete chunks rather than charging for overage on a per kilobyte basis. For example, the rate plan might charge a set fee for every gigabyte of overage. The account would pay for 1 gigabyte of overage regardless of whether the device on the rate plan had 4MB of overage or 800MB of overage. Similarly, the account would pay for two gigabytes of data if the device used between 1 and 2 gigabytes of overage. The rate plan can define data chunks of virtually any size (KB, MB, GB, and TB) for each zone in the rate plan.
bulkOverage	A number representing the size of the overage chunk. This parameter appears only when bulkOverageEnabled is set to true.
bulkOverageUnit	The unit of measure for the overage chunk. This parameter appears only when bulkOverageEnabled is set to true.
useTheseDataRoundingSettingsForAllZones	If set to true, the rounding rules apply to all zones. If set to false, each zone has its own rounding rules.
dataRoundingUnit	The data rounding unit determines whether Control Center rounds the amount of data up to the nearest 1KB, 10KB, 50KB or 1 MB before calculating the overage charges in a particular zone. This return value can also be None.
dataRoundingFrequency	The data rounding frequency determines how often Control Center rounds the data values ― every day, for each data session, or for each call detail record. The data rounding frequency values are Per CDR, Per Session or Daily.
Tiers
tiers	An array of subscription tiers. Each tier level can have different data overage charges.
tierLevel	This number identifies the tier level (1 - 5). If no tiers are used, the value is 0.
subscribersMoreThan	This number identifies the first subscriber in the tier.
subscribersUpTo	This number identifies the last subscriber in the tier.
sharedData	This parameter appears for fixed pool plans only. The number specifies the size of the pool that the devices on the plan can use.
sharedDataUnit	This parameter appears for fixed pool plans only. The shared data unit is always MB.
dataOverage	This number specifies the cost of each kilobyte of data used by the subscriber over the included amount specified in the includedData parameter. The unit of measure for this value is the default account currency. If the plan is pooled and there is surplus usage available, a single subscriber may exceed the individual usage allotment without being charged for overage. These numbers are per KB, not per MB. If useDefaultRating is true, Control Center supplies the data overage charge from the default pricing rate plan.
dataOverageUnit	The data overage unit is always KB (per KB).

Data Default Pricing

For rate plans that use default pricing for data service, the function returns fewer parameters.

Data Default Pricing Parameters and Descriptions
Parameter	Description
useDefaultRating	In this scenario, the parameter is always true.
dataOverage	This number specifies the cost of each kilobyte of data used by the subscriber. The unit of measure for this value is the default account currency.
dataOverageUnit	The data overage unit is a KB (per KB).

SMS Usage

SMS Usage Parameters and Descriptions
Parameter	Description
smsUsage	The rates and settings for SMS usage.
useDefaultRating	If true, Control Center uses the SMS rates and settings specified in the default pricing rate plan. Be aware there are no subscriber tiers or zones in the default pricing rate plan. If false, Control Center uses the SMS rates and settings specified in the rate plan. See SMS Default Pricing.
type	The type of rating for SMS usage: Subscription Tiers or Destination Based Rating. Subscription Tiers specifies different overage rates based on the number of subscribers using the rate plan. Destination Based Rating specifies different overage rates and included usage based on the SMS destination (for SMS MO). Each zone may contain one or more regions, each with different included usage and overage charges.
moAndMtRating	Available for rate plans with subscription tier-based SMS rating only. This parameter specifies whether SMS MO and SMS MT messages are rated together (Rate Both Together) or separately (Rate Both Separately).
poolSMSUsage	Available for rate plans with destination-based SMS rating only. If true, the rate plan pools SMS usage for all the subscribers using this rate plan.
poolSMSMTUsage	Available for rate plans with destination-based SMS rating only. If true, the rate plan pools SMS MT usage for all the subscribers using this rate plan.
poolSMSMOUsage	Available for rate plans with destination-based SMS rating only. If true, the rate plan pools SMS MO usage for all the subscribers using this rate plan.
Zones
zones	An array of zones associated with the rate plan.
<zone name>	The name of a particular zone.
includedSMS	The included SMS value specifies the number of text messages a device can send or receive as part of the subscription fee. If mobile-terminated (SMS MT) and mobile-originated (SMS MO) messages are rated separately, this parameter is replaced by separate parameters for includedSMSMO and includedSMSMT. For fixed-pool rate plans, the included SMS appears in the sharedSMS parameter in each tier. The includedSMS parameter does not appear at all. If the rate plan type is Destination Based Rating, the included usage is for mobile-terminated messages only (includedSMSMT). The included usage for mobile-originated messages appears in a group array within each zone.
includedSMSUnit	The included SMS unit (SMS MT or SMS MO) is a message (msgs). If mobile-terminated (SMS MT) and mobile-originated (SMS MO) messages are rated separately, this parameter is replaced by separate parameters for includedSMSMOUnit and includedSMSMTUnit. This parameter is not included for fixed-pool plans. If the rate plan type is Destination Based Rating, the included SMS unit is for mobile-terminated messages only (includedSMSMTUnit). The included SMS unit for mobile-originated messages appears in a group array within each zone.
smsOverage	This number specifies the cost of each mobile-terminated message used by the subscriber in excess of the number specified in the includedSMSMT field. The unit of measure for this value is the default account currency. The parameter appears in this location (the zones array) only when the rate plan type is Destination Based Rating. In this scenario, the overage cost for mobile-originate messages appears in the groups array.
smsOverageUnit	The SMS MT overage unit is a message (per MT msg). The parameter appears in this location (the zones array) only when the rate plan type is Destination Based Rating. In this scenario, the overage unit for mobile-originated messages appears in the groups array.
Tiers
tiers	An array of subscription tiers. Each tier level can have different SMS overage charges. Tiers are used only when the rate plan type is Subscription Tiers.
tierLevel	This number identifies the tier level (1 - 5). If no tiers are used, the value is 0.
subscribersMoreThan	This number identifies the first subscriber in the tier.
subscribersUpTo	This number identifies the last subscriber in the tier.
sharedSMS	For fixed pool rate plans only. This number specifies the size of the pool that the devices on the plan can use. If mobile-terminated (SMS MT) and mobile-originated (SMS MO) messages are rated separately, this parameter is replaced by separate parameters for sharedSMSMO and sharedSMSMT.
sharedSMSUnit	For fixed pool rate plans only. The shared SMS unit is a message (msgs). If mobile-terminated (SMS MT) and mobile-originated (SMS MO) messages are rated separately, this parameter is replaced by separate parameters for sharedSMSMOUnit and sharedSMSMTUnit.
smsOverage	This number specifies the cost of each message used by the subscriber in excess of the number specified in the includedSMS field. The unit of measure for this value is the default account currency. If mobile-terminated (SMS MT) and mobile-originated (SMS MO) messages are rated separately, this parameter is replaced by separate parameters for smsOverageMO and smsOverageMT.
smsOverageUnit	The SMS overage unit is a message (per msg). If mobile-terminated (SMS MT) and mobile-originated (SMS MO) messages are rated separately, this parameter is replaced by separate parameters for smsOverageMOUnit and smsOverageMTUnit with the values per MO msg and per MT msg.
Groups
groups	An array of billing groups. This array appears only when the rate plan type is Destination Based Rating.
name	The name of a billing group.
includedSMSMO	The included SMS value specifies the number of text messages a device can send as part of the subscription fee. For fixed-pool rate plans, the included SMS MO appears in the sharedSMSMO parameter. The includedSMSMO parameter does not appear at all.
includedSMSMOUnit	The included SMS MO unit is a message (msgs). This parameter is not included for fixed-pool plans.
sharedSMSMO	For fixed pool rate plans only. This number specifies the size of the SMS MO pool that the devices on the plan can use.
sharedSMSMOUnit	For fixed pool rate plans only. The shared SMS unit is a message (msgs).
smsMOOverage	This number specifies the cost of each message used by the subscriber in excess of the number specified in the includedSMSMO field. The unit of measure for this value is the default account currency.
smsMOOverageUnit	The SMS MO overage unit is a message (msgs).

SMS Default Pricing

For rate plans that use default pricing for SMS service, the function returns fewer parameters.

SMS Default Pricing Parameters and Descriptions
Parameter	Description
useDefaultRating	In this scenario, the parameter is always true.
poolSMSUsage	These three pooled usage parameters are always included and always set to false.
poolSMSMOUsage
poolSMSMTUsage
smsMOOverage	This number specifies the cost of each message sent by the subscriber. The unit of measure for this value is the default account currency.
smsMOOverageUnit	The SMS MO overage unit is a message (per MO msg).
smsMTOverage	This number specifies the cost of each message received by the subscriber. The unit of measure for this value is the default account currency.
smsMTOverageUnit	The SMS MT overage unit is a message (per MT msg).

Voice Usage

Voice Usage Parameters and Descriptions
Parameter	Description
voiceUsage	The rates and settings for voice usage.
useDefaultRating	If true, Control Center uses the voice rates and settings specified in the default pricing rate plan. Be aware there are no subscriber tiers or zones in the default pricing rate plan. If false, Control Center uses the voice rates and settings specified in the rate plan. See Voice Usage.
type	The type of rating for voice usage: Subscription Tiers or Destination Based Rating. Subscription Tiers specifies different overage rates based on the number of subscribers using the rate plan. Destination Based Rating specifies different overage rates and included usage based on the voice destination (for voice MO). Each zone may contain one or more regions, each with different included usage and overage charges.
moAndMtRating	Available for rate plans with tier-based voice rating only. This parameter specifies whether voice MO and voice MT minutes are rated together (Rate Both Together) or separately (Rate Both Separately).
poolVoiceUsage	Available for rate plans with destination-based voice rating only. If true, the rate plan pools voice usage for all the subscribers using this rate plan.
poolVoiceMTUsage	Available for rate plans with destination-based voice rating only. If true, the rate plan pools voice MT usage for all the subscribers using this rate plan.
poolVoiceMOUsage	Available for rate plans with destination-based voice rating only. If true, the rate plan pools voice MO usage for all the subscribers using this rate plan.
Zones
zones	An array of zones associated with the rate plan.
<zone name>	The name of a particular zone.
includedVoice	The included voice value specifies the number of voice minutes a device receives as part of the subscription fee. If mobile-terminated (voice MT) and mobile-originated (voice MO) calls are rated separately, this parameter is replaced by separate parameters for includedVoiceMO and includedVoiceMT. For fixed-pool rate plans, the included voice appears in the sharedVoice parameter in each tier. The includedVoice parameter does not appear at all. If the rate plan type is Destination Based Rating, the included usage is for mobile-terminated calls only (includedVoiceMT). The included usage for mobile-originated calls appears in a group array within each zone.
includedVoiceUnit	The included voice unit (voice MT or voice MO) is minutes:seconds (m:ss). If mobile-terminated (voice MT) and mobile-originated (voice MO) messages are rated separately, this parameter is replaced by separate parameters for includedVoiceMOUnit and includedVoiceMTUnit. This parameter is not included for fixed-pool plans. If the rate plan type is Destination Based Rating, the included voice unit is for mobile-terminated calls only (includedVoiceMTUnit). The included voice unit for mobile-originated calls appears in a group array within each zone.
voiceOverage	This number specifies the cost of each mobile-terminated minute used by the subscriber in excess of the number specified in the includedVoiceMT field. The unit of measure for this value is the default account currency. The parameter appears in this location (the zones array) only when the rate plan type is Destination Based Rating. In this scenario, the overage cost for mobile-originated minutes appears in the groups array.
voiceOverageUnit	The voice MT overage unit is a minute (per MT min). The parameter appears in this location (the zones array) only when the rate plan type is Destination Based Rating. In this scenario, the overage unit for mobile-originated messages appears in the groups array.
useTheseDataRoundingSettingsForAllZones	If set to true, the voice rounding rules apply to all zones. If set to false, each zone has its own rounding rules.
voiceRoundingUnit	Control Center rounds the voice usage up to the nearest minute or second before calculating the overage charges in a particular zone. Valid values are minutes (minutes) and seconds (seconds).
Tiers
tiers	An array of subscription tiers. Each tier level can have different voice overage charges. This array appears only when the rate plan type is Subscription Tiers.
tierLevel	This number identifies the tier level (1 - 5). If no tiers are used, the value is 0.
subscribersMoreThan	This number identifies the first subscriber in the tier.
subscribersUpTo	This number identifies the last subscriber in the tier.
sharedVoice	This parameter appears for fixed pool rate plans only. The number specifies the size of the pool that the devices on the plan can use. If mobile-terminated (voice MT) and mobile-originated (voice MO) calls are rated separately, this parameter is replaced by separate parameters for sharedVoiceMO and sharedVoiceMT.
sharedVoiceUnit	This parameter appears for fixed pool rate plans only. The shared voice unit is minutes:seconds (m:ss). If mobile-terminated (voice MT) and mobile-originated (voice MO) calls are rated separately, this parameter is replaced by separate parameters for sharedVoiceMOUnit and sharedVoiceMTUnit.
voiceOverage	This parameter specifies the cost of each minute used by the subscriber in excess of the number specified in the includedVoice parameter. The unit of measure for this value is the default account currency. If mobile-terminated (voice MT) and mobile-originated (voice MO) calls are rated separately, this parameter is replaced by separate parameters for voiceOverageMO and MTvoiceOverage. For rate plans with destination-based rating, voiceOverage applies to voice MT overage only.
voiceOverageUnit	The data overage unit is a minute (per min). If mobile-terminated (voice MT) and mobile-originated (voice MO) calls are rated separately, this parameter is replaced by separate parameters for voiceOverageMOUnit and voiceOverageMTUnit with the values per MO min and per MT min. For rate plans with destination-based rating, voiceOverageUnit applies to voice MT overage only with a value of per MT min.
Groups
groups	An array of billing groups. This array appears only when the rate plan type is Destination Based Rating.
name	The name of a billing group.
includedVoiceMO	The included voice value specifies the number of call minutes a device can use as part of the subscription fee. For fixed-pool rate plans, the included voice MO appears in the sharedVoiceMO parameter. The includedVoiceMO parameter does not appear at all.
includedVoiceMOUnit	The included voice MO unit is minutes:seconds (m:ss). This parameter is not included for fixed-pool plans.
sharedVoiceMO	For fixed pool rate plans only. This number specifies the size of the voice MO pool that the devices on the plan can use.
sharedVoiceMOUnit	For fixed pool rate plans only. The shared voice unit is minutes:seconds (m:ss).
voiceMOOverage	This number specifies the cost of each minute used by the subscriber in excess of the number specified in the includedVoiceMO field. The unit of measure for this value is the default account currency.
voiceMOOverageUnit	The voice MO overage unit is a minute (Per Min).

Voice Default Pricing

For rate plans that use default pricing for voice service, the function returns fewer parameters.

Voice Default Pricing Parameters and Descriptions
Parameter	Description
useDefaultRating	In this scenario, the parameter is always true.
poolVoiceUsage	These three pooled usage parameters are always included and always set to false.
poolVoiceMOUsage
poolVoiceMTUsage
voiceMOOverage	This number specifies the cost of each minute used by the subscriber during an outgoing call. The unit of measure for this value is the default account currency.
voiceMOOverageUnit	The voice MO overage unit is a minute (per MO min).
voiceMTOverage	This number specifies the cost of each minute used by the subscriber during an incoming call. The unit of measure for this value is the default account currency.
voiceMTOverageUnit	The voice MT overage unit is a minute (per MT min).

Request Example

Make sure to use your own URL and user credentials.

curl -X GET --header "Accept: application/json" --header "Authorization: Basic <YOUR-ENCRYPTED-CREDENTIALS>" "https://<YOUR-BASE-URL>/rws/api/v1/rateplans?pageSize=50&pageNumber=1"

Response Example

markup

Copy{
   "operatorName": "Jasper Systems",
   "operatorId": 8410,
   "timeStamp": "2019-03-15T18:02:25.013Z",
   "pageNumber": 1,
   "ratePlans": [
   {
      "name": "QaAwtRP-180421030819",
      "id": 30884203,
      "accountName": "Shared",
      "versionId": 30885703,
      "version": 1,
      "status": "Published",
      "type": "Monthly - Individual Subscriber",
      "subscriptionCharge": 0,
      "numberOfTiers": 1,
      "tierTreatment": "Incremental",
      "tiers": [
      {
         "tierLevel": 0,
         "subscriberThreshold": 0,
         "subscriberCapacity": "And Up",
         "perSubscriberCharge": 0
      }
      ],
      "expireTermBasedOnUsage": false,
      "lengthOfTerm": 0,
      "subscriptionChargeUnit": "USD",
      "zones": 
      {
         "reportOverageAsRoaming": 
         {
            "default zone": "false"
         }
      },
      "dataUsage": 
      {
         "useDefaultRating": false,
         "usageLimitUnit": "MB per cycle",
         "zones": 
         {
            "default zone": 
               {
                  "includedData": 0,
                  "includedDataUnit": "MB",
                  "zoneUsageLimitUnit": "MB per subscriber",
                  "bulkOverageEnabled": false,
                  "useTheseDataRoundingSettingsForAllZones": true,
                  "dataRoundingUnit": "None",
                  "dataRoundingFrequency": "Per CDR",
                  "tiers": [
                  {
                     "tierLevel": 0,
                     "subscribersMoreThan": 0,
                     "subscribersUpTo": "And Up",
                     "sharedData":0,
                     "sharedDataUnit":"MB",				
                     "dataOverage": 0,
                     "dataOverageUnit": "per KB"
                  }
                  ]
               }
            }
         },
         "smsUsage": 
         {
            "useDefaultRating": false,
            "type": "Subscription Tiers",
            "moAndMtRating": "Rate Both Together",
            "poolSMSUsage": false,
            "poolSMSMOUsage": false,
            "poolSMSMTUsage": false,
            "zones": 
            {
               "default zone": 
               {
                  "includedSMS": 0,
                  "includedSMSUnit": "msgs",
                  "tiers": [
                     {
                        "tierLevel": 0,
                        "subscribersMoreThan": 0,
                        "subscribersUpTo": "And Up",
                        "sharedSMS":0
                        "sharedSMSUnit":"msgs",					
                        "smsOverage": 0,
                        "smsOverageUnit": "per msg"
                     }
                     ]
                  }
               }
            },
            "voiceUsage": {
               "useDefaultRating": false,
               "type": "Subscription Tiers",
               "moAndMtRating": "Rate Both Together",
               "poolVoiceUsage": false,
               "poolVoiceMTUsage": false,
               "poolVoiceMOUsage": false,
               "zones": {
                  "default zone": {
                     "includedVoice": "0:00",
                     "includedVoiceUnit": "m:ss",
                     "useTheseDataRoundingSettingsForAllZones": true,
                     "voiceRoundingUnit": "minutes",
                     "tiers": [
                        {
                           "tierLevel": 0,
                           "subscribersMoreThan": 0,
                           "subscribersUpTo": "And Up",
                           "voiceOverage": 0.03,
                           "voiceOverageUnit": "per min"
                        }
                     ]
                  }
               }
            }
   },
   ],
   "lastPage": true
}

Code Samples

Make sure to use your own URL and user credentials.

python

javascript

ruby

Copyimport requests
import json
import base64
import pprint
 
apiUrl= 'https://<your-base-URL>/rws/api/v1/rateplans'

parameters= {'accountId':"acct_id", 'pageSize': "page_size", 'pageNumber': "page_number"}

myResponse = requests.get(url=apiUrl, auth=(raw_input("username: "),raw_input("api_key: ")), params=parameters)
# For successful API call, response code will be 200 (OK)
if(myResponse.ok):
	# Loading the response data into a dict variable
	# json.loads takes in only binary or string variables so using content to fetch binary content
	# Loads (Load String) takes a Json file and converts into python data structure (dict or list, depending on JSON)
	pp = pprint.PrettyPrinter(indent=4)
	jData = json.loads(myResponse.content)
	pp.pprint(jData)
else:
	# If response code is not ok (200), print the resulting http error code with description
	myResponse.raise_for_status()

Copyvar request = require('request');
var body = [];
request.get('https://<your-base-URL>/rws/api/v1/rateplans?accountId=acct_id&pageSize=page_size&pageNumber=page_number').auth('user_name', 'password', false)
    .on('error', function(error){
        console.log('Error:', error);
    })
    .on('response', function(response) {
        console.log(response.statusCode); // return statusCode
        console.log(response.headers['content-type']); // return contentType
    })
    .on('data',function(chunk){
        body.push(chunk);
    })
    .on('end',function(){
        body = Buffer.concat(body).toString();
        console.log(body);
    });

Copy#!/usr/bin/ruby -w
require 'rest-client' 
require 'json' 
     
url = 'https://<your-base-URL>/rws/api/v1/rateplans?accountId=acct_id&pageSize=page_size&pageNumber=page_number' 
response = RestClient::Request.execute(
	method: :get,
	url: url,
	user: 'user_name',
	password: 'password',
	:headers => {:accept => :json}
)
puts JSON.pretty_generate(JSON.parse(response))

Errors

Error Codes, HTTP Codes, and Descriptions
Error Code	HTTP Code	Error Message
10000004	400	Invalid accountId.
10000006	400	Invalid pageSize.
10000007	400	Invalid pageNumber.
10000024	400	Invalid apiVersion.
10000436	400	Shared can only be true.
10000437	400	Shared can not be used along with accountId.
20000000	404	Requested resource not found.
30000001	500	Unknown server error.