Tariff (plan)

The service plans a device can be on, and what each one allows.

A tariff is the service plan a device is on. It decides what the device costs, what features it has, how long its history is stored, and how many devices the account may hold.

Tariff and plan are the same thing. The API uses both words. The path is /tariff and the field naming one is tariff_id, but the object returned is Plan and the operation summaries say "List plans" and "Change tracker plan". The Navixy interface calls it a plan.

This page uses tariff for the resource and Plan for the object it returns, matching the Admin Panel API, which names the same resource.

This operation lists the tariffs available to the account. To see or change the tariff of one device, use tracker tariffs.

Plan object

API actions

API base path: /tariff.

Operations that list no errors of their own return only the general error codes.

---

List plans

post

/tariff/list

List the device plans available to the current user.

Plans come from the user's dealer when that dealer is the default dealer or a PaaS dealer, and from the parent dealer otherwise. Only plans allowed for the user's legal type are listed.

Callable with an empty body. Also accepts GET.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Responses

200

Available plans

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/tariff/list

POST /v2/tariff/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "list": [
    {
      "id": 1,
      "name": "text",
      "group_id": 1,
      "active": true,
      "type": "monthly",
      "price": 1,
      "early_change_price": 1,
      "device_limit": 1,
      "has_reports": true,
      "paas_free": true,
      "store_period": "text",
      "auto_prolong": true,
      "features": [
        "api"
      ],
      "map_filter": {
        "exclusion": true,
        "values": [
          "text"
        ]
      }
    }
  ]
}

More in this section

Tracker tariff

Endpoint	Method	What it does
/tariff/tracker/change	POST	Change tracker plan
/tariff/tracker/list	POST	List plans for tracker