Retrieve Rate Plan List
# Retrieve the Rate Plan List ### `GET /v2/triggers/rateplanlist/{ecpdId}` Retrieves the rate plans and rate plan details for an account. ## Header Parameters The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | | :------------------------------ | :--------- | :---------------------------------------------------------------- | | **Authorization** *(required)* | string | HTTP Authorization bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token: `VZ-M2M-Token: {M2Mtoken}` | | **Content-Type** *(required)* | string | Must be application/json `Content-Type: application/json` | ## HTTP Request [GET https://thingspace.verizon.com/api/m2m/v2/triggers/rateplanlist/{ecpdId}](/docs/standard-apis/rules-engine-2-0/api-endpoints/retrieve-price-plan-lists/getrateplanlist) ## Resource Path and Query Parameters | Parameter Name | Data Type | Description | |:----------------|:-----------|:-------------| | **ecpdId** *(required)* | string | The Enterprise Customer Profile Database ID (ECPD ID), which is the same value as the `accountName`. | ## Success Responses **Status 200** Example Success Response: ```json { "ratePlanGroup": [ { "ratePlanGroupDescription": "AGS Description_73", "ratePlanType": "AccountShareGroup", "ratePlan": [ { "description": "PlanDescription 1", "sizeKb": 512000, "carrierRatePlanCode": "6666893", "zeroDollarBilling": false, "promotionOffered": false, "promotionDays": -2147483648, "ratePlanType": "AccountShare", "account": [ { "accountName": "0000123456-00001", "mtasAccountNumber": "0000123456-00001" }, { "accountName": "0000123456-00001", "mtasAccountNumber": "0000123456-00001" } ] }, { "description": "PlanDescription 2", "sizeKb": 1048576, "carrierRatePlanCode": "6666894", "zeroDollarBilling": false, "promotionOffered": false, "promotionDays": -2147483648, "ratePlanType": "AccountShare", "account": [ { "accountName": "0000123456-00001", "mtasAccountNumber": "0000123456-00001" }, { "accountName": "0000123456-00001", "mtasAccountNumber": "0000123456-00001" } ] } ] } ] } ``` ## Success Parameters | Parameter Name | Data Type | Description | |----------------|-----------|----------------------------------------| | **ratePlanGroup** | array | An array of the rate plan groups and the details of the rate plans within the group. | | **ratePlanGroup.ratePlanGroupDescription** | string | The description of the rate plan group. | | **ratePlanGroup.ratePlanType** | string | The type of the rate plan group. | | **ratePlanGroup.ratePlan** | array | Contains all the rate plans and their details for a specific profile ID | | **ratePlanGroup.ratePlan.description** | string | The description of the service plan. | | **ratePlanGroup.ratePlan.sizeKb** | string | The allowance of the service plan in increments of Kilobytes (1,024 Bytes). | | **ratePlanGroup.ratePlan.carrierRatePlanCode** | string | The numeric service plan ID. | | **ratePlanGroup.ratePlan.zeroDollarBilling** | boolean | If the rate plan bills for zero dollars: <br> **true** - The rate plan bills for zero dollars <br> **false** - the rate plan bills based on the rate plan code | | **ratePlanGroup.ratePlan.promotionOffered** | boolean | If there is a promotion associated with the rate plan: <br> **true** - there is a promotion offered <br> **false** - there is no promotion | | **ratePlanGroup.ratePlan.promotionDays** | integer | The number of whole days the promotion will last, if offered. <br>**Note**: if no promotion offered, this value will show as "-2147483648" | | **ratePlanGroup.ratePlan.ratePlanType** | string | This will show the type of rate plan the record is for. Valid values are: <br> **StandAlone** <br> **AccountGroupShare** <br> **PayAsYouGo** <br> **AccountShare** <br> **DeviceGroupShare** | | **ratePlanGroup.ratePlan.account** | array | An array of the individual account IDs associated with the `accountName` | | **ratePlanGroup.ratePlan.account.accountName** | string | The numeric billing account name and must include any leading zeros | | **ratePlanGroup.ratePlan.account.mtasAccountNumber** | string | The numeric billing account number and must include any leading zeros | ## Failure Responses All error messages are returned in this format: ```json { "error": "error code string", "error_description": "error message string", } ``` Error codes and messages are listed on the [Error Messages page](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/error-messages/synchronous-errors), along with explanations and suggestions for corrective actions.