v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Tariff

Retrieve your tariff and prices.

Required scope: tariffs:read

get/api/v1/tariffs/{tariffId}

Path parameters

tariffIdinteger required

Query parameters

endstring date-time

Example:2022-05-22T09:30:03Z

Filter to retrieve charges where createdAt <= end (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

startstring date-time

Example:2022-05-22T09:30:03Z

Filter to retrieve tariffs where createdAt >= start (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Response

Tariff with provided id

Example response

{
  "tariff": {
    "id": 1,
    "externalId": "3143",
    "name": "Cerius",
    "description": "TariffDescription",
    "countryId": 194,
    "countryAreaId": 1,
    "currencyId": 1,
    "teamId": 1,
    "operatorId": 1,
    "pricesWithVat": true,
    "zipCodes": [
      5610,
      5960
    ],
    "active": true,
    "timeZone": "Europe/Copenhagen",
    "area": "Jylland",
    "createdAt": "2023-03-23T14:54:56Z",
    "updatedAt": "2023-03-23T16:54:56Z"
  }
}