Consumer Data Right (Energy) Energy Accounts API is one of 17 APIs that Consumer Data Right (Energy) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Energy Accounts. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a GitHub repository.
This API exposes
4 operations
across 4 paths,
and defines 63 schemas.
It is described by OpenAPI 3.2.0, at version 1.36.0.
Requests are made against a single base URL, https://mtls.dh.example.com/cds-au/v1.
The identity and technical contract details declared by the specification.
EnergyPlanDiscounts
object
10 properties
3 required
EnergyPaymentScheduleResponse_data
object
1 property
1 required
Links
object
1 property
1 required
EnergyConcessionsResponse_data
object
1 property
1 required
EnergyAccountDetailV4_allOf_planDetail
object
Detail on the plan applicable to this account. Mandatory if openStatus is OPEN.
5 properties
1 required
EnergyPlanContractV3_intrinsicGreenPower
object
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 con…
1 property
1 required
ErrorV2_meta
object
Additional data for customised error codes.
1 property
EnergyPaymentSchedule_directDebit
object
Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit.
5 properties
2 required
EnergyPlanTariffPeriodV2_demandCharges
object
11 properties
6 required
EnergyAccountId
string
A unique identifier for an Energy account, generated according to [CDR ID Permanence](id-permanence) requirements.
EnergyPlanDiscounts_percentOfUse
object
Required if methodUType is percentOfUse.
1 property
1 required
EnergyPlanTariffPeriodV2
object
12 properties
4 required
MetaPaginated
object
2 properties
2 required
EnergyPaymentScheduleResponse
object
3 properties
2 required
EnergyPlanSolarFeedInTariffV3_singleTariff
object
Represents a constant tariff. Mandatory if tariffUType is set to singleTariff.
2 properties
1 required
EnergyPlanControlledLoadV2_singleRate
object
Object representing a single controlled load rate. Required if rateBlockUType is singleRate.
5 properties
2 required
EnergyPlanSolarFeedInTariffV3
object
9 properties
4 required
LinksPaginated
object
5 properties
1 required
EnergyAccountV2_allOf
object
The array of plans containing service points and associated plan details.
1 property
1 required
EnergyPaymentSchedule_manualPayment
object
Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment.
1 property
1 required
EnergyPlanSolarFeedInTariffV3_singleTariff_rates
object
3 properties
1 required
EnergyPlanControlledLoadV2
object
6 properties
2 required
EnergyPlanTariffPeriodV2_bandedDailySupplyCharges
object
3 properties
1 required
EnergyPlanControlledLoadV2_timeOfUseRates
object
7 properties
4 required
EnergyServicePointId
string
A unique identifier for an Energy service point, generated according to [CDR ID Permanence](id-permanence) requirements.
ErrorV2
object
4 properties
3 required
EnergyPlanSolarFeedInTariffV3_timeVariations
object
3 properties
1 required
EnergyPlanDetailV3_allOf_meteringCharges
object
5 properties
2 required
EnergyPlanControlledLoadV2_singleRate_rates
object
3 properties
1 required
EnergyPlanIncentives
object
4 properties
3 required
EnergyPlanTariffPeriodV2_timeOfUse
object
3 properties
3 required
EnergyPaymentSchedule_digitalWallet
object
Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet.
6 properties
6 required
EnergyPlanEligibility
object
3 properties
2 required
EnergyAccountV2_allOf_planOverview
object
Mandatory if openStatus is OPEN.
3 properties
1 required
EnergyPlanTariffPeriodV2_timeOfUseRates
object
6 properties
4 required
EnergyPlanDiscounts_percentOfBill
object
Required if methodUType is percentOfBill.
1 property
1 required
EnergyPaymentSchedule_cardDebit
object
Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit.
3 properties
3 required
EnergyPlanControlledLoadV2_timeOfUse
object
5 properties
EnergyAccountV2_allOf_plans
object
3 properties
1 required
EnergyConcessionsResponse
object
3 properties
2 required
EnergyAccountBaseV2
object
5 properties
1 required
EnergyAccountDetailV4_allOf_authorisedContacts
object
5 properties
1 required
EnergyAccountDetailV4_allOf
object
The array of plans containing service points and associated plan details.
1 property
1 required
EnergyPlanSolarFeedInTariffV3_timeVaryingTariffs
object
5 properties
2 required
EnergyAccountListResponseV2_data
object
1 property
1 required
EnergyPlanFees
object
5 properties
2 required
ResponseErrorListV2
object
1 property
1 required
EnergyAccountListResponseV2
object
3 properties
3 required
EnergyAccountDetailResponseV4
object
3 properties
2 required
EnergyPlanGreenPowerCharges
object
5 properties
4 required
EnergyPlanDiscounts_fixedAmount
object
Required if methodUType is fixedAmount.
1 property
1 required
EnergyConcession
object
10 properties
2 required
EnergyPlanTariffPeriodV2_singleRate
object
Object representing a single rate. Required if rateBlockUType is singleRate.
5 properties
2 required
EnergyPlanGreenPowerCharges_tiers
object
3 properties
1 required
EnergyPaymentSchedule
object
6 properties
1 required
EnergyPlanContractV3
object
16 properties
4 required
EnergyAccountDetailV4_allOf_plans
object
5 properties
1 required
EnergyPlanDiscounts_percentOverThreshold
object
Required if methodUType is percentOverThreshold.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Consumer Data Right (Energy) publishes across the network.
