Skip to content

Get tariff plans

Getting tariff plans available to an agent

Method get.tariff_plans
Description Getting tariff plans available to an agent
Who has access Agent

Parameters of a request

Title Type Required Description
access_token string yes Authentication session key
limit number no Returning entries count. Refer to "Paging"
offset number no Offset that defines from which number to return the entries "limit". Default value is "0". Refer to "Paging"
filter object no Refer to "Filters"
fields array no Refer to "Viewing returning data"
sort array no Refer to "Data sorting"

Parameters of a reply

Title Type Required Description
id number yes Tariff plan unique ID
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 reply structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string"
      }
    ]
  }
}

List of returning errors

Refer to the section "List of errors for the methods with the verb get"