# Plan

## Plan object

```json
{
  "id": 10,
  "name": "Business",
  "group_id": 2,
  "active": true,
  "type": "monthly",
  "price": 13.0,
  "early_change_price": 23.0,
  "device_limit": 1000,
  "has_reports": true,
  "paas_free": false,
  "store_period": "12m",
  "features": [
    "map_layers"
  ],
  "map_filter": {
    "exclusion": true,
    "values": []
  }
}
```

* `id` - int. Unique ID.
* `name` - string. Plans's label.
* `group_id` - int. Group of plans. User can change the plan only on the plan in the same group.
* `active` - boolean. Plan is active if `true`. User can change the plan only on the active plan.
* `type` - [enum](https://navixy.com/docs/navixy-api/user-api/backend-api/..#data-types). Plan type. Can be "monthly", "everyday", "activeday".
* `price` - double. Price per month for "monthly" and "everyday" plan or price per "active" day for "activeday" plan.
* `early_change_price` - double. Price of change plan from current to another. With the last change in less than 30 days (**tariff.freeze.period** config option). When not passed or "null" user cannot change plan frequently.
* `device_limit` - int. Maximum number of devices per account.
* `has_reports` - boolean. `true` if reports allowed, `false` otherwise.
* `paas_free` - boolean. `true` if this plan is free for PaaS owner, `false` otherwise.
* `store_period` - string. Data storage period, e.g. "2h" (2 hours), "3d" (3 days), "5m" (5 months), "1y" (one year).
* `features` - string array. Available features for the user.
* `map_filter` - object with available maps for the user.
  * `exclusion` - boolean. If `true` maps from `values` will be not active, `false` - maps from values will be active.

## API actions

API path: `/tariff`.

### list

Gets list of device's plans available to user. If user's dealer is **default dealer** or **paas** then listed tariffs of that dealer, else listed plans of parent dealer.\
Listed only plans available for user's legal type.

#### Parameters

Only API key `hash`.

#### Examples

{% tabs %}
{% tab title="cURL" %}

```sh
curl -X POST 'https://api.eu.navixy.com/v2/tariff/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b"}'
```

{% endtab %}

{% tab title="HTTP GET" %}

```http
https://api.eu.navixy.com/v2/tariff/list?hash=a6aa75587e5c59c32d347da438505fc3
```

{% endtab %}
{% endtabs %}

#### Response

```json
{
  "success": true,
  "list": [
    {
      "id": 10,
      "name": "Business",
      "group_id": 2,
      "active": true,
      "type": "monthly",
      "price": 13.0,
      "early_change_price": 23.0,
      "device_limit": 1000,
      "has_reports": true,
      "paas_free": false,
      "store_period": "12m",
      "features": [
        "map_layers"
      ],
      "map_filter": {
        "exclusion": true,
        "values": []
      }
    }
  ]
}
```

* `list` - array of objects. List of [plan objects](#plan-object).

#### Errors

* [General](https://navixy.com/docs/navixy-api/user-api/errors#error-codes) types only.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/backend-api/resources/billing/tariff/index.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.