v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Tariff

Update an existing Tariff.

Required scope: tariffs:write<br/><br/>Note: Once you are done with creating/updating tariffs and its components you have to call the create-prices endpoint to create the prices for the tariff.

put/api/v1/tariffs/{tariffId}

Path parameters

tariffIdinteger required

Request body

externalIdstring required

external id

namestring required

Radius Elnet A/S

descriptionstring required

Short description of this tariff

countryIdinteger required

Id of the country where the tariff is applicable

countryAreaIdinteger nullable

Id of the country area where the tariff is applicable

currencyIdinteger required

Id of the currency in which the tariff is applicable

teamIdinteger nullable

Team id

pricesWithVatboolean required

Indication if prices are with vat

zipCodesstring[] nullable

Zip codes where this tariff is applicable

tariffType'WEEKLY' | 'DYNAMIC'

activeboolean required

Indication if this tariff is active

timeZonestring required

What timezone is the tariff active in

areastring required

Human description of the area the tariff is active in

Example request

{
  "externalId": "1",
  "description": "Net tariff A high",
  "countryId": 1,
  "countryAreaId": 1,
  "currencyId": 1,
  "teamId": 1,
  "pricesWithVat": true,
  "zipCodes": [
    "2200",
    "2100"
  ],
  "active": true,
  "timeZone": "Europe/Copenhagen",
  "area": "Fyn"
}

Response

Updated Tariff

idinteger

Id of the tariff

externalIdstring required

External id of the tariff

namestring required

Name of the tariff

descriptionstring required

Description of the tariff

countryIdinteger

Country Id of the tariff

countryAreaIdinteger nullable

Country area Id of the tariff

currencyIdinteger

Currency Id of the tariff

teamIdinteger nullable

Team Id of the tariff

operatorIdinteger nullable

Operator Id of the tariff

pricesWithVatboolean

Indicates if VAT is already in the price of the tariff

zipCodesstring[] required

Zip codes of the tariff

tariffType'WEEKLY' | 'DYNAMIC' required

activeboolean

Indicates if the Tariff is active or not

timeZonestring required

Time zone of the tariff

areastring required

Area of the tariff

createdAtstring date-time required

Creation date of the tariff

updatedAtstring date-time nullable

Last update date of the tariff

Example response

{
  "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"
}