Energy Queensland Energy Plans API

openapi: 3.2.0
info:
  contact:
    email: contact@dsb.gov.au
    name: Data Standards Body
    url: https://dsb.gov.au/
  description: Specifications for resource endpoints applicable to data holders in the Energy sector.
  title: CDR Energy Energy Plans API
  version: 1.36.0
servers:
- description: MTLS
  url: https://mtls.dh.example.com/cds-au/v1
tags:
- description: Energy Plan endpoints
  name: Energy Plans
  x-shortName: Plans
paths:
  /energy/plans:
    get:
      description: 'Obtain a list of energy plans that are currently offered to the market.


        Note that the results returned by this endpoint are expected to be ordered in descending order according to _lastUpdated_.'
      operationId: listEnergyPlans
      parameters:
      - description: Used to filter results on the _type_ field. Any one of the valid values for this field can be supplied plus `ALL`. If absent defaults to `ALL`.
        explode: true
        in: query
        name: type
        required: false
        schema:
          default: ALL
          enum:
          - STANDING
          - MARKET
          - REGULATED
          - ALL
          type: string
        style: form
      - description: Used to filter results on the _fuelType_ field. Any one of the valid values for this field can be supplied plus `ALL`. If absent defaults to `ALL`.
        explode: true
        in: query
        name: fuelType
        required: false
        schema:
          default: ALL
          enum:
          - ELECTRICITY
          - GAS
          - DUAL
          - ALL
          type: string
        style: form
      - description: Allows for the filtering of plans based on whether the current time is within the period of time defined as effective by the _effectiveFrom_ and _effectiveTo_ fields. Valid values are `CURRENT`, `FUTURE` and `ALL`. If absent defaults to `CURRENT`.
        explode: true
        in: query
        name: effective
        required: false
        schema:
          default: CURRENT
          enum:
          - CURRENT
          - FUTURE
          - ALL
          type: string
        style: form
      - description: Only include plans that have been updated after the specified date and time. If absent defaults to include all plans.
        explode: true
        in: query
        name: updated-since
        required: false
        schema:
          type: string
        style: form
        x-cds-type: DateTimeString
      - description: Used to filter results on the _brand_ field. If absent defaults to include all plans.
        explode: true
        in: query
        name: brand
        required: false
        schema:
          type: string
        style: form
      - description: Page of results to request (standard pagination).
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
        x-cds-type: PositiveInteger
      - description: Page size to request. Default is 25 (standard pagination).
        explode: true
        in: query
        name: page-size
        required: false
        schema:
          type: integer
        style: form
        x-cds-type: PositiveInteger
      - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).
        explode: false
        in: header
        name: x-v
        required: true
        schema:
          type: string
        style: simple
      - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.
        explode: false
        in: header
        name: x-min-v
        required: false
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyPlanListResponse'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorListV2'
          description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Date](#error-400-field-invalid-date-time)</li><li>[400 - Invalid Page Size](#error-400-field-invalid-page-size)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorListV2'
          description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorListV2'
          description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[422 - Invalid Page](#error-422-field-invalid-page)</li></ul>
      servers:
      - description: TLS
        url: https://tls.dh.example.com/cds-au/v1
      summary: Get Generic Plans
      tags:
      - Energy Plans
      x-version: '1'
  /energy/plans/{planId}:
    get:
      description: 'Obtain detailed information on a single energy plan offered openly to the market.


        Other Versions: [v1](includes/obsolete/get-generic-plan-detail-v1.html), [v2](includes/obsolete/get-generic-plan-detail-v2.html).'
      operationId: getEnergyPlanDetail
      parameters:
      - description: ID of the specific plan requested.
        explode: false
        in: path
        name: planId
        required: true
        schema:
          $ref: '#/components/schemas/EnergyPlanId'
        style: simple
      - description: Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If the value of [_x-min-v_](#request-headers) is equal to or higher than the value of [_x-v_](#request-headers) then the [_x-min-v_](#request-headers) header should be treated as absent. If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`. See [HTTP Headers](#request-headers).
        explode: false
        in: header
        name: x-v
        required: true
        schema:
          type: string
        style: simple
      - description: Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between [_x-min-v_](#request-headers) and [_x-v_](#request-headers). If all versions requested are not supported then the endpoint **MUST** respond with a `406 Not Acceptable`.
        explode: false
        in: header
        name: x-min-v
        required: false
        schema:
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnergyPlanResponseV3'
          description: Successful response
          headers:
            x-v:
              $ref: '#/components/headers/XV'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorListV2'
          description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[400 - Invalid Field](#error-400-field-invalid)</li><li>[400 - Missing Required Field](#error-400-field-missing)</li><li>[400 - Invalid Version](#error-400-header-invalid-version)</li></ul>
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorListV2'
          description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[404 - Invalid Resource](#error-404-resource-invalid)</li></ul>
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorListV2'
          description: The following error codes **MUST** be supported:<br/><ul class="error-code-list"><li>[406 - Unsupported Version](#error-406-header-unsupported-version)</li></ul>
      servers:
      - description: TLS
        url: https://tls.dh.example.com/cds-au/v1
      summary: Get Generic Plan Detail
      tags:
      - Energy Plans
      x-version: '3'
      x-version-notes: The <i>dailySupplyChargeType</i> field was added in endpoint v3 as part of Standards v1.30.0. In Standards v1.32.0, the description of that field was changed to remove the default value, but it did not result in a new endpoint version. Refer to the [v1.32.0 release notes](includes/releasenotes/releasenotes.1.32.0.html) for more details.
components:
  schemas:
    EnergyPlanControlledLoadV2_timeOfUse:
      properties:
        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
        days:
          description: The days that this time window applies to.
          items:
            $ref: '#/components/schemas/EnergyDaysEnum'
          type: array
        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
        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
      type: object
      x-conditional:
      - startTime
      - endTime
      - additionalInfo
    EnergyPlanDetailV3_allOf:
      properties:
        electricityContract:
          allOf:
          - $ref: '#/components/schemas/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`.
        gasContract:
          allOf:
          - $ref: '#/components/schemas/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`.
        meteringCharges:
          description: Charges for metering included in the plan.
          items:
            $ref: '#/components/schemas/EnergyPlanDetailV3_allOf_meteringCharges'
          type: array
      type: object
      x-conditional:
      - gasContract
      - electricityContract
    EnergyPlanResponseV3:
      properties:
        data:
          $ref: '#/components/schemas/EnergyPlanDetailV3'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
      - data
      - links
      type: object
    Meta:
      type: object
    EnergyPlanTariffPeriodV2_demandCharges:
      properties:
        amount:
          description: The charge amount per measure unit exclusive of GST.
          type: string
          x-cds-type: AmountString
        chargePeriod:
          description: Charge period for the demand tariff.
          enum:
          - DAY
          - MONTH
          - TARIFF_PERIOD
          type: string
        days:
          description: The days that the demand tariff applies to.
          items:
            $ref: '#/components/schemas/EnergyDaysEnum'
          type: array
        description:
          description: Description of the charge.
          type: string
        displayName:
          description: Display name of the charge.
          type: string
        endTime:
          description: End of the period. 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
        maxDemand:
          description: Maximum demand for this demand tariff in kW. If present, must be higher than the value of the _minDemand_ field.
          type: string
          x-cds-type: AmountString
        measureUnit:
          allOf:
          - $ref: '#/components/schemas/MeasureUnitEnum'
          default: KWH
          description: The measurement unit of charge amount. Assumed to be `KWH` if absent.
          type: string
        measurementPeriod:
          description: Application period for the demand tariff.
          enum:
          - DAY
          - MONTH
          - TARIFF_PERIOD
          type: string
        minDemand:
          default: '0.00'
          description: Minimum demand for this demand tariff in kW. If absent then `0.00` is assumed.
          type: string
          x-cds-type: AmountString
        startTime:
          description: Start of the period. 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
      required:
      - amount
      - chargePeriod
      - displayName
      - endTime
      - measurementPeriod
      - startTime
      type: object
    EnergyPlanTariffPeriodV2_singleRate:
      description: Object representing a single rate. Required if _rateBlockUType_ is `singleRate`.
      properties:
        description:
          description: Description of the rate.
          type: string
        displayName:
          description: Display name of the rate.
          type: string
        generalUnitPrice:
          description: The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST. Only required if _pricingModel_ field is `QUOTA`.
          type: string
          x-cds-type: AmountString
        period:
          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).
          type: string
          x-cds-type: ExternalRef
        rates:
          description: Array of rates in order of usage volume.
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadV2_singleRate_rates'
          type: array
      required:
      - displayName
      - rates
      type: object
      x-conditional:
      - generalUnitPrice
    EnergyPlanTariffPeriodV2_timeOfUse:
      properties:
        days:
          description: The days that this time window applies to.
          items:
            $ref: '#/components/schemas/EnergyDaysEnum'
          type: array
        endTime:
          description: The end of the time window per day for which the rate applies. 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
        startTime:
          description: The beginning of the time window per day for which the rate applies. 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
      required:
      - days
      - endTime
      - startTime
      type: object
    Links:
      properties:
        self:
          description: Fully qualified link that generated the current response document.
          type: string
          x-cds-type: URIString
      required:
      - self
      type: object
    EnergyPlan_geography:
      description: Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited.
      properties:
        distributors:
          description: Array of distributors for the plan. Must have at least one entry.
          items:
            type: string
          type: array
        excludedPostcodes:
          description: Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g., `3000`) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g., `3000-3999`).
          items:
            type: string
          type: array
        includedPostcodes:
          description: Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g., `3000`) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g., `3000-3999`).
          items:
            type: string
          type: array
      required:
      - distributors
      type: object
    EnergyPlanFees:
      properties:
        amount:
          description: The fee amount. Required if _term_ is not `PERCENT_OF_BILL`.
          type: string
          x-cds-type: AmountString
        description:
          description: A description of the fee.
          type: string
        rate:
          description: The fee rate. Required if _term_ is `PERCENT_OF_BILL`.
          type: string
          x-cds-type: RateString
        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
        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
      required:
      - term
      - type
      type: object
      x-conditional:
      - amount
      - rate
    EnergyPlanGreenPowerCharges_tiers:
      properties:
        amount:
          description: The amount of the charge if the type implies the application of a fixed amount.
          type: string
          x-cds-type: AmountString
        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
      required:
      - percentGreen
      type: object
      x-conditional:
      - rate
      - amount
    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
    EnergyPlanControlledLoadV2_timeOfUseRates:
      properties:
        dailySupplyCharge:
          description: The daily supply charge (exclusive of GST) for this controlled load tier.
          type: string
          x-cds-type: AmountString
        description:
          description: Description of the controlled load rate.
          type: string
        displayName:
          description: Display name of the controlled load rate.
          type: string
        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
        rates:
          description: Array of controlled load rates in order of usage volume.
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadV2_singleRate_rates'
          type: array
        timeOfUse:
          description: Array of time windows for which this time of use rate applies.
          items:
            $ref: '#/components/schemas/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
    EnergyPlanTariffPeriodV2_bandedDailySupplyCharges:
      properties:
        measureUnit:
          allOf:
          - $ref: '#/components/schemas/MeasureUnitEnum'
          default: DAYS
          description: The measurement unit of rate. Assumed to be `DAYS` if absent.
          type: string
        unitPrice:
          description: The amount of daily supply charge for the band, in dollars per day exclusive of GST.
          type: string
          x-cds-type: AmountString
        volume:
          description: Volume the charge applies to.
          type: number
      required:
      - unitPrice
      type: object
    MeasureUnitEnum:
      enum:
      - KWH
      - KVA
      - KVAR
      - KVARH
      - KW
      - DAYS
      - METER
      - MONTH
      type: string
    LinksPaginated:
      properties:
        first:
          description: URI to the first page of this set. Mandatory if this response is not the first page.
          type: string
          x-cds-type: URIString
        last:
          description: URI to the last page of this set. Mandatory if this response is not the last page.
          type: string
          x-cds-type: URIString
        next:
          description: URI to the next page of this set. Mandatory if this response is not the last page.
          type: string
          x-cds-type: URIString
        prev:
          description: URI to the previous page of this set. Mandatory if this response is not the first page.
          type: string
          x-cds-type: URIString
        self:
          description: Fully qualified link that generated the current response document.
          type: string
          x-cds-type: URIString
      required:
      - self
      type: object
      x-conditional:
      - first
      - prev
      - next
      - last
    EnergyPlanDetailV3_allOf_meteringCharges:
      properties:
        description:
          description: Description of the charge.
          type: string
        displayName:
          description: Display name of the charge.
          type: string
        maximumValue:
          description: The upper limit of the charge if the charge could occur in a range.
          type: string
          x-cds-type: AmountString
        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
        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
    EnergyPlanId:
      description: The unique identifier for the Energy plan.
      type: string
      x-cds-type: ASCIIString
    EnergyPlanContractFullV3_allOf:
      properties:
        benefitPeriod:
          description: Description of the benefit period. Should only be present if _termType_ has the value `ONGOING`.
          type: string
        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
        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
        meterTypes:
          description: An array of the meter types that this contract is available for.
          items:
            type: string
          type: array
        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
        terms:
          description: Free text description of the terms for the contract.
          type: string
      required:
      - billFrequency
      type: object
      x-conditional:
      - benefitPeriod
      - variation
      - coolingOffDays
    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
    EnergyPlanTariffPeriodV2_timeOfUseRates:
      properties:
        description:
          description: Description of the rate.
          type: string
        displayName:
          description: Display name of the rate.
          type: string
        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
        rates:
          description: Array of rates in order of usage volume.
          items:
            $ref: '#/components/schemas/EnergyPlanControlledLoadV2_singleRate_rates'
          type: array
        timeOfUse:
          description: Array of time windows for which this time of use rate applies.
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV2_timeOfUse'
          type: array
        type:
          description: The type of usage that the rate applies to.
          enum:
          - PEAK
          - OFF_PEAK
          - SHOULDER
          - SHOULDER1
          - SHOULDER2
          type: string
      required:
      - displayName
      - rates
      - timeOfUse
      - type
      type: object
    EnergyPlanSolarFeedInTariffV3_singleTariff_rates:
      properties:
        measureUnit:
          allOf:
          - $ref: '#/components/schemas/MeasureUnitEnum'
          default: KWH
          description: The measurement unit of rate. Assumed to be `KWH` if absent.
          type: string
        unitPrice:
          description: Unit price of usage per measure unit (exclusive of GST).
          type: string
          x-cds-type: AmountString
        volume:
          description: Volume 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_singleRate_rates:
      properties:
        measureUnit:
          allOf:
          - $ref: '#/components/schemas/MeasureUnitEnum'
          default: KWH
          description: The measurement unit of rate. Assumed to be `KWH` if absent.
          type: string
        unitPrice:
          description: Unit price of usage per measure unit (exclusive of GST).
          type: string
          x-cds-type: AmountString
        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
    MetaPaginated:
      properties:
        totalPages:
          description: The total number of pages in the full set. See [pagination](#pagination).
          type: integer
          x-cds-type: NaturalNumber
        totalRecords:
          description: The total number of records in the full set. See [pagination](#pagination).
          type: integer
          x-cds-type: NaturalNumber
      required:
      - totalPages
      - totalRecords
      type: object
    EnergyPlan_additionalInformation:
      description: Object that contains links to additional information on specific topics.
      properties:
        bundleUri:
          description: A link to detail on bundles that this plan can be a part of.
          type: string
          x-cds-type: URIString
        eligibilityUri:
          description: A link to detail on eligibility criteria for the plan.
          type: string
          x-cds-type: URIString
        overviewUri:
          description: A link to a general overview of the plan.
          type: string
          x-cds-type: URIString
        pricingUri:
          description: A link to detail on pricing for the plan.
          type: string
          x-cds-type: URIString
        termsUri:
          description: A link to terms and conditions for the plan.
          type: string
          x-cds-type: URIString
      type: object
    EnergyDaysEnum:
      enum:
      - SUN
      - MON
      - TUE
      - WED
      - THU
      - FRI
      - SAT
      - PUBLIC_HOLIDAYS
      type: string
    ErrorV2_meta:
      description: Additional data for customised error codes.
      properties:
        urn:
          description: The CDR error code URN which the application-specific error code extends. Mandatory if the error _code_ is an application-specific error rather than a standardised error code.
          type: string
      type: object
      x-conditional:
      - urn
    EnergyPlanControlledLoadV2_singleRate:
      description: Object representing a single controlled load rate. Required if _rateBlockUType_ is `singleRate`.
      properties:
        dailySupplyCharge:
          description: The daily supply charge (exclusive of GST) for this controlled load tier.
          type: string
          x-cds-type: AmountString
        description:
          description: Description of the controlled load rate.
          type: string
        displayName:
          description: Display name of the controlled load rate.
          type: string
        period:
          default: P1Y
          description: Usage period for which the block rate applies. Format

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/energy-queensland/refs/heads/main/openapi/energy-queensland-energy-plans-api-openapi.yml