OpenAPI reference

Receiver Tariff

PUT/tariffs/{country_code}/{party_id}/{tariff_id}

Push a new or updated Tariff. PUT is full-replace per OCPI 2.2.1 §12.4.2 — omitted optional fields reset to their schema defaults. Path `tariff_id` MUST match `body.id` (2001 on mismatch).

API: OCPI 2.2.1 (eMSP) · Module: Tariffs (eMSP)
Base path: /tariffs · Base URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1

Overview

PUT /tariffs/{country_code}/{party_id}/{tariff_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}

Push a new or updated Tariff. PUT is full-replace per OCPI 2.2.1 §12.4.2 — omitted optional fields reset to their schema defaults. Path tariff_id MUST match body.id (2001 on mismatch).

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"country_code":"NL","party_id":"STK","id":"11","currency":"EUR","type":"REGULAR","elements":[{"price_components":[{"type":"FLAT","price":2.5,"step_size":1}]},{"price_components":[{"type":"TIME","price":1,"step_size":900}],"restrictions":{"max_power":32}}],"last_updated":"2015-06-29T20:39:09Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).
`tariff_id`	`string`	Yes	Tariff.id of the Tariff object.

Request body

application/json · Required

Schema: Tariff

Field	Type	Required	Description
`country_code`	`string`	Yes	—
`party_id`	`string`	Yes	—
`id`	`string`	Yes	—
`currency`	`string`	Yes	—
`type`	`"AD_HOC_PAYMENT"	"PROFILE_CHEAP"	"PROFILE_FAST"
`tariff_alt_text`	`DisplayText[]`	No	—
`tariff_alt_url`	`string`	No	—
`min_price`	`Price`	No	OCPI Price: an amount with and without VAT.
`max_price`	`Price`	No	OCPI Price: an amount with and without VAT.
`elements`	`TariffElement[]`	Yes	`Elements`
`start_date_time`	`string (date-time)`	No	—
`end_date_time`	`string (date-time)`	No	—
`energy_mix`	`EnergyMix`	No	OCPI EnergyMix: the energy sources / environmental impact of a supply.
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "country_code": "NL",
3  "party_id": "STK",
4  "id": "11",
5  "currency": "EUR",
6  "type": "REGULAR",
7  "elements": [
8    {
9      "price_components": [
10        {
11          "type": "FLAT",
12          "price": 2.5,
13          "step_size": 1
14        }
15      ]
16    },
17    {
18      "price_components": [
19        {
20          "type": "TIME",
21          "price": 1,
22          "step_size": 900
23        }
24      ],
25      "restrictions": {
26        "max_power": 32
27      }
28    }
29  ],
30  "last_updated": "2015-06-29T20:39:09Z"
31}

Example 2

1{
2  "country_code": "DE",
3  "party_id": "EMP",
4  "id": "12",
5  "currency": "EUR",
6  "type": "REGULAR",
7  "tariff_alt_text": [
8    {
9      "language": "en",
10      "text": "Parking garage tariff"
11    }
12  ],
13  "elements": [
14    {
15      "price_components": [
16        {
17          "type": "ENERGY",
18          "price": 0.35,
19          "step_size": 1
20        }
21      ]
22    }
23  ],
24  "last_updated": "2015-07-01T07:50:00Z"
25}

Responses

Status	Description	Schema
`200`	Successful Response	`TariffResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: TariffResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`TariffOut`	No	`TariffOut`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "country_code": "NL",
7    "currency": "EUR",
8    "elements": [
9      {
10        "price_components": [
11          {
12            "price": 0.2,
13            "step_size": 1,
14            "type": "ENERGY",
15            "vat": 21
16          }
17        ]
18      }
19    ],
20    "end_date_time": "2024-12-31T23:59:59Z",
21    "energy_mix": {
22      "energy_sources": [
23        {
24          "percentage": 100,
25          "source": "SOLAR"
26        }
27      ],
28      "is_green_energy": true
29    },
30    "id": "TARIFF-001",
31    "last_updated": "2024-01-15T10:00:00Z",
32    "max_price": {
33      "excl_vat": 50,
34      "incl_vat": 60.5
35    },
36    "min_price": {
37      "excl_vat": 0.5,
38      "incl_vat": 0.605
39    },
40    "party_id": "CPO",
41    "start_date_time": "2024-01-01T00:00:00Z",
42    "tariff_alt_text": [
43      {
44        "language": "en",
45        "text": "Standard tariff €0.20/kWh"
46      }
47    ],
48    "tariff_alt_url": "https://example.com/tariffs/TARIFF-001",
49    "type": "REGULAR"
50  }
51}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"country_code":"NL","party_id":"STK","id":"11","currency":"EUR","type":"REGULAR","elements":[{"price_components":[{"type":"FLAT","price":2.5,"step_size":1}]},{"price_components":[{"type":"TIME","price":1,"step_size":900}],"restrictions":{"max_power":32}}],"last_updated":"2015-06-29T20:39:09Z"}'

OpenAPI reference

Receiver Tariff

PUT/tariffs/{country_code}/{party_id}/{tariff_id}

Push a new or updated Tariff. PUT is full-replace per OCPI 2.2.1 §12.4.2 — omitted optional fields reset to their schema defaults. Path `tariff_id` MUST match `body.id` (2001 on mismatch).

API: OCPI 2.2.1 (eMSP) · Module: Tariffs (eMSP)
Base path: /tariffs · Base URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1

Overview

PUT /tariffs/{country_code}/{party_id}/{tariff_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}

Push a new or updated Tariff. PUT is full-replace per OCPI 2.2.1 §12.4.2 — omitted optional fields reset to their schema defaults. Path tariff_id MUST match body.id (2001 on mismatch).

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"country_code":"NL","party_id":"STK","id":"11","currency":"EUR","type":"REGULAR","elements":[{"price_components":[{"type":"FLAT","price":2.5,"step_size":1}]},{"price_components":[{"type":"TIME","price":1,"step_size":900}],"restrictions":{"max_power":32}}],"last_updated":"2015-06-29T20:39:09Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).
`tariff_id`	`string`	Yes	Tariff.id of the Tariff object.

Request body

application/json · Required

Schema: Tariff

Field	Type	Required	Description
`country_code`	`string`	Yes	—
`party_id`	`string`	Yes	—
`id`	`string`	Yes	—
`currency`	`string`	Yes	—
`type`	`"AD_HOC_PAYMENT"	"PROFILE_CHEAP"	"PROFILE_FAST"
`tariff_alt_text`	`DisplayText[]`	No	—
`tariff_alt_url`	`string`	No	—
`min_price`	`Price`	No	OCPI Price: an amount with and without VAT.
`max_price`	`Price`	No	OCPI Price: an amount with and without VAT.
`elements`	`TariffElement[]`	Yes	`Elements`
`start_date_time`	`string (date-time)`	No	—
`end_date_time`	`string (date-time)`	No	—
`energy_mix`	`EnergyMix`	No	OCPI EnergyMix: the energy sources / environmental impact of a supply.
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "country_code": "NL",
3  "party_id": "STK",
4  "id": "11",
5  "currency": "EUR",
6  "type": "REGULAR",
7  "elements": [
8    {
9      "price_components": [
10        {
11          "type": "FLAT",
12          "price": 2.5,
13          "step_size": 1
14        }
15      ]
16    },
17    {
18      "price_components": [
19        {
20          "type": "TIME",
21          "price": 1,
22          "step_size": 900
23        }
24      ],
25      "restrictions": {
26        "max_power": 32
27      }
28    }
29  ],
30  "last_updated": "2015-06-29T20:39:09Z"
31}

Example 2

1{
2  "country_code": "DE",
3  "party_id": "EMP",
4  "id": "12",
5  "currency": "EUR",
6  "type": "REGULAR",
7  "tariff_alt_text": [
8    {
9      "language": "en",
10      "text": "Parking garage tariff"
11    }
12  ],
13  "elements": [
14    {
15      "price_components": [
16        {
17          "type": "ENERGY",
18          "price": 0.35,
19          "step_size": 1
20        }
21      ]
22    }
23  ],
24  "last_updated": "2015-07-01T07:50:00Z"
25}

Responses

Status	Description	Schema
`200`	Successful Response	`TariffResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: TariffResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`TariffOut`	No	`TariffOut`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "country_code": "NL",
7    "currency": "EUR",
8    "elements": [
9      {
10        "price_components": [
11          {
12            "price": 0.2,
13            "step_size": 1,
14            "type": "ENERGY",
15            "vat": 21
16          }
17        ]
18      }
19    ],
20    "end_date_time": "2024-12-31T23:59:59Z",
21    "energy_mix": {
22      "energy_sources": [
23        {
24          "percentage": 100,
25          "source": "SOLAR"
26        }
27      ],
28      "is_green_energy": true
29    },
30    "id": "TARIFF-001",
31    "last_updated": "2024-01-15T10:00:00Z",
32    "max_price": {
33      "excl_vat": 50,
34      "incl_vat": 60.5
35    },
36    "min_price": {
37      "excl_vat": 0.5,
38      "incl_vat": 0.605
39    },
40    "party_id": "CPO",
41    "start_date_time": "2024-01-01T00:00:00Z",
42    "tariff_alt_text": [
43      {
44        "language": "en",
45        "text": "Standard tariff €0.20/kWh"
46      }
47    ],
48    "tariff_alt_url": "https://example.com/tariffs/TARIFF-001",
49    "type": "REGULAR"
50  }
51}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.2.1/tariffs/NL/ABC/TARIFF1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"country_code":"NL","party_id":"STK","id":"11","currency":"EUR","type":"REGULAR","elements":[{"price_components":[{"type":"FLAT","price":2.5,"step_size":1}]},{"price_components":[{"type":"TIME","price":1,"step_size":900}],"restrictions":{"max_power":32}}],"last_updated":"2015-06-29T20:39:09Z"}'

Receiver Tariff

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Receiver Tariff

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page