Tariff / Set Display Information

post

https://{tenantUrl}/public-api/actions/tariffs/v2.0/{tariff}/set-tariff-display-information

Create or update tariff display information. This action supports both first-time creation and subsequent updates.

Field replacement behavior: Every call fully replaces all four display text fields. Fields not included in the request body, or sent as null, are reset to empty. To retain an existing value, you must re-supply it in the request.

Deprecated fields: The defaultPriceInformation and defaultPriceInformationOffline fields are deprecated. Use the tariff group resource to manage these fields instead. The scalar priceInformation and totalCostInformation fields are deprecated in favor of their Localized siblings, which support multi-locale round-tripping.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tariff

integer

required

The ID of the tariff to which detailed display information should be added.

Body Params

defaultPriceInformation

string | null

deprecated

Deprecated: use the tariff group resource to manage this field.

defaultPriceInformationOffline

string | null

deprecated

Deprecated: use the tariff group resource to manage this field.

priceInformation

string | null

deprecated

This property is deprecated. Use priceInformationLocalized instead. The scalar field only carries the default-locale value and cannot round-trip multi-locale content.

The information that would be shown on the display of the charge point for users that are eligible for this tariff.

priceInformationLocalized

object | null

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

totalCostInformation

string | null

deprecated

This property is deprecated. Use totalCostInformationLocalized instead. The scalar field only carries the default-locale value and cannot round-trip multi-locale content.

Additional information that would be displayed on the charge point when the session ends, along with the total fees for energy, duration and idle.

totalCostInformationLocalized

object | null

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

plainTextModeEnabled

boolean

When true, the display text is delivered to the charge point without rich text formatting.

Responses

200

Tariff display information updated successfully

201

Tariff display information created successfully

406

Action rejected

401Access token is missing or invalid

404The record is not found

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*