Query station tariff list

To get an overview of the charging costs and optional setup fee you can run the query station tariff list. Within this list you will find all costs per station.

Note
The station tariff data is currently not available on our playground. Create an account or contact sales to get access to the data.

Query

The tariffList query works out of the box and no additional information is required. However, you have the option to enable pagination on the query to improve the performance as you can see below.

Arguments

  • size • int

    The number of element (count) to return, default: 10

  • page • int

    Page number to return, default: 0

    • Frequently used fields

  • currency • string

    ISO-4217 code of the currency of this tariff.

  • min_price • object • OCPIPrice

    When this field is set, a charging session with this tariff will cost at least the amount shown. This is different from a FLAT fee (start tariff, transaction fee), as a FLAT fee is a fixed amount that must be paid for any charging session. A minimum price indicates that when the cost of a charging session is lower than this amount, the cost of the session will be equal to this amount

  • max_price • object • OCPIPrice

    When this field is set, a charging session with this tariff will NOT cost more than this amount

  • elements • list • [OCPITariffElement]

    List of tariff elements

    • Other fields

  • country_code • string

    ISO-3166 alpha-2 country code of the CPO that owns this tariff

  • party_id • string

    CPO ID of the CPO that owns this tariff (following the ISO-15118 standard)

  • id • string

    Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms)

  • type • enum • OCPITariffType

    Defines the type of the tariff. This allows for distinction in case of given charging preferences. When omitted, this tariff is valid for all sessions

  • tariff_alt_text • list • [OCPIDisplayText]

    List of alternative tariff information texts, in multiple languages

  • tariff_alt_url • string

    URL to a web page that contains an explanation of the tariff information in human readable form

  • start_date_time • datetime

    Time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active

  • end_date_time • datetime

    Time after which this tariff is no longer valid, in UTC, time_zone field if the location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future

  • energy_mix • object • OCPIEnergyMix

    Details about the energy supplied with this tariff

  • last_updated • datetime

    Timestamp when this tariff was last updated (or created)

    • Response

    If successful, the HTTP status code in the response header is 200 and the response body contains the attributes you requested.

    If unsuccessful, the header status code is an error code and the response body contains an error response object. The error response object can be any of the ones below.

    Errors & warnings

    • Error
      ERROR_FORBIDDEN_MESSAGE

      You are forbidden to execute this operation

    • Error
      PAGINATION_INVALID_PAGE

      Page must be an INT value higher than 0

    • Error
      PAGINATION_INVALID_SIZE

      Size must be an INT value between 1 and 1000