HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Custom Tariff Filters / Set Pricing Data

Set the pricing data for a custom tariff filter.
This action will update the underlying roaming tariff and create a pricing based on it.
The pricing can then be utilized by attaching a markup tariff to the tariff map of the custom tariff filter.
The pricing data must follow the OCPI 2.2.1 Tariff object specification.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the roaming operator

integer
required

The ID of the custom tariff filter

Body Params
string
length between 2 and 2

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

string
length between 3 and 3

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

string
required
length ≤ 36

Uniquely identifies the tariff within the CPO's platform.

string
required
length between 3 and 3

ISO 4217 code of the currency of this tariff.

string
enum

Type of this tariff.

Allowed:
tariff_alt_text
array of objects

List of multi-language alternative texts for this tariff.

tariff_alt_text
uri
length ≤ 255

URL to a web page that contains an explanation of the tariff information.

min_price
object

Price with VAT excluded and included.

max_price
object

Price with VAT excluded and included.

elements
array of objects
required
length ≥ 1

List of Tariff Elements.

elements*
date-time

The time when this tariff becomes active. Format ISO 8601 UTC.

date-time

The time after which this tariff is no longer valid. Format ISO 8601 UTC.

energy_mix
object

Details about the energy mix.

date-time
required

Timestamp when this Tariff was last updated. Format ISO 8601 UTC.

Responses
202

Action accepted

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json