Simply Energy 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:
    EnergyPlanTariffPeriodV2:
      properties:
        type:
          default: OTHER
          description: Type of charge. Assumed to be `OTHER` if absent.
          enum:
          - ENVIRONMENTAL
          - REGULATED
          - NETWORK
          - METERING
          - RETAIL_SERVICE
          - RCTI
          - OTHER
          type: string
        displayName:
          description: The name of the tariff period.
          type: string
        startDate:
          description: The start date of the tariff period in a calendar year. Formatted in mm-dd format.
          type: string
        endDate:
          description: The end date of the tariff period in a calendar year. Formatted in mm-dd format.
          type: string
        dailySupplyChargeType:
          description: Specifies if daily supply charge is single or banded.
          enum:
          - SINGLE
          - BAND
          type: string
        dailySupplyCharge:
          description: The amount of access charge for the tariff period, in dollars per day exclusive of GST. Mandatory if _dailySupplyChargeType_ is `SINGLE`.
          type: string
          x-cds-type: AmountString
        bandedDailySupplyCharges:
          description: Array representing banded daily supply charge rates. Mandatory if _dailySupplyChargeType_ is `BAND`.
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV2_bandedDailySupplyCharges'
          type: array
        timeZone:
          description: Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.
          enum:
          - LOCAL
          - AEST
          type: string
        rateBlockUType:
          description: Specifies the type of rate applicable to this tariff period.
          enum:
          - singleRate
          - timeOfUseRates
          - demandCharges
          type: string
        singleRate:
          $ref: '#/components/schemas/EnergyPlanTariffPeriodV2_singleRate'
        timeOfUseRates:
          description: Array of objects representing time of use rates that apply throughout the _tariffPeriod_. Required if _rateBlockUType_ is `timeOfUseRates`.
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV2_timeOfUseRates'
          type: array
        demandCharges:
          description: Array of demand charges. Required if _rateBlockUType_ is `demandCharges`.
          items:
            $ref: '#/components/schemas/EnergyPlanTariffPeriodV2_demandCharges'
          type: array
      required:
      - displayName
      - endDate
      - rateBlockUType
      - startDate
      type: object
      x-conditional:
      - singleRate
      - timeOfUseRates
      - demandCharges
      - dailySupplyCharge
      - bandedDailySupplyCharges
    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: Reference to the applicable tariff structure.
          enum:
          - singleTariff
          - timeVaryingTariffs
          type: string
        singleTariff:
          $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV3_singleTariff'
        timeVaryingTariffs:
          description: Represents a tariff based on time of day. Mandatory if _tariffUType_ is set to `timeVaryingTariffs`.
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV3_timeVaryingTariffs'
          type: array
      required:
      - displayName
      - payerType
      - scheme
      - tariffUType
      type: object
      x-conditional:
      - singleTariff
      - timeVaryingTariffs
    Meta:
      type: object
    EnergyPlanContractFullV3:
      allOf:
      - $ref: '#/components/schemas/EnergyPlanContractV3'
      - $ref: '#/components/schemas/EnergyPlanContractFullV3_allOf'
    ErrorV2:
      properties:
        code:
          description: The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the _meta_ object. Otherwise, the value is the error code URN.
          type: string
        title:
          description: A short, human-readable summary of the problem that **MUST NOT** change from occurrence to occurrence of the problem represented by the error code.
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        meta:
          $ref: '#/components/schemas/ErrorV2_meta'
      required:
      - code
      - detail
      - title
      type: object
      x-conditional:
      - meta
    EnergyPlanListResponse_data:
      properties:
        plans:
          description: Array of plans.
          items:
            $ref: '#/components/schemas/EnergyPlan'
          type: array
      required:
      - plans
      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
    EnergyPlanTariffPeriodV2_timeOfUseRates:
      properties:
        displayName:
          description: Display name of the rate.
          type: string
        description:
          description: Description of the rate.
          type: string
        rates:
          description: Array of rates in order of usage volume.
          items:
            $ref: '#/components/schemas/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: '#/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
    EnergyPlanDetailV3_allOf:
      properties:
        meteringCharges:
          description: Charges for metering included in the plan.
          items:
            $ref: '#/components/schemas/EnergyPlanDetailV3_allOf_meteringCharges'
          type: array
        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`.
        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`.
      type: object
      x-conditional:
      - gasContract
      - electricityContract
    EnergyPlanControlledLoadV2_timeOfUse:
      properties:
        days:
          description: The days that this time window applies to.
          items:
            $ref: '#/components/schemas/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_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: '#/components/schemas/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
    EnergyPlanTariffPeriodV2_timeOfUse:
      properties:
        days:
          description: The days that this time window applies to.
          items:
            $ref: '#/components/schemas/EnergyDaysEnum'
          type: array
        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
        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
      required:
      - days
      - endTime
      - startTime
      type: object
    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: '#/components/schemas/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: '#/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
    Links:
      properties:
        self:
          description: Fully qualified link that generated the current response document.
          type: string
          x-cds-type: URIString
      required:
      - self
      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: '#/components/schemas/EnergyPlanGreenPowerCharges_tiers'
          type: array
      required:
      - displayName
      - scheme
      - tiers
      - type
      type: object
    MeasureUnitEnum:
      enum:
      - KWH
      - KVA
      - KVAR
      - KVARH
      - KW
      - DAYS
      - METER
      - MONTH
      type: string
    EnergyPlanSolarFeedInTariffV3_timeVaryingTariffs:
      properties:
        type:
          description: The type of the charging time period. If absent applies to all periods.
          enum:
          - PEAK
          - OFF_PEAK
          - SHOULDER
          type: string
        displayName:
          description: Display name of the tariff.
          type: string
        rates:
          description: Array of feed in rates.
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV3_singleTariff_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
        timeVariations:
          description: Array of time windows for which this tariff is applicable.
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV3_timeVariations'
          type: array
      required:
      - displayName
      - timeVariations
      type: object
    EnergyPlanId:
      description: The unique identifier for the Energy plan.
      type: string
      x-cds-type: ASCIIString
    EnergyPlanListResponse:
      properties:
        data:
          $ref: '#/components/schemas/EnergyPlanListResponse_data'
        links:
          $ref: '#/components/schemas/LinksPaginated'
        meta:
          $ref: '#/components/schemas/MetaPaginated'
      required:
      - data
      - links
      - meta
      type: object
    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
    EnergyPlan:
      properties:
        planId:
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/EnergyPlan_geography'
      required:
      - brand
      - brandName
      - fuelType
      - lastUpdated
      - planId
      - type
      type: object
    EnergyPlanSolarFeedInTariffV3_singleTariff:
      description: Represents a constant tariff. Mandatory if _tariffUType_ is set to `singleTariff`.
      properties:
        rates:
          description: Array of feed in rates.
          items:
            $ref: '#/components/schemas/EnergyPlanSolarFeedInTariffV3_singleTariff_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/w

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