Query station tariff details

The tariff query will provide you with the costs to use a specific charging station. It will include the charging costs and optional setup fee.

Query

The tariff query requires a tariff id to work. This tariff id can be found inside the attributes of a station.

Arguments

id • ID

• Required

The tariff ID

Frequently used fields

currency • String

ISO-4217 code of the currency of this tariff. This property is OCPI-compliant.

min_price • 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. This property is OCPI-compliant.

max_price • OCPIPrice

When this field is set, a charging session with this tariff will NOT cost more than this amount. This property is OCPI-compliant.

elements • OCPITariffElement

List of tariff elements. This property is OCPI-compliant.

price_components • OCPIPriceComponent

List of price components that describe the pricing of a tariff. This property is OCPI-compliant.

restrictions • OCPITariffRestrictions

Restrictions that describe the applicability of a tariff. This property is OCPI-compliant.

start_time • String

Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]. This property is OCPI-compliant.

end_time • String

End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time. This property is OCPI-compliant.

start_date • String

Start date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-24, valid from this day. Regex: ([12][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]). This property is OCPI-compliant.

end_date • String

End date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as start_date. This property is OCPI-compliant.

min_kwh • Float

Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used. This property is OCPI-compliant.

max_kwh • Float

Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used. This property is OCPI-compliant.

min_current • Float

Sum of the minimum current in over all phases, for example 5. When the EV is charging with more than the defined amount of current, this tariff element is/becomes active. If the charging current is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum current over the entire charging session. This restriction can make a tariff element become active when the charging current is above the defined value, but the tariff element MUST no longer be active when the charging current drops below the defined value. This property is OCPI-compliant.

max_current • Float

Sum of the maximum current in over all phases, for example 20. When the EV is charging with less than the defined amount of current, this tariff element becomes/is active. If the charging current is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a tariff element become active when the charging current is below this value, but the tariff element MUST no longer be active when the charging current raises above the defined value. This property is OCPI-compliant.

min_power • Float

Minimum power in kW, for example 5. When the EV is charging with more than the defined amount of power, this tariff element is/becomes active. If the charging power is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum power over the entire charging session. This restriction can make a tariff element become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value. This property is OCPI-compliant.

max_power • Float

Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this tariff element becomes/is active. If the charging power is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This does not describe the maximum power over the entire charging session. This restriction can make a tariff element become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value. This property is OCPI-compliant.

min_duration • Float

Minimum duration in seconds the charging session MUST last (inclusive). When the duration of a charging session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this tariff element is not yet active. This property is OCPI-compliant.

max_duration • Float

Maximum duration in seconds the charging session MUST last (exclusive). When the duration of a charging session is shorter than the defined value, this tariff element is or becomes active. After that moment, this tariff element is no longer active. This property is OCPI-compliant.

day_of_week • OCPIDayOfWeek

Which day(s) of the week this tariff element is active. This property is OCPI-compliant.

Show OCPIDayOfWeek enum values

reservation • OCPIReservationRestrictionType

When this field is present, the tariff element describes reservation costs. A reservation starts when the reservation is made, and ends when the drivers starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation. This property is OCPI-compliant.

Show OCPIReservationRestrictionType enum values

Other fields

country_code • String

ISO-3166 alpha-2 country code of the CPO that owns this tariff. This property is OCPI-compliant.

party_id • String

CPO ID of the CPO that owns this tariff (following the ISO-15118 standard). This property is OCPI-compliant.

id • String

Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms). This property is OCPI-compliant.

type • 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. This property is OCPI-compliant.

Show OCPITariffType enum values

tariff_alt_text • OCPIDisplayText

List of alternative tariff information texts, in multiple languages. This property is OCPI-compliant.

tariff_alt_url • String

URL to a web page that contains an explanation of the tariff information in human readable form. This property is OCPI-compliant.

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. This property is OCPI-compliant.

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. This property is OCPI-compliant.

energy_mix • OCPIEnergyMix

Details about the energy supplied with this tariff. This property is OCPI-compliant.

last_updated • DateTime

Timestamp when this tariff was last updated (or created). This property is OCPI-compliant.

Response

A response can either contain a data or an errors object. The response header will always return 200 as a status code.

Data object

When successful, a data object will be returned with the requested fields. If there are no fields present the data object will return the operation name with the appropriate return type. If the operation was a query, this output will be an object of the schema’s query root type; if the operation was a mutation, this output will be an object of the schema’s mutation root type.

Error object

If unsuccessful, an errors object will be returned with more details in the extensions object. The error object can contain any of the following objects.

Error

ERROR_FORBIDDEN_MESSAGE

You are forbidden to execute this operation.

Error

OPERATION_NOT_ALLOWED

You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.

Error

TARIFF_NOT_FOUND

No tariff was found with the provided ID.