Skip to content

Getting the tariff plans available to an agent

Getting the tariff plans available to an agent

Method get.tariff_plans
Description Getting the tariff plans available to an agent
Available to Agent

Request parameters

Name Type Required Description
access_token string yes Authentication session key
limit number no Number of records returned. See section "Paging"
offset number no Offset defining the record number from which to return "limit" records. The default is "0". See section "Paging"
filter object no See section "Filtering criteria"
fields array no See section "Viewing returned data"
sort array no See section "Sorting data"

Response parameters

Name Type Required Description
id number yes Unique tariff plan identifier
name string yes Tariff plan name

JSON request structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "get.tariff_plans",
    "params": {
        "access_token": "string",
        "offset": "number",
        "limit": "number",
        "filter": {},
        "sort": [
            { "field": "string", "order": "string" }
        ],
        "fields": [ "string" ]
    }
}

JSON response structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            {
                "id": "number",
                "name": "string"
            }
        ]
    }
}

List of returned errors

See the section "List of errors for methods with the get method".