Tariff list

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
AD_HOC_PAYMENT

Used to describe that a tariff is valid when ad-hoc payment is used at the charge point (for example: Debit or Credit card payment terminal)

PROFILE_CHEAP

Used to describe that a tariff is valid when charging preference: CHEAP is set for the session

PROFILE_FAST

Used to describe that a tariff is valid when charging preference: FAST is set for the session

PROFILE_GREEN

Used to describe that a tariff is valid when charging preference: GREEN is set for the session

REGULAR

Used to describe that a tariff is valid when using an RFID, without any charging preference, or when charging preference: REGULAR is set for the session

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

Exceptions

Codes

error_forbidden_message
You are forbidden to execute this operation.
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.
pagination_invalid_page
Page must be an INT value higher than 0.
pagination_invalid_size
Size must be an INT value between 1 and 1000.
rate_limit_exceeded
Rate limit exceeded.
  • Getting started

    Get started with the Chargetrip API.

  • API reference

    Browse our api and endpoints.

  • Examples

    Explore examples and start building.

How filter works

The filter argument lets you narrow down results by passing an input object with specific criteria. Each field within the filter is optional — only include the ones relevant to your query.