Query

Unknown

Arguments

size· Int

The number of element (count) to return.

page· Int

Page number to return.

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)

currency· String

ISO-4217 code of the currency of this tariff.

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

tariff_alt_text· 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

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

max_price· OCPIPrice

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

elements· OCPITariffElement

List of tariff elements

price_components· OCPIPriceComponent

List of price components that describe the pricing of a tariff.

restrictions· OCPITariffRestrictions

Restrictions that describe the applicability of a tariff.

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]

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.

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])

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

min_kwh· Float

Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used

max_kwh· Float

Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used

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

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

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

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

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

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

day_of_week· OCPIDayOfWeek

Which day(s) of the week this tariff element is active.

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

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· OCPIEnergyMix

Details about the energy supplied with this tariff

last_updated· DateTime

Timestamp when this tariff was last updated (or created)

Errors

Operations can fail. To handle all errors correctly, consider implementing the following error scenario’s.

error_forbidden_message
operation_not_allowed
pagination_invalid_page
pagination_invalid_size
rate_limit_exceeded

Was this helpful?