eMSP · Tariffs
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
ROADRoad deviations in this section
Road enables these for your connection on request.
- Remapped party identitycountry_code, party_id and EVSE ids on locations, tariffs and CDRs can differ from those of the party that created them. Road rewrites them according to rules set up for the connection.When not enabled: Objects keep the identity of the party that created them.
GET/msp/tariffs/{country_code}/{party_id}/{tariff_id}
Get a tariff
Returns a single tariff the CPO pushed to the eMSP.
ROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/msp/tariffs/{country_code}/{party_id}/{tariff_id}
Put a tariff
Creates or replaces a tariff in the eMSP's system.
ROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/msp/tariffs/{country_code}/{party_id}/{tariff_id}
Patch a tariff
Partially updates a tariff in the eMSP's system.
ROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
DELETE/msp/tariffs/{country_code}/{party_id}/{tariff_id}
Delete a tariff
Removes a tariff from the eMSP's system.
ROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.