Get tariffs

x-ms-visibility: "important"

Retrieves all tariffs

Query Parameters

page int32

Page to be fetched. Default: 1

limit int32

Limit (No. of records per page). Max value: 100. Default: 100.

search string

Free text filter for tariffs.

sortKey string

Field to be used for sorting. Default: tariffName

sortDescending boolean

Set to 'true' to sort descending based on sort key. Default: 'false'

Responses

• 200
• 400
• 401

---

Tariffs successfully retrieved.

application/json

Schema

Example (from schema)

---

Schema

page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
Array [
id string
version int32 nullable
tariffName string
tariffNameWithPrice string
received boolean nullable
externalId string
useType string nullable
Possible values: [COST, PRICE, OTHER]
Default value: COST
currency string
ocpiType string nullable
Possible values: [AD_HOC_PAYMENT, PROFILE_CHEAP, PROFILE_FAST, PROFILE_GREEN, REGULAR]
Default value: AD_HOC_PAYMENT
baseTariffId string
tariffAltUrl uri
minPrice object
exclVat double nullable
inclVat double nullable
maxPrice object
exclVat double nullable
inclVat double nullable
elements object[]
Array [
priceComponents object[]
Array [
type string
Possible values: [ENERGY, FLAT, PARKING_TIME, TIME, SOCKET_COUNT, CHARGER_COUNT, ENERGY_SPOT, ENERGY_SPOT_LOCKED, MONTHLY_FLAT]
Default value: ENERGY
price double
margin double nullable
vat double nullable
stepSize int32
biddingZone string
marginPercentage double nullable
priceCap double nullable
costPercentage double nullable
]
restrictions object
startTime string
endTime string
startDate string
endDate string
minKwh double nullable
maxKwh double nullable
minCurrent double nullable
maxCurrent double nullable
minPower double nullable
maxPower double nullable
minDuration int32 nullable
maxDuration int32 nullable
dayOfWeek string[]
Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]
reservation string nullable
Possible values: [RESERVATION, RESERVATION_EXPIRES]
Default value: RESERVATION
]
startDateTime date-time nullable
endDateTime date-time nullable
tariffEnergyMix object
isGreenEnergy boolean
energySources object[]
Array [
source string
Possible values: [NUCLEAR, GENERAL_FOSSIL, COAL, GAS, GENERAL_GREEN, SOLAR, WIND, WATER]
Default value: NUCLEAR
percentage float
]
environImpact object[]
Array [
category string
Possible values: [NUCLEAR_WASTE, CARBON_DIOXIDE]
Default value: NUCLEAR_WASTE
amount float
]
supplierName string
energyProductName string
created date-time
lastUpdated date-time
tariffAltText object[]
Array [
language string
text string
]
tariffAltTextOffline object[]
Array [
language string
text string
]
tariffAltTextDuringCharging object[]
Array [
language string
text string
]
tariffAltTextStopTransaction object[]
Array [
language string
text string
]
]

{
  "page": 0,
  "limit": 0,
  "totalRecords": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "id": "string",
      "version": 0,
      "tariffName": "string",
      "tariffNameWithPrice": "string",
      "received": true,
      "externalId": "string",
      "useType": "COST",
      "currency": "string",
      "ocpiType": "AD_HOC_PAYMENT",
      "baseTariffId": "string",
      "tariffAltUrl": "string",
      "minPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "maxPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "elements": [
        {
          "priceComponents": [
            {
              "type": "ENERGY",
              "price": 0,
              "margin": 0,
              "vat": 0,
              "stepSize": 0,
              "biddingZone": "string",
              "marginPercentage": 0,
              "priceCap": 0,
              "costPercentage": 0
            }
          ],
          "restrictions": {
            "startTime": "string",
            "endTime": "string",
            "startDate": "string",
            "endDate": "string",
            "minKwh": 0,
            "maxKwh": 0,
            "minCurrent": 0,
            "maxCurrent": 0,
            "minPower": 0,
            "maxPower": 0,
            "minDuration": 0,
            "maxDuration": 0,
            "dayOfWeek": [
              "MONDAY"
            ],
            "reservation": "RESERVATION"
          }
        }
      ],
      "startDateTime": "2025-05-28T10:55:51.158Z",
      "endDateTime": "2025-05-28T10:55:51.158Z",
      "tariffEnergyMix": {
        "isGreenEnergy": true,
        "energySources": [
          {
            "source": "NUCLEAR",
            "percentage": 0
          }
        ],
        "environImpact": [
          {
            "category": "NUCLEAR_WASTE",
            "amount": 0
          }
        ],
        "supplierName": "string",
        "energyProductName": "string"
      },
      "created": "2025-05-28T10:55:51.159Z",
      "lastUpdated": "2025-05-28T10:55:51.159Z",
      "tariffAltText": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "tariffAltTextOffline": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "tariffAltTextDuringCharging": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "tariffAltTextStopTransaction": [
        {
          "language": "string",
          "text": "string"
        }
      ]
    }
  ]
}

Validation error occurred.

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorized.

Loading...