> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/billing/tariff.md). # 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. {% hint style="info" %} **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](/docs/navixy-api/panel-api/resources/tariff.md), which names the same resource. {% endhint %} This operation lists the tariffs available to the account. To see or change the tariff of one device, use [tracker tariffs](/docs/navixy-api/user-api/resources/billing/tariff/tariff_tracker.md). ## Plan object ## The Plan object ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"Plan":{"type":"object","description":"A device plan, called a tariff in older parts of the API.","properties":{"id":{"type":"integer","description":"Unique ID."},"name":{"type":"string","description":"The plan's label."},"group_id":{"type":"integer","description":"Group of plans. A user can only switch to a plan in the same group."},"active":{"type":"boolean","description":"`true` when users may switch to this plan on their own. A user can only switch to an active plan."},"type":{"type":"string","description":"Plan type. The published prose omits `every_year`.","enum":["monthly","everyday","activeday","every_year"]},"price":{"type":"number","description":"Price per month for a `monthly` or `everyday` plan, or price per active day for an `activeday` plan."},"early_change_price":{"type":"number","description":"Price of changing from this plan to another when the last change was less than the freeze period ago, 30 days by default under the `tariff.freeze.period` config option. **Absent when the user may not change plan early**, in which case frequent changes are refused outright."},"device_limit":{"type":"integer","description":"Maximum number of devices per account on this plan."},"has_reports":{"type":"boolean","description":"`true` when reports are allowed."},"paas_free":{"type":"boolean","description":"`true` when this plan is free for the PaaS owner."},"store_period":{"type":"string","description":"Data storage period, such as `2h` for two hours, `3d` for three days, `5m` for five months, or `1y` for one year."},"auto_prolong":{"type":"boolean","description":"Whether the plan renews automatically. Not documented in the published object description."},"features":{"type":"array","description":"Features this plan makes available to the user.","items":{"type":"string","enum":["api","app_tasks","app_fleet","batch_operations","custom_maps","event_notification","geocoding","lbs","map_layers","multilevel_access","priority_support","retranslation","report_xls","report_scheduled","routing","ui_mobile","weblocator","chat","statuses","street_view","driver_journal","checkin","custom_fields","task_route_import"]}},"map_filter":{"type":"object","description":"Which maps the user may use.","properties":{"exclusion":{"type":"boolean","description":"When `true` the maps in `values` are the ones **not** available. When `false` they are the only ones available."},"values":{"type":"array","description":"Map types the filter applies to.","items":{"type":"string"}}}}}}}}} ``` ## API actions API base path: `/tariff`. Operations that list no errors of their own return only the [general error codes](/docs/navixy-api/general/errors.md#error-codes). *** ## List plans > 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. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Billing","description":"Bills, payment systems, subscriptions, device plans and the transaction log. All resources under the /bill/, /payment_system/, /subscription/, /tariff/ and /transaction/ paths."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"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.","name":"Authorization","in":"header"}},"schemas":{"Plan":{"type":"object","description":"A device plan, called a tariff in older parts of the API.","properties":{"id":{"type":"integer","description":"Unique ID."},"name":{"type":"string","description":"The plan's label."},"group_id":{"type":"integer","description":"Group of plans. A user can only switch to a plan in the same group."},"active":{"type":"boolean","description":"`true` when users may switch to this plan on their own. A user can only switch to an active plan."},"type":{"type":"string","description":"Plan type. The published prose omits `every_year`.","enum":["monthly","everyday","activeday","every_year"]},"price":{"type":"number","description":"Price per month for a `monthly` or `everyday` plan, or price per active day for an `activeday` plan."},"early_change_price":{"type":"number","description":"Price of changing from this plan to another when the last change was less than the freeze period ago, 30 days by default under the `tariff.freeze.period` config option. **Absent when the user may not change plan early**, in which case frequent changes are refused outright."},"device_limit":{"type":"integer","description":"Maximum number of devices per account on this plan."},"has_reports":{"type":"boolean","description":"`true` when reports are allowed."},"paas_free":{"type":"boolean","description":"`true` when this plan is free for the PaaS owner."},"store_period":{"type":"string","description":"Data storage period, such as `2h` for two hours, `3d` for three days, `5m` for five months, or `1y` for one year."},"auto_prolong":{"type":"boolean","description":"Whether the plan renews automatically. Not documented in the published object description."},"features":{"type":"array","description":"Features this plan makes available to the user.","items":{"type":"string","enum":["api","app_tasks","app_fleet","batch_operations","custom_maps","event_notification","geocoding","lbs","map_layers","multilevel_access","priority_support","retranslation","report_xls","report_scheduled","routing","ui_mobile","weblocator","chat","statuses","street_view","driver_journal","checkin","custom_fields","task_route_import"]}},"map_filter":{"type":"object","description":"Which maps the user may use.","properties":{"exclusion":{"type":"boolean","description":"When `true` the maps in `values` are the ones **not** available. When `false` they are the only ones available."},"values":{"type":"array","description":"Map types the filter applies to.","items":{"type":"string"}}}}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tariff/list":{"post":{"tags":["Billing"],"summary":"List plans","description":"List the device plans available to the current user.\n\nPlans 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.\n\nCallable with an empty body. Also accepts GET.","operationId":"tariffList","responses":{"200":{"description":"Available plans","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}}}}}}},"400":{"description":"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.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` ## More in this section #### Tracker tariff | Endpoint | Method | What it does | | --------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------- | | [`/tariff/tracker/change`](/docs/navixy-api/user-api/resources/billing/tariff/tariff_tracker.md#post-tariff-tracker-change) | POST | Change tracker plan | | [`/tariff/tracker/list`](/docs/navixy-api/user-api/resources/billing/tariff/tariff_tracker.md#post-tariff-tracker-list) | POST | List plans for tracker | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/billing/tariff.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.