Tariff

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.arcadia.com/schemas/Tariff",
  "title": "Tariff",
  "description": "Information about a tariff.",
  "required": [
    "main_tariff_id",
    "tariff_code",
    "tariff_name",
    "utility_name"
  ],
  "properties": {
    "main_tariff_id": {
      "type": "string",
      "description": "The Genability 'masterTariffId' unique identifier for this tariff. See [Genability documentation](https://developer.genability.com/api-reference/tariff-api/tariff/) for details.",
      "example": "gen_mtid_3331108"
    },
    "property_inputs": {
      "description": "Properties applied to this tariff which may affect the calculated cost of electricity.",
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "value"
        ],
        "properties": {
          "id": {
            "type": "string",
            "example": "territoryId"
          },
          "value": {
            "type": "boolean",
            "example": 3
          }
        }
      }
    },
    "supplier_name": {
      "description": "The name of the retail electricity supplier or the community choice aggregator. If there is no retail electricity supplier or community choice aggregator, this field is null.",
      "example": "East Bay Community Energy",
      "type": "string",
      "nullable": true
    },
    "tariff_code": {
      "type": "string",
      "description": "Abbreviation code of the tariff used for this calculation.",
      "example": "EV-2A-TOU"
    },
    "tariff_name": {
      "type": "string",
      "description": "Full name of the tariff used for this calculation.",
      "example": "Residential - Time of Use - Plug-In Electric Vehicle 2"
    },
    "utility_name": {
      "type": "string",
      "description": "Name of the utility associated with this tariff",
      "example": "Pacific Gas & Electric"
    }
  }
}