Skip to main content
POST
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
tariffs
Link tariffs
curl --request POST \
  --url https://api.energy-hub.io/v1.0.0/link/users/{userId}/vendor-accounts/{vendorAccountId}/tariffs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "externalTariffs": [
    "8413731391660801"
  ]
}
'
[
  {
    "isLinked": true,
    "vendor": "TIBBER",
    "countryCode": "DE",
    "name": "Tibber Bürgerfelder Str.",
    "externalId": "8413731391660801",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

​
userId
string
required

User ID

​
vendorAccountId
string<uuid>
required

Vendor account ID

Body

application/json

Object for tariff IDs request that should be added to the Energy Hub.

​
externalTariffs
string[]
required

List of external IDs of tariffs to be linked to the Energy Hub.

List of external IDs of tariffs to be linked to the Energy Hub.

Example:
["8413731391660801"]

Response

Created

​
isLinked
boolean
required

Indicates if the tariff is linked to the Energy Hub.

​
vendor
enum<string>
required

The vendor of the tariff.

Available options:
TIBBER,
OSTROM,
OCTOPUS_ENERGY,
LUOX
​
countryCode
string
required

The country code of the tariff.

Example:

"DE"

​
name
string
required

The name of the tariff.

Example:

"Tibber Bürgerfelder Str."

​
externalId
string
required

The ID of the tariff in external vendor system.

Example:

"8413731391660801"

​
id
string<uuid>
required

The ID of the tariff.