billing_plan.list
The billing_plan.list command retrieves a list of billing plans.
TR50 Request
{
"cmd": {
"command": "billing_plan.list",
"params": {
"sort": "+name",
"offset": 0,
"limit": 10,
"published": false
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
sort | String | sort is an optional parameter that defines the sort order of the result set. It allows to arrange the list in either ascending(+) or descending(-) order. It is possible to sort billing_plan.list in the following categories:
|
|
offset | Integer | The starting list offset, used for pagination. Defaults to 0 if not specified. | |
limit | Integer | Limits the number of results returned. Defaults to 2000. | |
published | Boolean | If the billing plan is in a published state. |
TR50 Response
If the command is sent successfully a success message and the list of billing plan objects is returned. Otherwise, an error and error message will be returned.
{
"cmd": {
"success": true,
"params": {
"count": 10,
"result": [
{
"id": "500000000000000000000001"
"name": "The Billing Plan Name",
"code": "thebillingplancode",
"mno": "The MNO",
"comments": "A comment",
"published": true,
"orgId": "500000000000000000000001",
"createdBy": "user@example.com",
"createdOn": "2014-01-31T13:03:15.31-05:00",
"updatedBy": "user@example.com",
"updatedOn": "2014-01-31T13:03:15.31-05:00"
},
...
]
}
}
}
Response Parameters
Name | Type | Description |
---|---|---|
count | Integer | The total number of billing plans. |
result | Array | The array of billing plan objects. |
Result Array Object
Name | Type | Description |
---|---|---|
id | String | The object id of the billing plan. |
name | String | The name of the billing plan. |
mno | String | The MNO of the billing plan. |
comments | String | Comments associated with the billing plan. |
published | Boolean | If the billing plan is in a published state, and can be associated to things and connections. |
orgId | String | The object ID of the organization associated with the billing plan. |
createdBy | String | The email address of the user who created the billing plan. |
createdOn | String | The timestamp that the billing plan was created. |
updatedBy | String | The email address of the user who last updated the billing plan. |
updatedOn | String | The timestamp that the billing plan was updated. |