EnergyAustralia · Schema

EnergyPlanResponseV3

EnergyAustraliaUtilitiesElectricityGasEnergy RetailerConsumer Data RightCDRProduct Reference DataSmart MeteringEnergy MarketsRenewables

Properties

Name Type Description
data object
links object
meta object
View JSON Schema on GitHub

JSON Schema

energyaustralia-energy-plan-response-v3-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/energyaustralia/main/json-schema/energyaustralia-energy-plan-response-v3-schema.json",
  "title": "EnergyPlanResponseV3",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/energyaustralia-energy-plans-api-openapi.yml#/components/schemas/EnergyPlanResponseV3",
  "properties": {
    "data": {
      "$ref": "#/$defs/EnergyPlanDetailV3"
    },
    "links": {
      "$ref": "#/$defs/Links"
    },
    "meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "required": [
    "data",
    "links"
  ],
  "type": "object",
  "$defs": {
    "EnergyDaysEnum": {
      "enum": [
        "SUN",
        "MON",
        "TUE",
        "WED",
        "THU",
        "FRI",
        "SAT",
        "PUBLIC_HOLIDAYS"
      ],
      "type": "string"
    },
    "EnergyPlan": {
      "properties": {
        "planId": {
          "$ref": "#/$defs/EnergyPlanId"
        },
        "effectiveFrom": {
          "description": "The date and time from which this plan is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate.",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "effectiveTo": {
          "description": "The date and time at which this plan will be retired and will no longer be offered. Used to enable the managed deprecation of plans.",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "lastUpdated": {
          "description": "The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered).",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "displayName": {
          "description": "The display name of the plan.",
          "type": "string"
        },
        "description": {
          "description": "A description of the plan.",
          "type": "string"
        },
        "type": {
          "description": "The type of the plan.",
          "enum": [
            "STANDING",
            "MARKET",
            "REGULATED"
          ],
          "type": "string"
        },
        "fuelType": {
          "description": "The fuel types covered by the plan.",
          "enum": [
            "ELECTRICITY",
            "GAS",
            "DUAL"
          ],
          "type": "string"
        },
        "brand": {
          "description": "The ID of the brand under which this plan is offered.",
          "type": "string",
          "x-cds-type": "ASCIIString"
        },
        "brandName": {
          "description": "The display name of the brand under which this plan is offered.",
          "type": "string"
        },
        "applicationUri": {
          "description": "A link to an application web page where this plan can be applied for.",
          "type": "string",
          "x-cds-type": "URIString"
        },
        "additionalInformation": {
          "$ref": "#/$defs/EnergyPlan_additionalInformation"
        },
        "customerType": {
          "description": "The type of customer that the plan is offered to. If absent then the plan is available to all customers.",
          "enum": [
            "RESIDENTIAL",
            "BUSINESS"
          ],
          "type": "string"
        },
        "geography": {
          "$ref": "#/$defs/EnergyPlan_geography"
        }
      },
      "required": [
        "brand",
        "brandName",
        "fuelType",
        "lastUpdated",
        "planId",
        "type"
      ],
      "type": "object"
    },
    "EnergyPlanContractFullV3": {
      "allOf": [
        {
          "$ref": "#/$defs/EnergyPlanContractV3"
        },
        {
          "$ref": "#/$defs/EnergyPlanContractFullV3_allOf"
        }
      ]
    },
    "EnergyPlanContractFullV3_allOf": {
      "properties": {
        "termType": {
          "description": "The term for the contract. If absent assumes no specified term.",
          "enum": [
            "1_YEAR",
            "2_YEAR",
            "3_YEAR",
            "4_YEAR",
            "5_YEAR",
            "ONGOING",
            "OTHER"
          ],
          "type": "string"
        },
        "benefitPeriod": {
          "description": "Description of the benefit period. Should only be present if _termType_ has the value `ONGOING`.",
          "type": "string"
        },
        "terms": {
          "description": "Free text description of the terms for the contract.",
          "type": "string"
        },
        "meterTypes": {
          "description": "An array of the meter types that this contract is available for.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "coolingOffDays": {
          "description": "Number of days in the cooling off period for the contract. Mandatory for plans with type of `MARKET`.",
          "type": "integer",
          "x-cds-type": "PositiveInteger"
        },
        "billFrequency": {
          "description": "An array of the available billing schedules for this contract. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "billFrequency"
      ],
      "type": "object",
      "x-conditional": [
        "benefitPeriod",
        "variation",
        "coolingOffDays"
      ]
    },
    "EnergyPlanContractV3": {
      "properties": {
        "additionalFeeInformation": {
          "description": "Free text field containing additional information of the fees for this contract.",
          "type": "string"
        },
        "pricingModel": {
          "description": "The pricing model for the contract. Contracts for gas must use `SINGLE_RATE`. Note that the detail for the enumeration values are:<ul><li>`SINGLE_RATE`: all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a 'block' or 'step' tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.)</li><li>`SINGLE_RATE_CONT_LOAD`: as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.</li><li>`TIME_OF_USE`: energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumed</li><li>`TIME_OF_USE_CONT_LOAD`: as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.</li><li>`FLEXIBLE`: energy usage is charged at unit rates that vary based on external factors</li><li>`FLEXIBLE_CONT_LOAD`: as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.</li><li>`QUOTA`: all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate. i.e. $50/month for up to 150kWh included usage.</li></ul>",
          "enum": [
            "SINGLE_RATE",
            "SINGLE_RATE_CONT_LOAD",
            "TIME_OF_USE",
            "TIME_OF_USE_CONT_LOAD",
            "FLEXIBLE",
            "FLEXIBLE_CONT_LOAD",
            "QUOTA"
          ],
          "type": "string"
        },
        "timeZone": {
          "default": "AEST",
          "description": "Required if _pricingModel_ is set to `TIME_OF_USE`. Defines the time zone to use for calculation of the time of use thresholds. Defaults to `AEST` if absent.",
          "enum": [
            "LOCAL",
            "AEST"
          ],
          "type": "string"
        },
        "isFixed": {
          "description": "Flag indicating whether prices are fixed or variable.",
          "type": "boolean"
        },
        "variation": {
          "description": "Free text description of price variation policy and conditions for the contract. Mandatory if _isFixed_ is `false`.",
          "type": "string"
        },
        "onExpiryDescription": {
          "description": "Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period.",
          "type": "string"
        },
        "paymentOption": {
          "description": "Payment options for this contract.",
          "items": {
            "enum": [
              "PAPER_BILL",
              "CREDIT_CARD",
              "DIRECT_DEBIT",
              "BPAY",
              "OTHER"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "intrinsicGreenPower": {
          "$ref": "#/$defs/EnergyPlanContractV3_intrinsicGreenPower"
        },
        "controlledLoad": {
          "description": "Required if pricing model is `SINGLE_RATE_CONT_LOAD` or `TIME_OF_USE_CONT_LOAD` or `FLEXIBLE_CONT_LOAD`.",
          "items": {
            "$ref": "#/$defs/EnergyPlanControlledLoadV2"
          },
          "type": "array"
        },
        "incentives": {
          "description": "Optional list of incentives available for the contract.",
          "items": {
            "$ref": "#/$defs/EnergyPlanIncentives"
          },
          "type": "array"
        },
        "discounts": {
          "description": "Optional list of discounts available for the contract.",
          "items": {
            "$ref": "#/$defs/EnergyPlanDiscounts"
          },
          "type": "array"
        },
        "greenPowerCharges": {
          "description": "Optional list of charges applicable to green power.",
          "items": {
            "$ref": "#/$defs/EnergyPlanGreenPowerCharges"
          },
          "type": "array"
        },
        "eligibility": {
          "description": "Eligibility restrictions or requirements.",
          "items": {
            "$ref": "#/$defs/EnergyPlanEligibility"
          },
          "type": "array"
        },
        "fees": {
          "description": "An array of fees applicable to the plan.",
          "items": {
            "$ref": "#/$defs/EnergyPlanFees"
          },
          "type": "array"
        },
        "solarFeedInTariff": {
          "description": "Array of feed in tariffs for solar power.",
          "items": {
            "$ref": "#/$defs/EnergyPlanSolarFeedInTariffV3"
          },
          "type": "array"
        },
        "tariffPeriod": {
          "description": "Array of tariffs that apply to periods throughout the year.",
          "items": {
            "$ref": "#/$defs/EnergyPlanTariffPeriodV2"
          },
          "type": "array"
        }
      },
      "required": [
        "isFixed",
        "paymentOption",
        "pricingModel",
        "tariffPeriod"
      ],
      "type": "object",
      "x-conditional": [
        "timeZone",
        "variation",
        "controlledLoad"
      ]
    },
    "EnergyPlanContractV3_intrinsicGreenPower": {
      "description": "Describes intrinsic green power for the plan. If present then the plan includes a percentage of green power in the base plan. Should not be present for gas contracts.",
      "properties": {
        "greenPercentage": {
          "description": "Percentage of green power intrinsically included in the plan.",
          "type": "string",
          "x-cds-type": "RateString"
        }
      },
      "required": [
        "greenPercentage"
      ],
      "type": "object"
    },
    "EnergyPlanControlledLoadV2": {
      "properties": {
        "displayName": {
          "description": "A display name for the controlled load.",
          "type": "string"
        },
        "rateBlockUType": {
          "description": "Specifies the type of controlled load rate.",
          "enum": [
            "singleRate",
            "timeOfUseRates"
          ],
          "type": "string"
        },
        "startDate": {
          "description": "Optional start date of the application of the controlled load rate.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "endDate": {
          "description": "Optional end date of the application of the controlled load rate.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "singleRate": {
          "$ref": "#/$defs/EnergyPlanControlledLoadV2_singleRate"
        },
        "timeOfUseRates": {
          "description": "Array of objects representing time of use rates. Required if _rateBlockUType_ is `timeOfUseRates`.",
          "items": {
            "$ref": "#/$defs/EnergyPlanControlledLoadV2_timeOfUseRates"
          },
          "type": "array"
        }
      },
      "required": [
        "displayName",
        "rateBlockUType"
      ],
      "type": "object",
      "x-conditional": [
        "singleRate",
        "timeOfUseRates"
      ]
    },
    "EnergyPlanControlledLoadV2_singleRate": {
      "description": "Object representing a single controlled load rate. Required if _rateBlockUType_ is `singleRate`.",
      "properties": {
        "displayName": {
          "description": "Display name of the controlled load rate.",
          "type": "string"
        },
        "description": {
          "description": "Description of the controlled load rate.",
          "type": "string"
        },
        "dailySupplyCharge": {
          "description": "The daily supply charge (exclusive of GST) for this controlled load tier.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "rates": {
          "description": "Array of controlled load rates in order of usage volume.",
          "items": {
            "$ref": "#/$defs/EnergyPlanControlledLoadV2_singleRate_rates"
          },
          "type": "array"
        },
        "period": {
          "default": "P1Y",
          "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        }
      },
      "required": [
        "displayName",
        "rates"
      ],
      "type": "object"
    },
    "EnergyPlanControlledLoadV2_singleRate_rates": {
      "properties": {
        "unitPrice": {
          "description": "Unit price of usage per measure unit (exclusive of GST).",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "measureUnit": {
          "allOf": [
            {
              "$ref": "#/$defs/MeasureUnitEnum"
            }
          ],
          "default": "KWH",
          "description": "The measurement unit of rate. Assumed to be `KWH` if absent.",
          "type": "string"
        },
        "volume": {
          "description": "Volume in kWh that this rate applies to. Only applicable for 'stepped' rates where different rates apply for different volumes of usage in a period.",
          "type": "number"
        }
      },
      "required": [
        "unitPrice"
      ],
      "type": "object"
    },
    "EnergyPlanControlledLoadV2_timeOfUse": {
      "properties": {
        "days": {
          "description": "The days that this time window applies to.",
          "items": {
            "$ref": "#/$defs/EnergyDaysEnum"
          },
          "type": "array"
        },
        "startTime": {
          "description": "The beginning of the time window per day for which the controlled load rate applies. Required if _endTime_ provided. Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "endTime": {
          "description": "The end of the time window per day for which the controlled load rate applies. Required if _startTime_ provided. Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "additionalInfo": {
          "description": "Display text providing more information on the controlled load, for e.g., controlled load availability if specific day/time is not known. Required if _startTime_ and _endTime_ absent or if _additionalInfoUri_ provided.",
          "type": "string"
        },
        "additionalInfoUri": {
          "description": "Optional link to additional information regarding the controlled load.",
          "type": "string",
          "x-cds-type": "URIString"
        }
      },
      "type": "object",
      "x-conditional": [
        "startTime",
        "endTime",
        "additionalInfo"
      ]
    },
    "EnergyPlanControlledLoadV2_timeOfUseRates": {
      "properties": {
        "displayName": {
          "description": "Display name of the controlled load rate.",
          "type": "string"
        },
        "description": {
          "description": "Description of the controlled load rate.",
          "type": "string"
        },
        "dailySupplyCharge": {
          "description": "The daily supply charge (exclusive of GST) for this controlled load tier.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "rates": {
          "description": "Array of controlled load rates in order of usage volume.",
          "items": {
            "$ref": "#/$defs/EnergyPlanControlledLoadV2_singleRate_rates"
          },
          "type": "array"
        },
        "period": {
          "default": "P1Y",
          "description": "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to `P1Y` if absent.",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "timeOfUse": {
          "description": "Array of time windows for which this time of use rate applies.",
          "items": {
            "$ref": "#/$defs/EnergyPlanControlledLoadV2_timeOfUse"
          },
          "type": "array"
        },
        "type": {
          "description": "The type of usage that the rate applies to.",
          "enum": [
            "PEAK",
            "OFF_PEAK",
            "SHOULDER",
            "SOLAR_SPONGE"
          ],
          "type": "string"
        }
      },
      "required": [
        "displayName",
        "rates",
        "timeOfUse",
        "type"
      ],
      "type": "object"
    },
    "EnergyPlanDetailV3": {
      "allOf": [
        {
          "$ref": "#/$defs/EnergyPlan"
        },
        {
          "$ref": "#/$defs/EnergyPlanDetailV3_allOf"
        }
      ]
    },
    "EnergyPlanDetailV3_allOf": {
      "properties": {
        "meteringCharges": {
          "description": "Charges for metering included in the plan.",
          "items": {
            "$ref": "#/$defs/EnergyPlanDetailV3_allOf_meteringCharges"
          },
          "type": "array"
        },
        "gasContract": {
          "allOf": [
            {
              "$ref": "#/$defs/EnergyPlanContractFullV3"
            }
          ],
          "description": "The details of the terms for the supply of electricity under this plan. Is mandatory if _fuelType_ is set to `GAS` or `DUAL`."
        },
        "electricityContract": {
          "allOf": [
            {
              "$ref": "#/$defs/EnergyPlanContractFullV3"
            }
          ],
          "description": "The details of the terms for the supply of electricity under this plan. Is mandatory if _fuelType_ is set to `ELECTRICITY` or `DUAL`."
        }
      },
      "type": "object",
      "x-conditional": [
        "gasContract",
        "electricityContract"
      ]
    },
    "EnergyPlanDetailV3_allOf_meteringCharges": {
      "properties": {
        "displayName": {
          "description": "Display name of the charge.",
          "type": "string"
        },
        "description": {
          "description": "Description of the charge.",
          "type": "string"
        },
        "minimumValue": {
          "description": "Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "maximumValue": {
          "description": "The upper limit of the charge if the charge could occur in a range.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "period": {
          "description": "The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).",
          "type": "string",
          "x-cds-type": "ExternalRef"
        }
      },
      "required": [
        "displayName",
        "minimumValue"
      ],
      "type": "object"
    },
    "EnergyPlanDiscounts": {
      "properties": {
        "displayName": {
          "description": "The display name of the discount.",
          "type": "string"
        },
        "description": {
          "description": "The description of the discount.",
          "type": "string"
        },
        "type": {
          "description": "The type of the discount.",
          "enum": [
            "CONDITIONAL",
            "GUARANTEED",
            "OTHER"
          ],
          "type": "string"
        },
        "category": {
          "description": "The type of the discount. Mandatory if the discount _type_ is `CONDITIONAL`.",
          "enum": [
            "PAY_ON_TIME",
            "DIRECT_DEBIT",
            "GUARANTEED_DISCOUNT",
            "OTHER"
          ],
          "type": "string"
        },
        "endDate": {
          "description": "Optional end date for the discount after which the discount is no longer available.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "methodUType": {
          "description": "The method of calculation of the discount.",
          "enum": [
            "percentOfBill",
            "percentOfUse",
            "fixedAmount",
            "percentOverThreshold"
          ],
          "type": "string"
        },
        "percentOfBill": {
          "$ref": "#/$defs/EnergyPlanDiscounts_percentOfBill"
        },
        "percentOfUse": {
          "$ref": "#/$defs/EnergyPlanDiscounts_percentOfUse"
        },
        "fixedAmount": {
          "$ref": "#/$defs/EnergyPlanDiscounts_fixedAmount"
        },
        "percentOverThreshold": {
          "$ref": "#/$defs/EnergyPlanDiscounts_percentOverThreshold"
        }
      },
      "required": [
        "displayName",
        "methodUType",
        "type"
      ],
      "type": "object",
      "x-conditional": [
        "percentOfBill",
        "percentOfUse",
        "fixedAmount",
        "percentOverThreshold"
      ]
    },
    "EnergyPlanDiscounts_fixedAmount": {
      "description": "Required if _methodUType_ is `fixedAmount`.",
      "properties": {
        "amount": {
          "description": "The amount of the discount.",
          "type": "string",
          "x-cds-type": "AmountString"
        }
      },
      "required": [
        "amount"
      ],
      "type": "object"
    },
    "EnergyPlanDiscounts_percentOfBill": {
      "description": "Required if _methodUType_ is `percentOfBill`.",
      "properties": {
        "rate": {
          "description": "The rate of the discount applied to the bill amount.",
          "type": "string",
          "x-cds-type": "RateString"
        }
      },
      "required": [
        "rate"
      ],
      "type": "object"
    },
    "EnergyPlanDiscounts_percentOfUse": {
      "description": "Required if _methodUType_ is `percentOfUse`.",
      "properties": {
        "rate": {
          "description": "The rate of the discount applied to the _usageamount_.",
          "type": "string",
          "x-cds-type": "RateString"
        }
      },
      "required": [
        "rate"
      ],
      "type": "object"
    },
    "EnergyPlanDiscounts_percentOverThreshold": {
      "description": "Required if _methodUType_ is `percentOverThreshold`.",
      "properties": {
        "rate": {
          "description": "The rate of the discount over the usage amount.",
          "type": "string",
          "x-cds-type": "RateString"
        },
        "usageAmount": {
          "description": "The usage amount threshold above which the discount applies.",
          "type": "string",
          "x-cds-type": "AmountString"
        }
      },
      "required": [
        "rate",
        "usageAmount"
      ],
      "type": "object"
    },
    "EnergyPlanEligibility": {
      "properties": {
        "type": {
          "description": "The type of the eligibility restriction.<br/>The `CONTINGENT_PLAN` value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the _fuelType_ is `ELECTRICITY` then a `GAS` plan from the same retailer must be taken up).",
          "enum": [
            "EXISTING_CUST",
            "EXISTING_POOL",
            "EXISTING_SOLAR",
            "EXISTING_BATTERY",
            "EXISTING_SMART_METER",
            "EXISTING_BASIC_METER",
            "SENIOR_CARD",
            "SMALL_BUSINESS",
            "NO_SOLAR_FIT",
            "NEW_CUSTOMER",
            "ONLINE_ONLY",
            "REQ_EQUIP_SUPPLIER",
            "THIRD_PARTY_ONLY",
            "SPORT_CLUB_MEMBER",
            "ORG_MEMBER",
            "SPECIFIC_LOCATION",
            "MINIMUM_USAGE",
            "LOYALTY_MEMBER",
            "GROUP_BUY_MEMBER",
            "CONTINGENT_PLAN",
            "OTHER"
          ],
          "type": "string"
        },
        "information": {
          "description": "Information of the eligibility restriction specific to the type of the restriction.",
          "type": "string"
        },
        "description": {
          "description": "A description of the eligibility restriction.",
          "type": "string"
        }
      },
      "required": [
        "information",
        "type"
      ],
      "type": "object"
    },
    "EnergyPlanFees": {
      "properties": {
        "type": {
          "description": "The type of the fee.",
          "enum": [
            "EXIT",
            "ESTABLISHMENT",
            "LATE_PAYMENT",
            "DISCONNECTION",
            "DISCONNECT_MOVE_OUT",
            "DISCONNECT_NON_PAY",
            "RECONNECTION",
            "CONNECTION",
            "PAYMENT_PROCESSING",
            "CC_PROCESSING",
            "CHEQUE_DISHONOUR",
            "DD_DISHONOUR",
            "MEMBERSHIP",
            "CONTRIBUTION",
            "PAPER_BILL",
            "OTHER"
          ],
          "type": "string"
        },
        "term": {
          "description": "The term of the fee.",
          "enum": [
            "FIXED",
            "1_YEAR",
            "2_YEAR",
            "3_YEAR",
            "4_YEAR",
            "5_YEAR",
            "PERCENT_OF_BILL",
            "ANNUAL",
            "DAILY",
            "WEEKLY",
            "MONTHLY",
            "BIANNUAL",
            "VARIABLE"
          ],
          "type": "string"
        },
        "amount": {
          "description": "The fee amount. Required if _term_ is not `PERCENT_OF_BILL`.",
          "type": "string",
          "x-cds-type": "AmountString"
        },
        "rate": {
          "description": "The fee rate. Required if _term_ is `PERCENT_OF_BILL`.",
          "type": "string",
          "x-cds-type": "RateString"
        },
        "description": {
          "description": "A description of the fee.",
          "type": "string"
        }
      },
      "required": [
        "term",
        "type"
      ],
      "type": "object",
      "x-conditional": [
        "amount",
        "rate"
      ]
    },
    "EnergyPlanGreenPowerCharges": {
      "properties": {
        "displayName": {
          "description": "The display name of the charge.",
          "type": "string"
        },
        "description": {
          "description": "The description of the charge.",
          "type": "string"
        },
        "scheme": {
          "description": "The applicable green power scheme.",
          "enum": [
            "GREENPOWER",
            "OTHER"
          ],
          "type": "string"
        },
        "type": {
          "description": "The type of charge.",
          "enum": [
            "FIXED_PER_DAY",
            "FIXED_PER_WEEK",
            "FIXED_PER_MONTH",
            "FIXED_PER_UNIT",
            "PERCENT_OF_USE",
            "PERCENT_OF_BILL"
          ],
          "type": "string"
        },
        "tiers": {
          "description": "Array of charge tiers based on the percentage of green power used for the period implied by the type. Array is in order of increasing percentage of green power.",
          "items": {
            "$ref": "#/$defs/EnergyPlanGreenPowerCharges_tiers"
          },
          "type": "array"
        }
      },
      "required": [
        "displayName",
        "scheme",
        "tiers",
        "type"
      ],
      "type": "object"
    },
    "EnergyPlanGreenPowerCharges_tiers": {
      "properties": {
        "percentGreen": {
          "description": "The upper percentage of green power used applicable for this tier.",
          "type": "string",
          "x-cds-type": "RateString"
        },
        "rate": {
          "description": "The rate of the charge if the type implies the application of a rate.",
          "type": "string",
          "x-cds-type": "RateString"
        },
        "amount": {
          "description": "The amount of the charge if the type implies the application of a fixed amount.",
          "type": "string",
          "x-cds-type": "AmountString"
        }
      },
      "required": [
        "percentGreen"
      ],
      "type": "object",
      "x-conditional": [
        "rate",
        "amount"
      ]
    },
    "EnergyPlanId": {
      "description": "The unique identifier for the Energy plan.",
      "type": "string",
      "x-cds-type": "ASCIIString"
    },
    "EnergyPlanIncentives": {
      "properties": {
        "displayName": {
          "description": "The display name of the incentive.",
          "type": "string"
        },
        "description": {
          "description": "The description of the incentive.",
          "type": "string"
        },
        "category": {
          "description": "The type of the incentive.",
          "enum": [
            "GIFT",
            "ACCOUNT_CREDIT",
            "OTHER"
          ],
          "type": "string"
        },
        "eligibility": {
          "description": "A display message outlining an eligibility criteria that may apply.",
          "type": "string"
        }
      },
      "required": [
        "category",
        "description",
        "displayName"
      ],
      "type": "object"
    },
    "EnergyPlanSolarFeedInTariffV3": {
      "properties": {
        "displayName": {
          "description": "The name of the tariff.",
          "type": "string"
        },
        "description": {
          "description": "A description of the tariff.",
          "type": "string"
        },
        "startDate": {
          "description": "The start date of the application of the feed in tariff.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "endDate": {
          "description": "The end date of the application of the feed in tariff.",
          "type": "string",
          "x-cds-type": "DateString"
        },
        "scheme": {
          "description": "The applicable scheme.",
          "enum": [
            "PREMIUM",
            "CURRENT",
            "VARIABLE",
            "OTHER"
          ],
          "type": "string"
        },
        "payerType": {
          "description": "The type of the payer.",
          "enum": [
            "GOVERNMENT",
            "RETAILER"
          ],
          "type": "string"
        },
        "tariffUType": {
          "description": "Refer

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/energyaustralia/refs/heads/main/json-schema/energyaustralia-energy-plan-response-v3-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/energyaustralia-energy-plan-response-v3"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.