The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the Authorization header.
You should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you must:
Verify the signature
Ensure the token has not expired by checking the exp claim
The sub and iss claims are your data provider subdomain
The aud claim is the URI of the resource being requested (excluding any query parameters)
The jti value is unique
For further detail on security and authentication refer to our Authentication documentation
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fiskil","colors":{"primary":"#191b15","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/fiskil/3jtGQNqcSr5N4TNw/logo/light.svg?fit=max\u0026auto=format\u0026n=3jtGQNqcSr5N4TNw\u0026q=85\u0026s=acb4183b4445e3ca4d0a4637752c3943","dark":"https://mintcdn.com/fiskil/3jtGQNqcSr5N4TNw/logo/dark.svg?fit=max\u0026auto=format\u0026n=3jtGQNqcSr5N4TNw\u0026q=85\u0026s=8c629fe8068a14827769da2017e4cc63"},"favicon":"https://mintcdn.com/fiskil/LpdVPOo2gKHc0Bqu/favicon.png?fit=max\u0026auto=format\u0026n=LpdVPOo2gKHc0Bqu\u0026q=85\u0026s=dfe1748146c5e63e3caa317a55fe6f4b","appearance":{"default":"light"},"background":{"decoration":"grid"},"navbar":{"primary":{"type":"button","label":"Connect now","href":"https://www.fiskil.com/contact"}},"footer":{"socials":{"x":"https://twitter.com/Fiskil_","linkedin":"https://www.linkedin.com/company/fiskil"}},"fonts":{"heading":{"family":"Manrope"},"body":{"family":"Figtree"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://www.fiskil.com"},{"anchor":"Support","icon":"headset","href":"https://www.fiskil.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fiskil","hasAudioNarration":false,"actualSubdomain":"fiskil","customDomains":["holder.docs.fiskil.dev"],"gitSource":{"type":"github","owner":"fiskil","repo":"dp_docs_v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae27f24defc6aa028e6aae8","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":61},{"language":"default","tag":"CDR","count":44},{"language":"default","tag":"Data Sharing","count":36},{"language":"default","tag":"Docs","count":27},{"language":"default","tag":"Banking","count":15},{"language":"default","tag":"FDX","count":12},{"language":"default","tag":"Energy","count":11},{"language":"default","tag":"Consent Flow","count":10},{"language":"default","tag":"Platform API","count":9},{"language":"default","tag":"Testing CDR","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#navigation-items>button:first-child{margin-bottom:24px}img[src$=\"/icons/cdr.svg\"],img[src$=\"icons/cdr.svg\"],img[src*=\"/icons/cdr\"],svg#Layer_1{background-color:transparent!important}img[src$=\"/icons/cdr.svg\"],img[src$=\"icons/cdr.svg\"]{filter:none!important;-webkit-filter:none!important}img[src$=\"/icons/fdx.svg\"],img[src$=\"icons/fdx.svg\"],img[src*=\"/icons/fdx\"]{background-color:transparent!important;filter:none!important;-webkit-filter:none!important}img[src$=\"/icons/cdr.svg\"],img[src$=\"icons/cdr.svg\"],img[src*=\"/icons/cdr\"],img[src$=\"/icons/fdx.svg\"],img[src$=\"icons/fdx.svg\"],img[src*=\"/icons/fdx\"]{width:20px!important;height:20px!important;vertical-align:middle}"}],"page":{"pagePath":"api-reference/energy/get-energy-account-detail","slug":"/api-reference/energy/get-energy-account-detail","pageMetadata":{"title":"Get Energy Account Detail","description":"Obtain detailed information for a specific energy account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}","href":"/api-reference/energy/get-energy-account-detail","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Obtain detailed information for a specific energy account\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Energy Account Detail","description":"Obtain detailed information for a specific energy account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}","href":"/api-reference/energy/get-energy-account-detail","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fiskil/23b3382855374c54/sidebar.js"],"openApiReferenceData":{"operation":{"description":"Obtain detailed information for a specific energy account","operationId":"getAccount","parameters":["693824a9-1476-4846-8a80-718ab52c56cb","477bf88a-0904-4a28-b9e1-256b7f1777f0"],"responses":{"200":"87e640da-68c9-4963-ae2d-aa172855ee32","404":"e2a34135-ae35-4a39-bafb-c2a106a1f234"},"summary":"Get Energy Account Detail","tags":["Energy","Accounts"],"method":"get","type":"path","servers":["8e56edbd-71c3-4c89-9d53-903044920b32"],"security":["5609e27a-91a0-4697-9efe-47e4706ce093"],"path":"/v1/energy/customer/{customerId}/accounts/{accountId}","baseUrlOptions":["https://api.provider.fiskil.com"],"title":"Get Energy Account Detail","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"693824a9-1476-4846-8a80-718ab52c56cb":{"description":"Unique ID of a customer. This ID must not change for the lifecycle of the customer","explode":false,"in":"path","name":"customerId","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique ID of a customer. This ID must not change for the lifecycle of the customer","uniqueKey":"","typeLabel":"string"},"style":"simple"},"477bf88a-0904-4a28-b9e1-256b7f1777f0":{"description":"ID of a specific account to obtain data for.","explode":false,"in":"path","name":"accountId","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of a specific account to obtain data for.","uniqueKey":"","typeLabel":"string"},"style":"simple"}},"responses":{"87e640da-68c9-4963-ae2d-aa172855ee32":{"content":{"application/json":{"schema":{"example":{"data":{"accountId":"019a08ff-90b2-71b3-9704-2f5dc6647e49","accountNumber":"0123456789","displayName":"Resi Single Rate","openStatus":"OPEN","creationDate":"2025-01-01T00:00:00.000Z","plans":[{"nickname":"Resi Single Rate","servicePointIds":["4123456789"],"planOverview":{"displayName":"Resi Single Rate","startDate":"2025-01-01T00:00:00.000Z"},"planDetail":{"fuelType":"ELECTRICITY","isContingentPlan":false,"meteringCharges":[{"displayName":"standard metering charge","description":"Basic fee for metering","minimumValue":"0.20","period":"P3M"}],"electricityContract":{"additionalFeeInformation":"A fee applies for missed payments","pricingModel":"SINGLE_RATE","timeZone":"LOCAL","isFixed":true,"variation":"We may vary the rates for your electricity consumption with 30 days notice","paymentOption":["PAPER_BILL","CREDIT_CARD","DIRECT_DEBIT","BPAY"],"intrinsicGreenPower":{"greenPercentage":"0.7"},"controlledLoad":[{"displayName":"Basic Controlled Load Appliance","rateBlockUType":"singleRate","startDate":"2025-01-01T00:00:00.000Z","singleRate":{"displayName":"Single Appliance","description":"Controlled load rate for a single appliance","dailySupplyCharge":"0.75","rates":[{"unitPrice":"0.332","measureUnit":"KWH"}]}}],"incentives":[{"displayName":"Cashbacks","description":"Sign up bonus","category":"ACCOUNT_CREDIT","eligibility":"If you sign up before 2025-02-01 you will get $100 cash back as credit on your bill"}],"discounts":[{"displayName":"Pay on time","description":"Pay on time to get 1% off your bill","type":"CONDITIONAL","category":"PAY_ON_TIME","endDate":"string","methodUType":"percentOfBill","percentOfBill":{"rate":"0.1"}}],"eligibility":[{"type":"NEW_CUSTOMER","information":"You must not have been a customer within the last 24 monthsr","description":"Only new customers are eligible for cashback incentives"}],"fees":[{"type":"LATE_PAYMENT","term":"PERCENT_OF_BILL","rate":"0.05","description":"A 0.05% fee applies if your bill is not paid on time."}],"solarFeedInTariff":[{"displayName":"Single rate Solar FiT","description":"Single Rate Solar feed-in tariff","startDate":"2025-01-01T00:00:00.000Z","scheme":"PREMIUM","payerType":"RETAILERT","tariffUType":"singleTariff","singleTariff":{"rates":[{"unitPrice":"0.054","measureUnit":"KWH"}]}}],"tariffPeriod":[{"type":"RETAIL_SERVICE","displayName":"Single Rate","startDate":"2025-01-01T00:00:00.000Z","dailySupplyCharges":"0.64","timeZone":"LOCAL","rateBlockUType":"singleRate","singleRate":{"displayName":"string","description":"string","generalUnitPrice":"string","rates":[{"unitPrice":"0.342","measureUnit":"KWH"}]}}]}},"authorisedContacts":[{"firstName":"Peter","lastName":"Sherman","prefix":"Dr"}]}]}},"properties":{"data":{"type":"object","required":["plans","accountId"],"x-conditional":["creationDate"],"properties":{"accountId":{"description":"The ID of the account. To be created in accordance with CDR ID permanence requirements","type":"string","isRequired":true,"uniqueKey":"data.accountId","typeLabel":"string"},"plans":{"description":"The array of plans containing service points and associated plan details.","items":{"properties":{"servicePointIds":{"description":"An array of servicePointIds, representing NMIs, that this account is linked to","items":{"type":"string","uniqueKey":"data.plans.items.[INDEX].servicePointIds.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].servicePointIds","typeLabel":"string[]"},"nickname":{"description":"Optional display name for the plan provided by the customer to help differentiate multiple plans","type":"string","uniqueKey":"data.plans.items.[INDEX].nickname","typeLabel":"string"},"planOverview":{"description":"Mandatory if openStatus is OPEN","properties":{"startDate":{"description":"The start date of the applicability of this plan","type":"string","x-cds-type":"DateString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planOverview.startDate","typeLabel":"string"},"displayName":{"description":"The name of the plan if one exists","type":"string","uniqueKey":"data.plans.items.[INDEX].planOverview.displayName","typeLabel":"string"},"endDate":{"description":"The end date of the applicability of this plan","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planOverview.endDate","typeLabel":"string"}},"required":["startDate"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planOverview","typeLabel":"object"},"planDetail":{"description":"Detail on the plan applicable to this account. Mandatory if openStatus is OPEN","properties":{"fuelType":{"description":"The fuel types covered by the plan","enum":["ELECTRICITY","GAS","DUAL"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.fuelType","typeLabel":"enum\u003cstring>"},"isContingentPlan":{"default":false,"description":"Flag that 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). Has no meaning if the plan has a fuelType of DUAL. If absent the value is assumed to be false","type":"boolean","uniqueKey":"data.plans.items.[INDEX].planDetail.isContingentPlan","typeLabel":"boolean"},"meteringCharges":{"description":"Charges for metering included in the plan","items":{"properties":{"displayName":{"description":"Display name of the charge","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges.items.[INDEX].displayName","typeLabel":"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges.items.[INDEX].minimumValue","typeLabel":"string"},"description":{"description":"Description of the charge","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges.items.[INDEX].description","typeLabel":"string"},"maximumValue":{"description":"The upper limit of the charge if the charge could occur in a range","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges.items.[INDEX].maximumValue","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges.items.[INDEX].period","typeLabel":"string"}},"required":["displayName","minimumValue"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.meteringCharges","typeLabel":"object[]"},"gasContract":{"properties":{"pricingModel":{"description":"The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:\u003cul>\u003cli>**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.\u003c/li>\u003cli>**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.\u003c/li>\u003cli>**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\u003c/li>\u003cli>**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.\u003c/li>\u003cli>**FLEXIBLE** - energy usage is charged at unit rates that vary based on external factors\u003c/li>\u003cli>**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.\u003c/li>\u003cli>**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 (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage\u003c/li>\u003c/ul>","enum":["SINGLE_RATE","SINGLE_RATE_CONT_LOAD","TIME_OF_USE","TIME_OF_USE_CONT_LOAD","FLEXIBLE","FLEXIBLE_CONT_LOAD","QUOTA"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.pricingModel","typeLabel":"enum\u003cstring>"},"isFixed":{"description":"Flag indicating whether prices are fixed or variable","type":"boolean","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.isFixed","typeLabel":"boolean"},"paymentOption":{"description":"Payment options for this contract","items":{"enum":["PAPER_BILL","CREDIT_CARD","DIRECT_DEBIT","BPAY","OTHER"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.paymentOption.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.paymentOption","typeLabel":"enum\u003cstring>[]"},"tariffPeriod":{"description":"Array of tariff periods","items":{"properties":{"displayName":{"description":"The name of the tariff period","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].displayName","typeLabel":"string"},"startDate":{"description":"The start date of the tariff period in a calendar year. Formatted in mm-dd format","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"description":"The end date of the tariff period in a calendar year. Formatted in mm-dd format","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].endDate","typeLabel":"string"},"rateBlockUType":{"description":"Specifies the type of rate applicable to this tariff period","enum":["singleRate","timeOfUseRates","demandCharges"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].rateBlockUType","typeLabel":"enum\u003cstring>"},"type":{"description":"Type of charge. Assumed to be other if absent","enum":["ENVIRONMENTAL","REGULATED","NETWORK","METERING","RETAIL_SERVICE","RCTI","OTHER"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"dailySupplyCharges":{"description":"The amount of access charge for the tariff period, in dollars per day exclusive of GST.","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].dailySupplyCharges","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeZone","typeLabel":"enum\u003cstring>"},"singleRate":{"description":"Object representing a single rate. Required if rateBlockUType is singleRate","properties":{"displayName":{"description":"Display name of the rate","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.rates","typeLabel":"object[]"},"description":{"description":"Description of the rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.description","typeLabel":"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.generalUnitPrice","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate.period","typeLabel":"string"}},"required":["displayName","rates"],"type":"object","x-conditional":["generalUnitPrice"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].singleRate","typeLabel":"object"},"timeOfUseRates":{"description":"Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates","items":{"properties":{"displayName":{"description":"Display name of the rate","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates","typeLabel":"object[]"},"timeOfUse":{"description":"Array of times of use","items":{"properties":{"days":{"description":"The days that the rate applies to","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"startTime":{"description":"Start of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"End of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].endTime","typeLabel":"string"}},"required":["days","endTime","startTime"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse","typeLabel":"object[]"},"type":{"description":"The type of usage that the rate applies to","enum":["PEAK","OFF_PEAK","SHOULDER","SHOULDER1","SHOULDER2"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"description":"Description of the rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].description","typeLabel":"string"}},"required":["displayName","rates","timeOfUse","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].timeOfUseRates","typeLabel":"object[]"},"demandCharges":{"description":"Array of demand charges. Required if rateBlockUType is demandCharges","items":{"properties":{"displayName":{"description":"Display name of the charge","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].displayName","typeLabel":"string"},"amount":{"description":"The charge amount per measure unit exclusive of GST","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].amount","typeLabel":"string"},"startTime":{"description":"Start of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"End of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].endTime","typeLabel":"string"},"measurementPeriod":{"description":"Application period for the demand tariff","enum":["DAY","MONTH","TARIFF_PERIOD"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].measurementPeriod","typeLabel":"enum\u003cstring>"},"chargePeriod":{"description":"Charge period for the demand tariff","enum":["DAY","MONTH","TARIFF_PERIOD"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].chargePeriod","typeLabel":"enum\u003cstring>"},"description":{"description":"Description of the charge","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].description","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of charge amount. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"days":{"description":"The days that the demand tariff applies to","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"minDemand":{"description":"Minimum demand for this demand tariff in kW. If absent then 0 is assumed","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].minDemand","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].maxDemand","typeLabel":"string"}},"required":["amount","chargePeriod","displayName","endTime","measurementPeriod","startTime"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX].demandCharges","typeLabel":"object[]"}},"required":["displayName","endDate","rateBlockUType","startDate"],"type":"object","x-conditional":["singleRate","timeOfUseRates","demandCharges"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.tariffPeriod","typeLabel":"object[]"},"additionalFeeInformation":{"description":"Free text field containing additional information of the fees for this contract","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.additionalFeeInformation","typeLabel":"string"},"timeZone":{"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.timeZone","typeLabel":"enum\u003cstring>"},"variation":{"description":"Free text description of price variation policy and conditions for the contract. Mandatory if `isFixed` is false","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.variation","typeLabel":"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.onExpiryDescription","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.intrinsicGreenPower.greenPercentage","typeLabel":"string"}},"required":["greenPercentage"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.intrinsicGreenPower","typeLabel":"object"},"controlledLoad":{"description":"Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD","items":{"properties":{"displayName":{"description":"A display name for the controlled load","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].displayName","typeLabel":"string"},"rateBlockUType":{"description":"Specifies the type of controlloed load rate ","enum":["singleRate","timeOfUseRates"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].rateBlockUType","typeLabel":"enum\u003cstring>"},"startDate":{"description":"Optional start date of the application of the controlled load rate","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"description":"Optional end date of the application of the controlled load rate","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].endDate","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.rates","typeLabel":"object[]"},"description":{"description":"Description of the controlled load rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.description","typeLabel":"string"},"dailySupplyCharge":{"description":"The daily supply charge (exclusive of GST) for this controlled load tier","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate.dailySupplyCharge","typeLabel":"string"}},"required":["displayName","rates"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].singleRate","typeLabel":"object"},"timeOfUseRates":{"description":"Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates","items":{"properties":{"displayName":{"description":"Display name of the controlled load rate","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates","typeLabel":"object[]"},"timeOfUse":{"description":"Array of times of use.","items":{"properties":{"days":{"description":"The days that the rate applies to","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"startTime":{"description":"The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"The end of the time period per day for which the controlled load rate applies. Required if startTime provided","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].endTime","typeLabel":"string"},"additionalInfo":{"description":"Display text providing more information on the contrlled 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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].additionalInfo","typeLabel":"string"},"additionalInfoUri":{"description":"Optional link to additional information regarding the controlled load","type":"string","x-cds-type":"URIString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].additionalInfoUri","typeLabel":"string"}},"type":"object","x-conditional":["startTime","endTime","additionalInfo"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse","typeLabel":"object[]"},"type":{"description":"The type of usage that the rate applies to","enum":["PEAK","OFF_PEAK","SHOULDER","SOLAR_SPONGE"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"description":"Description of the controlled load rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].description","typeLabel":"string"},"dailySupplyCharge":{"description":"The daily supply charge (exclusive of GST) for this controlled load tier","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].dailySupplyCharge","typeLabel":"string"}},"required":["displayName","rates","timeOfUse","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX].timeOfUseRates","typeLabel":"object[]"}},"required":["displayName","rateBlockUType"],"type":"object","x-conditional":["singleRate","timeOfUseRates"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.controlledLoad","typeLabel":"object[]"},"incentives":{"description":"Optional list of incentives available for the contract","items":{"properties":{"displayName":{"description":"The display name of the incentive","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.incentives.items.[INDEX].displayName","typeLabel":"string"},"description":{"description":"The description of the incentive","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.incentives.items.[INDEX].description","typeLabel":"string"},"category":{"description":"The type of the incentive","enum":["GIFT","ACCOUNT_CREDIT","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.incentives.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"eligibility":{"description":"A display message outlining an eligibility criteria that may apply","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.incentives.items.[INDEX].eligibility","typeLabel":"string"}},"required":["category","description","displayName"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.incentives.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.incentives","typeLabel":"object[]"},"discounts":{"description":"Optional list of discounts available for the contract","items":{"properties":{"displayName":{"description":"The display name of the discount","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].displayName","typeLabel":"string"},"type":{"description":"The type of the discount","enum":["CONDITIONAL","GUARANTEED","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"methodUType":{"description":"The method of calculation of the discount","enum":["percentOfBill","percentOfUse","fixedAmount","percentOverThreshold"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].methodUType","typeLabel":"enum\u003cstring>"},"description":{"description":"The description of the discount","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].description","typeLabel":"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"endDate":{"description":"Optional end date for the discount after which the discount is no longer available","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].endDate","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOfBill.rate","typeLabel":"string"}},"required":["rate"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOfBill","typeLabel":"object"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOfUse.rate","typeLabel":"string"}},"required":["rate"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOfUse","typeLabel":"object"},"fixedAmount":{"description":"Required if methodUType is fixedAmount","properties":{"amount":{"description":"The amount of the discount","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].fixedAmount.amount","typeLabel":"string"}},"required":["amount"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].fixedAmount","typeLabel":"object"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOverThreshold.rate","typeLabel":"string"},"usageAmount":{"description":"The usage amount threshold above which the discount applies","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOverThreshold.usageAmount","typeLabel":"string"}},"required":["rate","usageAmount"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX].percentOverThreshold","typeLabel":"object"}},"required":["displayName","methodUType","type"],"type":"object","x-conditional":["percentOfBill","percentOfUse","fixedAmount","percentOverThreshold"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.discounts","typeLabel":"object[]"},"greenPowerCharges":{"description":"Optional list of charges applicable to green power","items":{"properties":{"displayName":{"description":"The display name of the charge","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].displayName","typeLabel":"string"},"scheme":{"description":"The applicable green power scheme","enum":["GREENPOWER","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].scheme","typeLabel":"enum\u003cstring>"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"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":{"properties":{"percentGreen":{"description":"The upper percentage of green power used applicable for this tier","type":"string","x-cds-type":"RateString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX].percentGreen","typeLabel":"string"},"rate":{"description":"The rate of the charge if the type implies the application of a rate","type":"string","x-cds-type":"RateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX].rate","typeLabel":"string"},"amount":{"description":"The amount of the charge if the type implies the application of a fixed amount","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX].amount","typeLabel":"string"}},"required":["percentGreen"],"type":"object","x-conditional":["rate","amount"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].tiers","typeLabel":"object[]"},"description":{"description":"The description of the charge","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX].description","typeLabel":"string"}},"required":["displayName","scheme","tiers","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.greenPowerCharges","typeLabel":"object[]"},"eligibility":{"description":"Eligibility restrictions or requirements","items":{"properties":{"type":{"description":"The type of the eligibility restriction.\nThe 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)\n","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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.eligibility.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"information":{"description":"Information of the eligibility restriction specific to the type of the restriction","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.eligibility.items.[INDEX].information","typeLabel":"string"},"description":{"description":"A description of the eligibility restriction","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.eligibility.items.[INDEX].description","typeLabel":"string"}},"required":["information","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.eligibility.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.eligibility","typeLabel":"object[]"},"fees":{"description":"An array of fees applicable to the plan","items":{"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees.items.[INDEX].term","typeLabel":"enum\u003cstring>"},"amount":{"description":"The fee amount. Required if term is not PERCENT_OF_BILL","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees.items.[INDEX].amount","typeLabel":"string"},"rate":{"description":"The fee rate. Required if term is PERCENT_OF_BILL","type":"string","x-cds-type":"RateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees.items.[INDEX].rate","typeLabel":"string"},"description":{"description":"A description of the fee","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees.items.[INDEX].description","typeLabel":"string"}},"required":["term","type"],"type":"object","x-conditional":["amount","rate"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.fees","typeLabel":"object[]"},"solarFeedInTariff":{"description":"Array of feed in tariffs for solar power","items":{"properties":{"displayName":{"description":"The name of the tariff","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].displayName","typeLabel":"string"},"scheme":{"description":"The applicable scheme","enum":["PREMIUM","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].scheme","typeLabel":"enum\u003cstring>"},"payerType":{"description":"The type of the payer","enum":["GOVERNMENT","RETAILER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].payerType","typeLabel":"enum\u003cstring>"},"tariffUType":{"description":"The type of the payer","enum":["singleTariff","timeVaryingTariffs"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].tariffUType","typeLabel":"enum\u003cstring>"},"description":{"description":"A description of the tariff","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].description","typeLabel":"string"},"startDate":{"description":"The start date of the application of the feed in tariff","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"description":"The end date of the application of the feed in tariff","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].endDate","typeLabel":"string"},"singleTariff":{"description":"Represents a constant tariff. Mandatory if tariffUType is set to singleTariff","properties":{"rates":{"description":"Array of feed in rates","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].singleTariff.rates","typeLabel":"object[]"}},"required":["rates"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].singleTariff","typeLabel":"object"},"timeVaryingTariffs":{"description":"Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs","properties":{"timeVariations":{"description":"Array of time periods for which this tariff is applicable","items":{"properties":{"days":{"description":"The days that the tariff applies to. At least one entry required","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"startTime":{"description":"The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].endTime","typeLabel":"string"}},"required":["days"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations","typeLabel":"object[]"},"type":{"description":"The type of the charging time period. If absent applies to all periods","enum":["PEAK","OFF_PEAK","SHOULDER"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.type","typeLabel":"enum\u003cstring>"},"rates":{"description":"Array of feed in rates","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates","typeLabel":"object[]"}},"required":["timeVariations"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs","typeLabel":"object"}},"required":["displayName","payerType","scheme","tariffUType"],"type":"object","x-conditional":["singleTariff","timeVaryingTariffs"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract.solarFeedInTariff","typeLabel":"object[]"}},"required":["isFixed","paymentOption","pricingModel","tariffPeriod"],"type":"object","x-conditional":["timeZone","variation","controlledLoad"],"uniqueKey":"data.plans.items.[INDEX].planDetail.gasContract","typeLabel":"object"},"electricityContract":{"properties":{"pricingModel":{"description":"The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:\u003cul>\u003cli>**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.\u003c/li>\u003cli>**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.\u003c/li>\u003cli>**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\u003c/li>\u003cli>**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.\u003c/li>\u003cli>**FLEXIBLE** - energy usage is charged at unit rates that vary based on external factors\u003c/li>\u003cli>**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.\u003c/li>\u003cli>**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 (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage\u003c/li>\u003c/ul>","enum":["SINGLE_RATE","SINGLE_RATE_CONT_LOAD","TIME_OF_USE","TIME_OF_USE_CONT_LOAD","FLEXIBLE","FLEXIBLE_CONT_LOAD","QUOTA"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.pricingModel","typeLabel":"enum\u003cstring>"},"isFixed":{"description":"Flag indicating whether prices are fixed or variable","type":"boolean","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.isFixed","typeLabel":"boolean"},"paymentOption":{"description":"Payment options for this contract","items":{"enum":["PAPER_BILL","CREDIT_CARD","DIRECT_DEBIT","BPAY","OTHER"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.paymentOption.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.paymentOption","typeLabel":"enum\u003cstring>[]"},"tariffPeriod":{"description":"Array of tariff periods","items":{"properties":{"displayName":{"description":"The name of the tariff period","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].displayName","typeLabel":"string"},"startDate":{"description":"The start date of the tariff period in a calendar year. Formatted in mm-dd format","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"description":"The end date of the tariff period in a calendar year. Formatted in mm-dd format","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].endDate","typeLabel":"string"},"rateBlockUType":{"description":"Specifies the type of rate applicable to this tariff period","enum":["singleRate","timeOfUseRates","demandCharges"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].rateBlockUType","typeLabel":"enum\u003cstring>"},"type":{"description":"Type of charge. Assumed to be other if absent","enum":["ENVIRONMENTAL","REGULATED","NETWORK","METERING","RETAIL_SERVICE","RCTI","OTHER"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"dailySupplyCharges":{"description":"The amount of access charge for the tariff period, in dollars per day exclusive of GST.","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].dailySupplyCharges","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeZone","typeLabel":"enum\u003cstring>"},"singleRate":{"description":"Object representing a single rate. Required if rateBlockUType is singleRate","properties":{"displayName":{"description":"Display name of the rate","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.rates","typeLabel":"object[]"},"description":{"description":"Description of the rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.description","typeLabel":"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.generalUnitPrice","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate.period","typeLabel":"string"}},"required":["displayName","rates"],"type":"object","x-conditional":["generalUnitPrice"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].singleRate","typeLabel":"object"},"timeOfUseRates":{"description":"Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates","items":{"properties":{"displayName":{"description":"Display name of the rate","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].rates","typeLabel":"object[]"},"timeOfUse":{"description":"Array of times of use","items":{"properties":{"days":{"description":"The days that the rate applies to","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"startTime":{"description":"Start of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"End of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].endTime","typeLabel":"string"}},"required":["days","endTime","startTime"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse","typeLabel":"object[]"},"type":{"description":"The type of usage that the rate applies to","enum":["PEAK","OFF_PEAK","SHOULDER","SHOULDER1","SHOULDER2"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"description":"Description of the rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX].description","typeLabel":"string"}},"required":["displayName","rates","timeOfUse","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].timeOfUseRates","typeLabel":"object[]"},"demandCharges":{"description":"Array of demand charges. Required if rateBlockUType is demandCharges","items":{"properties":{"displayName":{"description":"Display name of the charge","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].displayName","typeLabel":"string"},"amount":{"description":"The charge amount per measure unit exclusive of GST","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].amount","typeLabel":"string"},"startTime":{"description":"Start of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"End of the period","type":"string","x-cds-type":"TimeString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].endTime","typeLabel":"string"},"measurementPeriod":{"description":"Application period for the demand tariff","enum":["DAY","MONTH","TARIFF_PERIOD"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].measurementPeriod","typeLabel":"enum\u003cstring>"},"chargePeriod":{"description":"Charge period for the demand tariff","enum":["DAY","MONTH","TARIFF_PERIOD"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].chargePeriod","typeLabel":"enum\u003cstring>"},"description":{"description":"Description of the charge","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].description","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of charge amount. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"days":{"description":"The days that the demand tariff applies to","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"minDemand":{"description":"Minimum demand for this demand tariff in kW. If absent then 0 is assumed","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].minDemand","typeLabel":"string"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX].maxDemand","typeLabel":"string"}},"required":["amount","chargePeriod","displayName","endTime","measurementPeriod","startTime"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX].demandCharges","typeLabel":"object[]"}},"required":["displayName","endDate","rateBlockUType","startDate"],"type":"object","x-conditional":["singleRate","timeOfUseRates","demandCharges"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.tariffPeriod","typeLabel":"object[]"},"additionalFeeInformation":{"description":"Free text field containing additional information of the fees for this contract","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.additionalFeeInformation","typeLabel":"string"},"timeZone":{"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.timeZone","typeLabel":"enum\u003cstring>"},"variation":{"description":"Free text description of price variation policy and conditions for the contract. Mandatory if `isFixed` is false","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.variation","typeLabel":"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.onExpiryDescription","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.intrinsicGreenPower.greenPercentage","typeLabel":"string"}},"required":["greenPercentage"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.intrinsicGreenPower","typeLabel":"object"},"controlledLoad":{"description":"Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD","items":{"properties":{"displayName":{"description":"A display name for the controlled load","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].displayName","typeLabel":"string"},"rateBlockUType":{"description":"Specifies the type of controlloed load rate ","enum":["singleRate","timeOfUseRates"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].rateBlockUType","typeLabel":"enum\u003cstring>"},"startDate":{"description":"Optional start date of the application of the controlled load rate","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"description":"Optional end date of the application of the controlled load rate","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].endDate","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.rates","typeLabel":"object[]"},"description":{"description":"Description of the controlled load rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.description","typeLabel":"string"},"dailySupplyCharge":{"description":"The daily supply charge (exclusive of GST) for this controlled load tier","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate.dailySupplyCharge","typeLabel":"string"}},"required":["displayName","rates"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].singleRate","typeLabel":"object"},"timeOfUseRates":{"description":"Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates","items":{"properties":{"displayName":{"description":"Display name of the controlled load rate","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].displayName","typeLabel":"string"},"rates":{"description":"Array of controlled load rates in order of usage volume","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].rates","typeLabel":"object[]"},"timeOfUse":{"description":"Array of times of use.","items":{"properties":{"days":{"description":"The days that the rate applies to","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"startTime":{"description":"The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"The end of the time period per day for which the controlled load rate applies. Required if startTime provided","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].endTime","typeLabel":"string"},"additionalInfo":{"description":"Display text providing more information on the contrlled 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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].additionalInfo","typeLabel":"string"},"additionalInfoUri":{"description":"Optional link to additional information regarding the controlled load","type":"string","x-cds-type":"URIString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX].additionalInfoUri","typeLabel":"string"}},"type":"object","x-conditional":["startTime","endTime","additionalInfo"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].timeOfUse","typeLabel":"object[]"},"type":{"description":"The type of usage that the rate applies to","enum":["PEAK","OFF_PEAK","SHOULDER","SOLAR_SPONGE"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"description":"Description of the controlled load rate","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].description","typeLabel":"string"},"dailySupplyCharge":{"description":"The daily supply charge (exclusive of GST) for this controlled load tier","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX].dailySupplyCharge","typeLabel":"string"}},"required":["displayName","rates","timeOfUse","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX].timeOfUseRates","typeLabel":"object[]"}},"required":["displayName","rateBlockUType"],"type":"object","x-conditional":["singleRate","timeOfUseRates"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.controlledLoad","typeLabel":"object[]"},"incentives":{"description":"Optional list of incentives available for the contract","items":{"properties":{"displayName":{"description":"The display name of the incentive","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.incentives.items.[INDEX].displayName","typeLabel":"string"},"description":{"description":"The description of the incentive","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.incentives.items.[INDEX].description","typeLabel":"string"},"category":{"description":"The type of the incentive","enum":["GIFT","ACCOUNT_CREDIT","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.incentives.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"eligibility":{"description":"A display message outlining an eligibility criteria that may apply","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.incentives.items.[INDEX].eligibility","typeLabel":"string"}},"required":["category","description","displayName"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.incentives.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.incentives","typeLabel":"object[]"},"discounts":{"description":"Optional list of discounts available for the contract","items":{"properties":{"displayName":{"description":"The display name of the discount","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].displayName","typeLabel":"string"},"type":{"description":"The type of the discount","enum":["CONDITIONAL","GUARANTEED","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"methodUType":{"description":"The method of calculation of the discount","enum":["percentOfBill","percentOfUse","fixedAmount","percentOverThreshold"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].methodUType","typeLabel":"enum\u003cstring>"},"description":{"description":"The description of the discount","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].description","typeLabel":"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"endDate":{"description":"Optional end date for the discount after which the discount is no longer available","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].endDate","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOfBill.rate","typeLabel":"string"}},"required":["rate"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOfBill","typeLabel":"object"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOfUse.rate","typeLabel":"string"}},"required":["rate"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOfUse","typeLabel":"object"},"fixedAmount":{"description":"Required if methodUType is fixedAmount","properties":{"amount":{"description":"The amount of the discount","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].fixedAmount.amount","typeLabel":"string"}},"required":["amount"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].fixedAmount","typeLabel":"object"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOverThreshold.rate","typeLabel":"string"},"usageAmount":{"description":"The usage amount threshold above which the discount applies","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOverThreshold.usageAmount","typeLabel":"string"}},"required":["rate","usageAmount"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX].percentOverThreshold","typeLabel":"object"}},"required":["displayName","methodUType","type"],"type":"object","x-conditional":["percentOfBill","percentOfUse","fixedAmount","percentOverThreshold"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.discounts","typeLabel":"object[]"},"greenPowerCharges":{"description":"Optional list of charges applicable to green power","items":{"properties":{"displayName":{"description":"The display name of the charge","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].displayName","typeLabel":"string"},"scheme":{"description":"The applicable green power scheme","enum":["GREENPOWER","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].scheme","typeLabel":"enum\u003cstring>"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"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":{"properties":{"percentGreen":{"description":"The upper percentage of green power used applicable for this tier","type":"string","x-cds-type":"RateString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX].percentGreen","typeLabel":"string"},"rate":{"description":"The rate of the charge if the type implies the application of a rate","type":"string","x-cds-type":"RateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX].rate","typeLabel":"string"},"amount":{"description":"The amount of the charge if the type implies the application of a fixed amount","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX].amount","typeLabel":"string"}},"required":["percentGreen"],"type":"object","x-conditional":["rate","amount"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].tiers","typeLabel":"object[]"},"description":{"description":"The description of the charge","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX].description","typeLabel":"string"}},"required":["displayName","scheme","tiers","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.greenPowerCharges","typeLabel":"object[]"},"eligibility":{"description":"Eligibility restrictions or requirements","items":{"properties":{"type":{"description":"The type of the eligibility restriction.\nThe 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)\n","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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.eligibility.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"information":{"description":"Information of the eligibility restriction specific to the type of the restriction","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.eligibility.items.[INDEX].information","typeLabel":"string"},"description":{"description":"A description of the eligibility restriction","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.eligibility.items.[INDEX].description","typeLabel":"string"}},"required":["information","type"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.eligibility.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.eligibility","typeLabel":"object[]"},"fees":{"description":"An array of fees applicable to the plan","items":{"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"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","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees.items.[INDEX].term","typeLabel":"enum\u003cstring>"},"amount":{"description":"The fee amount. Required if term is not PERCENT_OF_BILL","type":"string","x-cds-type":"AmountString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees.items.[INDEX].amount","typeLabel":"string"},"rate":{"description":"The fee rate. Required if term is PERCENT_OF_BILL","type":"string","x-cds-type":"RateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees.items.[INDEX].rate","typeLabel":"string"},"description":{"description":"A description of the fee","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees.items.[INDEX].description","typeLabel":"string"}},"required":["term","type"],"type":"object","x-conditional":["amount","rate"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.fees","typeLabel":"object[]"},"solarFeedInTariff":{"description":"Array of feed in tariffs for solar power","items":{"properties":{"displayName":{"description":"The name of the tariff","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].displayName","typeLabel":"string"},"scheme":{"description":"The applicable scheme","enum":["PREMIUM","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].scheme","typeLabel":"enum\u003cstring>"},"payerType":{"description":"The type of the payer","enum":["GOVERNMENT","RETAILER"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].payerType","typeLabel":"enum\u003cstring>"},"tariffUType":{"description":"The type of the payer","enum":["singleTariff","timeVaryingTariffs"],"type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].tariffUType","typeLabel":"enum\u003cstring>"},"description":{"description":"A description of the tariff","type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].description","typeLabel":"string"},"startDate":{"description":"The start date of the application of the feed in tariff","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].startDate","typeLabel":"string"},"endDate":{"description":"The end date of the application of the feed in tariff","type":"string","x-cds-type":"DateString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].endDate","typeLabel":"string"},"singleTariff":{"description":"Represents a constant tariff. Mandatory if tariffUType is set to singleTariff","properties":{"rates":{"description":"Array of feed in rates","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].singleTariff.rates.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].singleTariff.rates","typeLabel":"object[]"}},"required":["rates"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].singleTariff","typeLabel":"object"},"timeVaryingTariffs":{"description":"Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs","properties":{"timeVariations":{"description":"Array of time periods for which this tariff is applicable","items":{"properties":{"days":{"description":"The days that the tariff applies to. At least one entry required","items":{"enum":["SUN","MON","TUE","WED","THU","FRI","SAT","PUBLIC_HOLIDAYS"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].days.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].days","typeLabel":"enum\u003cstring>[]"},"startTime":{"description":"The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight)","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"description":"The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight)","type":"string","x-cds-type":"TimeString","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX].endTime","typeLabel":"string"}},"required":["days"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.timeVariations","typeLabel":"object[]"},"type":{"description":"The type of the charging time period. If absent applies to all periods","enum":["PEAK","OFF_PEAK","SHOULDER"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.type","typeLabel":"enum\u003cstring>"},"rates":{"description":"Array of feed in rates","items":{"properties":{"unitPrice":{"description":"Unit price of usage per measure unit (exclusive of GST)","type":"string","x-cds-type":"AmountString","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX].unitPrice","typeLabel":"string"},"measureUnit":{"description":"The measurement unit of rate. Assumed to be KWH if absent","enum":["KWH","KVA","KVAR","KVARH","KW","DAYS","METER","MONTH"],"type":"string","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX].measureUnit","typeLabel":"enum\u003cstring>"},"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","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX].volume","typeLabel":"number"}},"required":["unitPrice"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs.rates","typeLabel":"object[]"}},"required":["timeVariations"],"type":"object","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX].timeVaryingTariffs","typeLabel":"object"}},"required":["displayName","payerType","scheme","tariffUType"],"type":"object","x-conditional":["singleTariff","timeVaryingTariffs"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract.solarFeedInTariff","typeLabel":"object[]"}},"required":["isFixed","paymentOption","pricingModel","tariffPeriod"],"type":"object","x-conditional":["timeZone","variation","controlledLoad"],"uniqueKey":"data.plans.items.[INDEX].planDetail.electricityContract","typeLabel":"object"}},"required":["fuelType"],"type":"object","x-conditional":["gasContract","electricityContract"],"uniqueKey":"data.plans.items.[INDEX].planDetail","typeLabel":"object"},"authorisedContacts":{"description":"An array of additional contacts that are authorised to act on this account","items":{"properties":{"lastName":{"description":"For people with single names the single name should be in this field","type":"string","isRequired":true,"uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX].lastName","typeLabel":"string"},"firstName":{"description":"For people with single names this field need not be present. The single name should be in the lastName field","type":"string","uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX].firstName","typeLabel":"string"},"middleNames":{"description":"Field is mandatory but array may be empty","items":{"type":"string","uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX].middleNames.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX].middleNames","typeLabel":"string[]"},"prefix":{"description":"Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc)","type":"string","uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX].prefix","typeLabel":"string"},"suffix":{"description":"Used for a trailing suffix to the name (e.g. Jr)","type":"string","uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX].suffix","typeLabel":"string"}},"required":["lastName"],"type":"object","uniqueKey":"data.plans.items.[INDEX].authorisedContacts.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.plans.items.[INDEX].authorisedContacts","typeLabel":"object[]"}},"required":["servicePointIds"],"type":"object","x-conditional":["planOverview","planDetail"],"uniqueKey":"data.plans.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.plans","typeLabel":"object[]"},"accountNumber":{"description":"Optional identifier of the account as defined by the data holder. This must be the value presented on physical statements (if it exists) and must not be used for the value of accountId","type":"string","uniqueKey":"data.accountNumber","typeLabel":"string"},"displayName":{"description":"An optional display name for the account if one exists or can be derived. The content of this field is at the discretion of the data holder","type":"string","uniqueKey":"data.displayName","typeLabel":"string"},"openStatus":{"default":"OPEN","description":"Open or closed status for the account. If not present then OPEN is assumed","enum":["CLOSED","OPEN"],"type":"string","uniqueKey":"data.openStatus","typeLabel":"enum\u003cstring>"},"creationDate":{"description":"The date that the account was created or opened. Mandatory if openStatus is OPEN","type":"string","x-cds-type":"DateString","uniqueKey":"data.creationDate","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"accountId":"019a08ff-90b2-71b3-9704-2f5dc6647e49","accountNumber":"0123456789","displayName":"Resi Single Rate","openStatus":"OPEN","creationDate":"2025-01-01T00:00:00.000Z","plans":[{"nickname":"Resi Single Rate","servicePointIds":["4123456789"],"planOverview":{"displayName":"Resi Single Rate","startDate":"2025-01-01T00:00:00.000Z"},"planDetail":{"fuelType":"ELECTRICITY","isContingentPlan":false,"meteringCharges":[{"displayName":"standard metering charge","description":"Basic fee for metering","minimumValue":"0.20","period":"P3M"}],"electricityContract":{"additionalFeeInformation":"A fee applies for missed payments","pricingModel":"SINGLE_RATE","timeZone":"LOCAL","isFixed":true,"variation":"We may vary the rates for your electricity consumption with 30 days notice","paymentOption":["PAPER_BILL","CREDIT_CARD","DIRECT_DEBIT","BPAY"],"intrinsicGreenPower":{"greenPercentage":"0.7"},"controlledLoad":[{"displayName":"Basic Controlled Load Appliance","rateBlockUType":"singleRate","startDate":"2025-01-01T00:00:00.000Z","singleRate":{"displayName":"Single Appliance","description":"Controlled load rate for a single appliance","dailySupplyCharge":"0.75","rates":[{"unitPrice":"0.332","measureUnit":"KWH"}]}}],"incentives":[{"displayName":"Cashbacks","description":"Sign up bonus","category":"ACCOUNT_CREDIT","eligibility":"If you sign up before 2025-02-01 you will get $100 cash back as credit on your bill"}],"discounts":[{"displayName":"Pay on time","description":"Pay on time to get 1% off your bill","type":"CONDITIONAL","category":"PAY_ON_TIME","endDate":"string","methodUType":"percentOfBill","percentOfBill":{"rate":"0.1"}}],"eligibility":[{"type":"NEW_CUSTOMER","information":"You must not have been a customer within the last 24 monthsr","description":"Only new customers are eligible for cashback incentives"}],"fees":[{"type":"LATE_PAYMENT","term":"PERCENT_OF_BILL","rate":"0.05","description":"A 0.05% fee applies if your bill is not paid on time."}],"solarFeedInTariff":[{"displayName":"Single rate Solar FiT","description":"Single Rate Solar feed-in tariff","startDate":"2025-01-01T00:00:00.000Z","scheme":"PREMIUM","payerType":"RETAILERT","tariffUType":"singleTariff","singleTariff":{"rates":[{"unitPrice":"0.054","measureUnit":"KWH"}]}}],"tariffPeriod":[{"type":"RETAIL_SERVICE","displayName":"Single Rate","startDate":"2025-01-01T00:00:00.000Z","dailySupplyCharges":"0.64","timeZone":"LOCAL","rateBlockUType":"singleRate","singleRate":{"displayName":"string","description":"string","generalUnitPrice":"string","rates":[{"unitPrice":"0.342","measureUnit":"KWH"}]}}]}},"authorisedContacts":[{"firstName":"Peter","lastName":"Sherman","prefix":"Dr"}]}]}}}},"exampleType":"generated"}},"description":"Details for the requested account","exampleType":"generated"},"e2a34135-ae35-4a39-bafb-c2a106a1f234":{"description":"The customer ID in the URL path is invalid or not found","content":{"application/json":{"schema":{"example":{"error":"Customer not found"},"type":"object","properties":{"error":{"type":"string","description":"A message describing what caused the error","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Customer not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5609e27a-91a0-4697-9efe-47e4706ce093":{"bearerAuth":{"description":"The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the `Authorization` header.\nYou should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you **must**:\n * Verify the signature\n * Ensure the token has not expired by checking the `exp` claim\n * The `sub` and `iss` claims are your data provider subdomain\n * The `aud` claim is the URI of the resource being requested (excluding any query parameters)\n * The `jti` value is unique\nFor further detail on security and authentication refer to our [Authentication](/docs/build/jwt-security) documentation\n","type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"8e56edbd-71c3-4c89-9d53-903044920b32":{"url":"https://api.provider.fiskil.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the `Authorization` header.\nYou should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you **must**:\n * Verify the signature\n * Ensure the token has not expired by checking the `exp` claim\n * The `sub` and `iss` claims are your data provider subdomain\n * The `aud` claim is the URI of the resource being requested (excluding any query parameters)\n * The `jti` value is unique\nFor further detail on security and authentication refer to our [Authentication](/docs/build/jwt-security) documentation\n","type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the `Authorization` header.\nYou should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you **must**:\n * Verify the signature\n * Ensure the token has not expired by checking the `exp` claim\n * The `sub` and `iss` claims are your data provider subdomain\n * The `aud` claim is the URI of the resource being requested (excluding any query parameters)\n * The `jti` value is unique\nFor further detail on security and authentication refer to our [Authentication](/docs/build/jwt-security) documentation\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/cdr.yaml"},"subdomain":"fiskil","siteName":"Fiskil","title":"Get Energy Account Detail - Fiskil","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T03:44:54.160Z","originalFileLocation":"api-reference/energy/get-energy-account-detail.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Obtain detailed information for a specific energy account\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fiskil\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Energy Account Detail - Fiskil\">\u003cmeta data-mint-head property=\"og:description\" content=\"Obtain detailed information for a specific energy account\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fiskil\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fiskil.mintlify.site/_mintlify/api/og/v2?division=Energy\u0026amp;title=Get+Energy+Account+Detail\u0026amp;description=Obtain+detailed+information+for+a+specific+energy+account\u0026amp;theme=fc6062bcca7fed429a4b2900\u0026amp;signature=d137f3dead94bd1f1d7c811e0499295eed478bcdceafaeac74054bfaad7c2d7b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Energy Account Detail - Fiskil\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Obtain detailed information for a specific energy account\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fiskil.mintlify.site/_mintlify/api/og/v2?division=Energy\u0026amp;title=Get+Energy+Account+Detail\u0026amp;description=Obtain+detailed+information+for+a+specific+energy+account\u0026amp;theme=fc6062bcca7fed429a4b2900\u0026amp;signature=d137f3dead94bd1f1d7c811e0499295eed478bcdceafaeac74054bfaad7c2d7b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fiskil\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#191b15\">\u003clink data-mint-head rel=\"canonical\" href=\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/energy/get-energy-account-detail.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://holder.docs.fiskil.dev/#organization\",\"name\":\"Fiskil\",\"url\":\"https://holder.docs.fiskil.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fiskil/3jtGQNqcSr5N4TNw/logo/light.svg?fit=max\u0026auto=format\u0026n=3jtGQNqcSr5N4TNw\u0026q=85\u0026s=acb4183b4445e3ca4d0a4637752c3943\"}},{\"@type\":\"WebSite\",\"@id\":\"https://holder.docs.fiskil.dev#website\",\"name\":\"Fiskil\",\"url\":\"https://holder.docs.fiskil.dev\",\"publisher\":{\"@id\":\"https://holder.docs.fiskil.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail#webpage\",\"url\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail\",\"name\":\"Get Energy Account Detail\",\"description\":\"Obtain detailed information for a specific energy account\",\"dateModified\":\"2026-10-26T03:44:54.160Z\",\"isPartOf\":{\"@id\":\"https://holder.docs.fiskil.dev#website\"},\"breadcrumb\":{\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data Sharing\",\"item\":\"https://holder.docs.fiskil.dev/api-reference/banking/get-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Energy\",\"item\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-accounts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Energy Account Detail\",\"item\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail#apireference\",\"headline\":\"Get Energy Account Detail\",\"name\":\"Get Energy Account Detail\",\"description\":\"Obtain detailed information for a specific energy account\",\"url\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail\",\"mainEntityOfPage\":{\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-account-detail#webpage\"},\"dateModified\":\"2026-10-26T03:44:54.160Z\",\"publisher\":{\"@id\":\"https://holder.docs.fiskil.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://holder.docs.fiskil.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fiskil\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Fiskil","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://www.fiskil.com"},{"anchor":"Support","icon":"headset","href":"https://www.fiskil.com/contact"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/docs/introduction"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"Custom Schema","icon":"book-open","groups":[{"group":"Define your API","pages":[{"title":"Bring Your Own Data","href":"/api-reference/bring-your-own-data"},{"title":"Custom Schema","href":"/api-reference/open-api-definition"}]},{"group":"Consent Flow","pages":[{"title":"Search Customers by email address","openapi":"openapi/auth.yml POST /auth/v1/customer/search","href":"/api-reference/byo/auth-customer-search"},{"title":"List accounts available for sharing","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}/accounts","href":"/api-reference/byo/auth-customer-accounts"},{"title":"Fetch a Customer's identity details","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}","href":"/api-reference/byo/auth-customer-details"}]}]},{"dropdown":"CDR","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fiskil/icons/cdr.svg","groups":[{"group":"Intro","pages":[{"title":"Integration Requirements","href":"/api-reference/cdr/integration-requirements"},{"title":"Frequently Asked Questions","href":"/api-reference/cdr/cdr-faqs"},{"title":"Errors","href":"/api-reference/cdr/errors"},{"title":"Non-Functional Requirements","href":"/api-reference/cdr/cdr-nfrs"}]},{"group":"Consent Flow","pages":[{"title":"Search Customers by email address","openapi":"openapi/auth.yml POST /auth/v1/customer/search","href":"/api-reference/cdr/auth-customer-search"},{"title":"List accounts available for sharing","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}/accounts","href":"/api-reference/cdr/auth-customer-accounts"},{"title":"Fetch a Customer's identity details","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}","href":"/api-reference/cdr/auth-customer-details"},{"title":"Legacy CDR Consent Flow APIs","tag":"deprecated","href":"/api-reference/cdr/legacy-auth"}]},{"group":"Data Sharing","pages":[{"group":"Banking","pages":[{"title":"Get Accounts","deprecated":true,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts","href":"/api-reference/banking/get-accounts"},{"title":"Fetch specific accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts","href":"/api-reference/banking/fetch-specific-accounts"},{"title":"Get Account Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}","href":"/api-reference/banking/get-account-detail"},{"title":"Get Balances For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts/balances","href":"/api-reference/banking/get-balances-for-specific-accounts"},{"title":"Get Account Balance","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/balance","href":"/api-reference/banking/get-account-balance"},{"title":"Get Transactions For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/transactions","href":"/api-reference/banking/get-transactions-for-account"},{"title":"Get Transaction Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/transactions/{transactionId}","href":"/api-reference/banking/get-transaction-detail"},{"title":"Get Direct Debits For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/direct-debits","href":"/api-reference/banking/get-direct-debits-for-account"},{"title":"Get Direct Debits For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts/direct-debits","href":"/api-reference/banking/get-direct-debits-for-specific-accounts"},{"title":"Get Scheduled Payments for Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/payments/scheduled","href":"/api-reference/banking/get-scheduled-payments-for-account"},{"title":"Get Scheduled Payments For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/payments/scheduled","href":"/api-reference/banking/get-scheduled-payments-for-specific-accounts"},{"title":"Get Instalment Plans for Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/payments/plans","href":"/api-reference/banking/get-instalment-plans-for-account"},{"title":"Get Instalment Plans For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts/payments/plans","href":"/api-reference/banking/get-instalment-plans-for-specific-accounts"},{"title":"Get Payees","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/payees","href":"/api-reference/banking/get-payees"},{"title":"Get Payee Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/payees/{payeeId}","href":"/api-reference/banking/get-payee-detail"}]},{"group":"Energy","pages":[{"title":"Get Energy Accounts","deprecated":true,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts","href":"/api-reference/energy/get-energy-accounts"},{"title":"Fetch specific Energy Accounts","description":"Fetch the details of specific energy accounts that have been authorised by the user","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts","href":"/api-reference/energy/fetch-specific-energy-accounts"},{"title":"Get Energy Account Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}","href":"/api-reference/energy/get-energy-account-detail"},{"title":"Get Agreed Payment Schedule","description":"Obtain the agreed payment schedule and details, if any, for a specific energy account.\nSome general notes about this end point:\n * This API describes how the consumer has elected to pay for their account\n * Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments\n * Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields\n * Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\n","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/payment-schedule","href":"/api-reference/energy/get-agreed-payment-schedule"},{"title":"Get Concessions","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/concessions","href":"/api-reference/energy/get-concessions"},{"title":"Get Balance For Energy Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/balance","href":"/api-reference/energy/get-balance-for-energy-account"},{"title":"Get Balances For Specific Energy Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts/balances","href":"/api-reference/energy/get-balances-for-specific-energy-accounts"},{"title":"Get Invoices For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/invoices","href":"/api-reference/energy/get-invoices-for-account"},{"title":"Get Invoices For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts/invoices","href":"/api-reference/energy/get-invoices-for-specific-accounts"},{"title":"Get Billing For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/billing","href":"/api-reference/energy/get-billing-for-account"},{"title":"Get Billing For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts/billing","href":"/api-reference/energy/get-billing-for-specific-accounts"}]},{"group":"Common","pages":[{"title":"Get Customer Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/common/customer/{customerId}/detail","href":"/api-reference/common/get-customer-detail"},{"title":"Servicepoint Search (AEMO)","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/common/customer/{customerId}/servicepoints/search","href":"/api-reference/common/servicepoint-search-aemo"}]}]},{"group":"Testing CDR","pages":[{"title":"Testing CDR","sidebarTitle":"Overview","href":"/api-reference/cdr/testing/overview"},{"title":"Set up the UAT environment","href":"/api-reference/cdr/testing/uat-environment"},{"title":"Test personas","href":"/api-reference/cdr/testing/test-personas"},{"group":"Test scenarios","pages":[{"title":"Phase 1: Consent authorisation","href":"/api-reference/cdr/testing/consent-authorisation"},{"title":"Phase 2: Data validation","href":"/api-reference/cdr/testing/data-validation"},{"title":"Phase 3: Error validation","href":"/api-reference/cdr/testing/error-validation"},{"title":"Phase 4: Consent dashboard and revocation","href":"/api-reference/cdr/testing/consent-dashboard"}]},{"title":"Report defects and get support","href":"/api-reference/cdr/testing/reporting-defects"}]}]},{"dropdown":"FDX","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fiskil/icons/fdx.svg","pages":[{"title":"Fiskil FDX API","tag":"v1.0.0","href":"/introduction-fdx"},{"group":"Consent Flow","pages":[{"title":"Search Customers by email address","openapi":"openapi/auth.yml POST /auth/v1/customer/search","href":"/api-reference/fdx/auth-customer-search"},{"title":"List accounts available for sharing","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}/accounts","href":"/api-reference/fdx/auth-customer-accounts"},{"title":"Fetch a Customer's identity details","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}","href":"/api-reference/fdx/auth-customer-details"}]},{"group":"Data Sharing","pages":[{"group":"Account Information","pages":[{"title":"Fetch specific accounts","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml post /fdx/v6/customer/{customerId}/accounts","href":"/api-reference/account-information/fetch-specific-accounts"},{"title":"Get detailed information for a specific account","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}","href":"/api-reference/account-information/get-detailed-information-for-a-specific-account"}]},{"group":"Personal Information","pages":[{"title":"Get an account's contact information","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/contact","href":"/api-reference/personal-information/get-an-accounts-contact-information"}]},{"group":"Payment Networks Information","pages":[{"title":"Get payment networks supported by the account","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/payment-networks","href":"/api-reference/payment-networks-information/get-payment-networks-supported-by-the-account"}]},{"group":"Account Transactions","pages":[{"title":"Search for account transactions","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/transactions","href":"/api-reference/account-transactions/search-for-account-transactions"}]},{"group":"Account Statements","pages":[{"title":"Search for statements","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/statements","href":"/api-reference/account-statements/search-for-statements"},{"title":"Get account statement","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/statements/{statementId}","href":"/api-reference/account-statements/get-account-statement"}]},{"group":"Asset Transfer Networks Information","pages":[{"title":"Get asset transfer details for this account","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/asset-transfer-networks","href":"/api-reference/asset-transfer-networks-information/get-asset-transfer-details-for-this-account"}]}]}]}]},{"tab":"Platform API","pages":[{"title":"Platform API","href":"/platform-api/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get Energy Account Detail - Fiskil","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}