Skip to main content

SiteTariff

idstring<uuid>required

Unique identifier for the site tariff record

siteIdstring<uuid>required

Unique identifier for the site

metricIdstring<uuid>required

Unique identifier for the metric

validFromstring<date-time>nullable

Start date of the tariff validity period

validTostring<date-time>nullable

End date of the tariff validity period (null if still active)

tariffIdstring<uuid>nullable

Unique identifier for the external tariff (null for custom tariffs)

namestringnullable

Name of the custom tariff

tariffSlugstringnullable

Slug identifier for the tariff

sourceIdstring<uuid>required

Unique identifier for the source

rateTypestringnullable

Rate type (e.g. static, timed)

customRateConfignullable

Custom rate configuration (null for external tariffs, structured config for custom tariffs)

tariff objectnullable

External tariff details (null for custom tariffs)

idstring<uuid>required

Unique identifier for the tariff

sourceIdstring<uuid>required

Unique identifier for the energy source

namestringrequired

Name of the tariff

slugstringrequired

URL-friendly identifier for the tariff

tariffMetadata objectnullable
property name*anynullable
metricZoneMonthlyRates objectnullable

Computed min/max rates for the site energy zone

minnumbernullable

Minimum rate for the metric zone

maxnumbernullable

Maximum rate for the metric zone

SiteTariff
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "metricId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "validFrom": "2024-07-29T15:51:28.071Z",
  "validTo": "2024-07-29T15:51:28.071Z",
  "tariffId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "tariffSlug": "string",
  "sourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rateType": "string",
  "tariff": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "slug": "string",
    "tariffMetadata": {},
    "metricZoneMonthlyRates": {
      "min": 0,
      "max": 0
    }
  }
}