Get Generic Plan Detail V2

This page documents version 2 of the Get Generic Plan Detail end point.

• Data Holders MUST implement Get Generic Plan Detail v3 by November 11th 2024.
• This version is to be ceased to be called by data recipients by March 3rd 2025 and can be retired by data holders as of that date.

Get Generic Plan Detail

Code samples

GET /energy/plans/{planId} HTTP/1.1

Accept: application/json
x-v: string
x-min-v: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string'

};

fetch('/energy/plans/{planId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /energy/plans/{planId}

Obtain detailed information on a single energy plan offered openly to the market.

Other Versions: v1

Endpoint Version

Version	2

Parameters

Name	In	Type	Required	Description
planId	path	string	mandatory	ID of the specific plan requested
x-v	header	string	mandatory	Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers
x-min-v	header	string	optional	Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Example responses

200 Response

{
  "data": {
    "planId": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "lastUpdated": "string",
    "displayName": "string",
    "description": "string",
    "type": "STANDING",
    "fuelType": "ELECTRICITY",
    "brand": "string",
    "brandName": "string",
    "applicationUri": "string",
    "additionalInformation": {
      "overviewUri": "string",
      "termsUri": "string",
      "eligibilityUri": "string",
      "pricingUri": "string",
      "bundleUri": "string"
    },
    "customerType": "RESIDENTIAL",
    "geography": {
      "excludedPostcodes": [
        "string"
      ],
      "includedPostcodes": [
        "string"
      ],
      "distributors": [
        "string"
      ]
    },
    "meteringCharges": [
      {
        "displayName": "string",
        "description": "string",
        "minimumValue": "string",
        "maximumValue": "string",
        "period": "string"
      }
    ],
    "gasContract": {
      "additionalFeeInformation": "string",
      "pricingModel": "SINGLE_RATE",
      "timeZone": "LOCAL",
      "isFixed": true,
      "variation": "string",
      "onExpiryDescription": "string",
      "paymentOption": [
        "PAPER_BILL"
      ],
      "intrinsicGreenPower": {
        "greenPercentage": "string"
      },
      "controlledLoad": [
        {
          "displayName": "string",
          "rateBlockUType": "singleRate",
          "startDate": "string",
          "endDate": "string",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "dailySupplyCharge": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "dailySupplyCharge": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string",
                  "additionalInfo": "string",
                  "additionalInfoUri": "string"
                }
              ],
              "type": "PEAK"
            }
          ]
        }
      ],
      "incentives": [
        {
          "displayName": "string",
          "description": "string",
          "category": "GIFT",
          "eligibility": "string"
        }
      ],
      "discounts": [
        {
          "displayName": "string",
          "description": "string",
          "type": "CONDITIONAL",
          "category": "PAY_ON_TIME",
          "endDate": "string",
          "methodUType": "percentOfBill",
          "percentOfBill": {
            "rate": "string"
          },
          "percentOfUse": {
            "rate": "string"
          },
          "fixedAmount": {
            "amount": "string"
          },
          "percentOverThreshold": {
            "rate": "string",
            "usageAmount": "string"
          }
        }
      ],
      "greenPowerCharges": [
        {
          "displayName": "string",
          "description": "string",
          "scheme": "GREENPOWER",
          "type": "FIXED_PER_DAY",
          "tiers": [
            {
              "percentGreen": "string",
              "rate": "string",
              "amount": "string"
            }
          ]
        }
      ],
      "eligibility": [
        {
          "type": "EXISTING_CUST",
          "information": "string",
          "description": "string"
        }
      ],
      "fees": [
        {
          "type": "EXIT",
          "term": "FIXED",
          "amount": "string",
          "rate": "string",
          "description": "string"
        }
      ],
      "solarFeedInTariff": [
        {
          "displayName": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "scheme": "PREMIUM",
          "payerType": "GOVERNMENT",
          "tariffUType": "singleTariff",
          "singleTariff": {
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeVaryingTariffs": {
            "type": "PEAK",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeVariations": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string"
              }
            ]
          }
        }
      ],
      "tariffPeriod": [
        {
          "type": "ENVIRONMENTAL",
          "displayName": "string",
          "startDate": "string",
          "endDate": "string",
          "dailySupplyCharges": "string",
          "timeZone": "LOCAL",
          "rateBlockUType": "singleRate",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "generalUnitPrice": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "period": "string"
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string"
                }
              ],
              "type": "PEAK"
            }
          ],
          "demandCharges": [
            {
              "displayName": "string",
              "description": "string",
              "amount": "string",
              "measureUnit": "KWH",
              "startTime": "string",
              "endTime": "string",
              "days": [
                "SUN"
              ],
              "minDemand": "string",
              "maxDemand": "string",
              "measurementPeriod": "DAY",
              "chargePeriod": "DAY"
            }
          ]
        }
      ],
      "termType": "1_YEAR",
      "benefitPeriod": "string",
      "terms": "string",
      "meterTypes": [
        "string"
      ],
      "coolingOffDays": 0,
      "billFrequency": [
        "string"
      ]
    },
    "electricityContract": {
      "additionalFeeInformation": "string",
      "pricingModel": "SINGLE_RATE",
      "timeZone": "LOCAL",
      "isFixed": true,
      "variation": "string",
      "onExpiryDescription": "string",
      "paymentOption": [
        "PAPER_BILL"
      ],
      "intrinsicGreenPower": {
        "greenPercentage": "string"
      },
      "controlledLoad": [
        {
          "displayName": "string",
          "rateBlockUType": "singleRate",
          "startDate": "string",
          "endDate": "string",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "dailySupplyCharge": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "dailySupplyCharge": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string",
                  "additionalInfo": "string",
                  "additionalInfoUri": "string"
                }
              ],
              "type": "PEAK"
            }
          ]
        }
      ],
      "incentives": [
        {
          "displayName": "string",
          "description": "string",
          "category": "GIFT",
          "eligibility": "string"
        }
      ],
      "discounts": [
        {
          "displayName": "string",
          "description": "string",
          "type": "CONDITIONAL",
          "category": "PAY_ON_TIME",
          "endDate": "string",
          "methodUType": "percentOfBill",
          "percentOfBill": {
            "rate": "string"
          },
          "percentOfUse": {
            "rate": "string"
          },
          "fixedAmount": {
            "amount": "string"
          },
          "percentOverThreshold": {
            "rate": "string",
            "usageAmount": "string"
          }
        }
      ],
      "greenPowerCharges": [
        {
          "displayName": "string",
          "description": "string",
          "scheme": "GREENPOWER",
          "type": "FIXED_PER_DAY",
          "tiers": [
            {
              "percentGreen": "string",
              "rate": "string",
              "amount": "string"
            }
          ]
        }
      ],
      "eligibility": [
        {
          "type": "EXISTING_CUST",
          "information": "string",
          "description": "string"
        }
      ],
      "fees": [
        {
          "type": "EXIT",
          "term": "FIXED",
          "amount": "string",
          "rate": "string",
          "description": "string"
        }
      ],
      "solarFeedInTariff": [
        {
          "displayName": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "scheme": "PREMIUM",
          "payerType": "GOVERNMENT",
          "tariffUType": "singleTariff",
          "singleTariff": {
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeVaryingTariffs": {
            "type": "PEAK",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeVariations": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string"
              }
            ]
          }
        }
      ],
      "tariffPeriod": [
        {
          "type": "ENVIRONMENTAL",
          "displayName": "string",
          "startDate": "string",
          "endDate": "string",
          "dailySupplyCharges": "string",
          "timeZone": "LOCAL",
          "rateBlockUType": "singleRate",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "generalUnitPrice": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "period": "string"
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string"
                }
              ],
              "type": "PEAK"
            }
          ],
          "demandCharges": [
            {
              "displayName": "string",
              "description": "string",
              "amount": "string",
              "measureUnit": "KWH",
              "startTime": "string",
              "endTime": "string",
              "days": [
                "SUN"
              ],
              "minDemand": "string",
              "maxDemand": "string",
              "measurementPeriod": "DAY",
              "chargePeriod": "DAY"
            }
          ]
        }
      ],
      "termType": "1_YEAR",
      "benefitPeriod": "string",
      "terms": "string",
      "meterTypes": [
        "string"
      ],
      "coolingOffDays": 0,
      "billFrequency": [
        "string"
      ]
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	EnergyPlanResponseV2
400	Bad Request	The following error codes MUST be supported: 400 - Invalid Field 400 - Missing Field 400 - Invalid Version	ResponseErrorListV2
404	Not Found	The following error codes MUST be supported: 404 - Invalid Resource	ResponseErrorListV2
406	Not Acceptable	The following error codes MUST be supported: 406 - Unsupported Version	ResponseErrorListV2

Response Headers

Status	Header	Type	Format	Description
200	x-v	string		The version of the API end point that the data holder has responded with.

Schemas

EnergyPlanResponseV2

{
  "data": {
    "planId": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "lastUpdated": "string",
    "displayName": "string",
    "description": "string",
    "type": "STANDING",
    "fuelType": "ELECTRICITY",
    "brand": "string",
    "brandName": "string",
    "applicationUri": "string",
    "additionalInformation": {
      "overviewUri": "string",
      "termsUri": "string",
      "eligibilityUri": "string",
      "pricingUri": "string",
      "bundleUri": "string"
    },
    "customerType": "RESIDENTIAL",
    "geography": {
      "excludedPostcodes": [
        "string"
      ],
      "includedPostcodes": [
        "string"
      ],
      "distributors": [
        "string"
      ]
    },
    "meteringCharges": [
      {
        "displayName": "string",
        "description": "string",
        "minimumValue": "string",
        "maximumValue": "string",
        "period": "string"
      }
    ],
    "gasContract": {
      "additionalFeeInformation": "string",
      "pricingModel": "SINGLE_RATE",
      "timeZone": "LOCAL",
      "isFixed": true,
      "variation": "string",
      "onExpiryDescription": "string",
      "paymentOption": [
        "PAPER_BILL"
      ],
      "intrinsicGreenPower": {
        "greenPercentage": "string"
      },
      "controlledLoad": [
        {
          "displayName": "string",
          "rateBlockUType": "singleRate",
          "startDate": "string",
          "endDate": "string",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "dailySupplyCharge": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "dailySupplyCharge": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string",
                  "additionalInfo": "string",
                  "additionalInfoUri": "string"
                }
              ],
              "type": "PEAK"
            }
          ]
        }
      ],
      "incentives": [
        {
          "displayName": "string",
          "description": "string",
          "category": "GIFT",
          "eligibility": "string"
        }
      ],
      "discounts": [
        {
          "displayName": "string",
          "description": "string",
          "type": "CONDITIONAL",
          "category": "PAY_ON_TIME",
          "endDate": "string",
          "methodUType": "percentOfBill",
          "percentOfBill": {
            "rate": "string"
          },
          "percentOfUse": {
            "rate": "string"
          },
          "fixedAmount": {
            "amount": "string"
          },
          "percentOverThreshold": {
            "rate": "string",
            "usageAmount": "string"
          }
        }
      ],
      "greenPowerCharges": [
        {
          "displayName": "string",
          "description": "string",
          "scheme": "GREENPOWER",
          "type": "FIXED_PER_DAY",
          "tiers": [
            {
              "percentGreen": "string",
              "rate": "string",
              "amount": "string"
            }
          ]
        }
      ],
      "eligibility": [
        {
          "type": "EXISTING_CUST",
          "information": "string",
          "description": "string"
        }
      ],
      "fees": [
        {
          "type": "EXIT",
          "term": "FIXED",
          "amount": "string",
          "rate": "string",
          "description": "string"
        }
      ],
      "solarFeedInTariff": [
        {
          "displayName": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "scheme": "PREMIUM",
          "payerType": "GOVERNMENT",
          "tariffUType": "singleTariff",
          "singleTariff": {
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeVaryingTariffs": {
            "type": "PEAK",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeVariations": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string"
              }
            ]
          }
        }
      ],
      "tariffPeriod": [
        {
          "type": "ENVIRONMENTAL",
          "displayName": "string",
          "startDate": "string",
          "endDate": "string",
          "dailySupplyCharges": "string",
          "timeZone": "LOCAL",
          "rateBlockUType": "singleRate",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "generalUnitPrice": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "period": "string"
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string"
                }
              ],
              "type": "PEAK"
            }
          ],
          "demandCharges": [
            {
              "displayName": "string",
              "description": "string",
              "amount": "string",
              "measureUnit": "KWH",
              "startTime": "string",
              "endTime": "string",
              "days": [
                "SUN"
              ],
              "minDemand": "string",
              "maxDemand": "string",
              "measurementPeriod": "DAY",
              "chargePeriod": "DAY"
            }
          ]
        }
      ],
      "termType": "1_YEAR",
      "benefitPeriod": "string",
      "terms": "string",
      "meterTypes": [
        "string"
      ],
      "coolingOffDays": 0,
      "billFrequency": [
        "string"
      ]
    },
    "electricityContract": {
      "additionalFeeInformation": "string",
      "pricingModel": "SINGLE_RATE",
      "timeZone": "LOCAL",
      "isFixed": true,
      "variation": "string",
      "onExpiryDescription": "string",
      "paymentOption": [
        "PAPER_BILL"
      ],
      "intrinsicGreenPower": {
        "greenPercentage": "string"
      },
      "controlledLoad": [
        {
          "displayName": "string",
          "rateBlockUType": "singleRate",
          "startDate": "string",
          "endDate": "string",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "dailySupplyCharge": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "dailySupplyCharge": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string",
                  "additionalInfo": "string",
                  "additionalInfoUri": "string"
                }
              ],
              "type": "PEAK"
            }
          ]
        }
      ],
      "incentives": [
        {
          "displayName": "string",
          "description": "string",
          "category": "GIFT",
          "eligibility": "string"
        }
      ],
      "discounts": [
        {
          "displayName": "string",
          "description": "string",
          "type": "CONDITIONAL",
          "category": "PAY_ON_TIME",
          "endDate": "string",
          "methodUType": "percentOfBill",
          "percentOfBill": {
            "rate": "string"
          },
          "percentOfUse": {
            "rate": "string"
          },
          "fixedAmount": {
            "amount": "string"
          },
          "percentOverThreshold": {
            "rate": "string",
            "usageAmount": "string"
          }
        }
      ],
      "greenPowerCharges": [
        {
          "displayName": "string",
          "description": "string",
          "scheme": "GREENPOWER",
          "type": "FIXED_PER_DAY",
          "tiers": [
            {
              "percentGreen": "string",
              "rate": "string",
              "amount": "string"
            }
          ]
        }
      ],
      "eligibility": [
        {
          "type": "EXISTING_CUST",
          "information": "string",
          "description": "string"
        }
      ],
      "fees": [
        {
          "type": "EXIT",
          "term": "FIXED",
          "amount": "string",
          "rate": "string",
          "description": "string"
        }
      ],
      "solarFeedInTariff": [
        {
          "displayName": "string",
          "description": "string",
          "startDate": "string",
          "endDate": "string",
          "scheme": "PREMIUM",
          "payerType": "GOVERNMENT",
          "tariffUType": "singleTariff",
          "singleTariff": {
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ]
          },
          "timeVaryingTariffs": {
            "type": "PEAK",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeVariations": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string"
              }
            ]
          }
        }
      ],
      "tariffPeriod": [
        {
          "type": "ENVIRONMENTAL",
          "displayName": "string",
          "startDate": "string",
          "endDate": "string",
          "dailySupplyCharges": "string",
          "timeZone": "LOCAL",
          "rateBlockUType": "singleRate",
          "singleRate": {
            "displayName": "string",
            "description": "string",
            "generalUnitPrice": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "period": "string"
          },
          "timeOfUseRates": [
            {
              "displayName": "string",
              "description": "string",
              "rates": [
                {
                  "unitPrice": "string",
                  "measureUnit": "KWH",
                  "volume": 0
                }
              ],
              "timeOfUse": [
                {
                  "days": [
                    "SUN"
                  ],
                  "startTime": "string",
                  "endTime": "string"
                }
              ],
              "type": "PEAK"
            }
          ],
          "demandCharges": [
            {
              "displayName": "string",
              "description": "string",
              "amount": "string",
              "measureUnit": "KWH",
              "startTime": "string",
              "endTime": "string",
              "days": [
                "SUN"
              ],
              "minDemand": "string",
              "maxDemand": "string",
              "measurementPeriod": "DAY",
              "chargePeriod": "DAY"
            }
          ]
        }
      ],
      "termType": "1_YEAR",
      "benefitPeriod": "string",
      "terms": "string",
      "meterTypes": [
        "string"
      ],
      "coolingOffDays": 0,
      "billFrequency": [
        "string"
      ]
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Properties

Name	Type	Required	Description
data	EnergyPlanDetailV2	mandatory	none
links	Links	mandatory	none
meta	Meta	optional	none

ResponseErrorListV2

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Description
errors	[object]	mandatory	none
» code	string	mandatory	The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
» title	string	mandatory	A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
» detail	string	mandatory	A human-readable explanation specific to this occurrence of the problem.
» meta	object	optional	Additional data for customised error codes
»» urn	string	conditional	The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.

EnergyPlan

{
  "planId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "displayName": "string",
  "description": "string",
  "type": "STANDING",
  "fuelType": "ELECTRICITY",
  "brand": "string",
  "brandName": "string",
  "applicationUri": "string",
  "additionalInformation": {
    "overviewUri": "string",
    "termsUri": "string",
    "eligibilityUri": "string",
    "pricingUri": "string",
    "bundleUri": "string"
  },
  "customerType": "RESIDENTIAL",
  "geography": {
    "excludedPostcodes": [
      "string"
    ],
    "includedPostcodes": [
      "string"
    ],
    "distributors": [
      "string"
    ]
  }
}

Properties

Name	Type	Required	Description
planId	ASCIIString	mandatory	The ID of the specific plan
effectiveFrom	DateTimeString	optional	The date and time from which this plan is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate
effectiveTo	DateTimeString	optional	The date and time at which this plan will be retired and will no longer be offered. Used to enable the managed deprecation of plans
lastUpdated	DateTimeString	mandatory	The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)
displayName	string	optional	The display name of the plan
description	string	optional	A description of the plan
type	Enum	mandatory	The type of the plan
fuelType	Enum	mandatory	The fuel types covered by the plan
brand	ASCIIString	mandatory	The ID of the brand under which this plan is offered
brandName	string	mandatory	The display name of the brand under which this plan is offered
applicationUri	URIString	optional	A link to an application web page where this plan can be applied for
additionalInformation	object	optional	Object that contains links to additional information on specific topics
» overviewUri	URIString	optional	A link to a general overview of the plan
» termsUri	URIString	optional	A link to terms and conditions for the plan
» eligibilityUri	URIString	optional	A link to detail on eligibility criteria for the plan
» pricingUri	URIString	optional	A link to detail on pricing for the plan
» bundleUri	URIString	optional	A link to detail on bundles that this plan can be a part of
customerType	Enum	optional	The type of customer that the plan is offered to. If absent then the plan is available to all customers
geography	object	optional	Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited
» excludedPostcodes	[string]	optional	Array of valid Australian postcodes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
» includedPostcodes	[string]	optional	Array of valid Australian postcodes that are included from the plan. If absent defaults to all non-excluded postcodes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)
» distributors	[string]	mandatory	Array of distributors for the plan. Must have at least one entry

Enumerated Values

Property	Value
type	STANDING
type	MARKET
type	REGULATED
fuelType	ELECTRICITY
fuelType	GAS
fuelType	DUAL
customerType	RESIDENTIAL
customerType	BUSINESS

EnergyPlanDetailV2

{
  "planId": "string",
  "effectiveFrom": "string",
  "effectiveTo": "string",
  "lastUpdated": "string",
  "displayName": "string",
  "description": "string",
  "type": "STANDING",
  "fuelType": "ELECTRICITY",
  "brand": "string",
  "brandName": "string",
  "applicationUri": "string",
  "additionalInformation": {
    "overviewUri": "string",
    "termsUri": "string",
    "eligibilityUri": "string",
    "pricingUri": "string",
    "bundleUri": "string"
  },
  "customerType": "RESIDENTIAL",
  "geography": {
    "excludedPostcodes": [
      "string"
    ],
    "includedPostcodes": [
      "string"
    ],
    "distributors": [
      "string"
    ]
  },
  "meteringCharges": [
    {
      "displayName": "string",
      "description": "string",
      "minimumValue": "string",
      "maximumValue": "string",
      "period": "string"
    }
  ],
  "gasContract": {
    "additionalFeeInformation": "string",
    "pricingModel": "SINGLE_RATE",
    "timeZone": "LOCAL",
    "isFixed": true,
    "variation": "string",
    "onExpiryDescription": "string",
    "paymentOption": [
      "PAPER_BILL"
    ],
    "intrinsicGreenPower": {
      "greenPercentage": "string"
    },
    "controlledLoad": [
      {
        "displayName": "string",
        "rateBlockUType": "singleRate",
        "startDate": "string",
        "endDate": "string",
        "singleRate": {
          "displayName": "string",
          "description": "string",
          "dailySupplyCharge": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ]
        },
        "timeOfUseRates": [
          {
            "displayName": "string",
            "description": "string",
            "dailySupplyCharge": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeOfUse": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ],
            "type": "PEAK"
          }
        ]
      }
    ],
    "incentives": [
      {
        "displayName": "string",
        "description": "string",
        "category": "GIFT",
        "eligibility": "string"
      }
    ],
    "discounts": [
      {
        "displayName": "string",
        "description": "string",
        "type": "CONDITIONAL",
        "category": "PAY_ON_TIME",
        "endDate": "string",
        "methodUType": "percentOfBill",
        "percentOfBill": {
          "rate": "string"
        },
        "percentOfUse": {
          "rate": "string"
        },
        "fixedAmount": {
          "amount": "string"
        },
        "percentOverThreshold": {
          "rate": "string",
          "usageAmount": "string"
        }
      }
    ],
    "greenPowerCharges": [
      {
        "displayName": "string",
        "description": "string",
        "scheme": "GREENPOWER",
        "type": "FIXED_PER_DAY",
        "tiers": [
          {
            "percentGreen": "string",
            "rate": "string",
            "amount": "string"
          }
        ]
      }
    ],
    "eligibility": [
      {
        "type": "EXISTING_CUST",
        "information": "string",
        "description": "string"
      }
    ],
    "fees": [
      {
        "type": "EXIT",
        "term": "FIXED",
        "amount": "string",
        "rate": "string",
        "description": "string"
      }
    ],
    "solarFeedInTariff": [
      {
        "displayName": "string",
        "description": "string",
        "startDate": "string",
        "endDate": "string",
        "scheme": "PREMIUM",
        "payerType": "GOVERNMENT",
        "tariffUType": "singleTariff",
        "singleTariff": {
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ]
        },
        "timeVaryingTariffs": {
          "type": "PEAK",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "timeVariations": [
            {
              "days": [
                "SUN"
              ],
              "startTime": "string",
              "endTime": "string"
            }
          ]
        }
      }
    ],
    "tariffPeriod": [
      {
        "type": "ENVIRONMENTAL",
        "displayName": "string",
        "startDate": "string",
        "endDate": "string",
        "dailySupplyCharges": "string",
        "timeZone": "LOCAL",
        "rateBlockUType": "singleRate",
        "singleRate": {
          "displayName": "string",
          "description": "string",
          "generalUnitPrice": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "period": "string"
        },
        "timeOfUseRates": [
          {
            "displayName": "string",
            "description": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeOfUse": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string"
              }
            ],
            "type": "PEAK"
          }
        ],
        "demandCharges": [
          {
            "displayName": "string",
            "description": "string",
            "amount": "string",
            "measureUnit": "KWH",
            "startTime": "string",
            "endTime": "string",
            "days": [
              "SUN"
            ],
            "minDemand": "string",
            "maxDemand": "string",
            "measurementPeriod": "DAY",
            "chargePeriod": "DAY"
          }
        ]
      }
    ],
    "termType": "1_YEAR",
    "benefitPeriod": "string",
    "terms": "string",
    "meterTypes": [
      "string"
    ],
    "coolingOffDays": 0,
    "billFrequency": [
      "string"
    ]
  },
  "electricityContract": {
    "additionalFeeInformation": "string",
    "pricingModel": "SINGLE_RATE",
    "timeZone": "LOCAL",
    "isFixed": true,
    "variation": "string",
    "onExpiryDescription": "string",
    "paymentOption": [
      "PAPER_BILL"
    ],
    "intrinsicGreenPower": {
      "greenPercentage": "string"
    },
    "controlledLoad": [
      {
        "displayName": "string",
        "rateBlockUType": "singleRate",
        "startDate": "string",
        "endDate": "string",
        "singleRate": {
          "displayName": "string",
          "description": "string",
          "dailySupplyCharge": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ]
        },
        "timeOfUseRates": [
          {
            "displayName": "string",
            "description": "string",
            "dailySupplyCharge": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeOfUse": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string",
                "additionalInfo": "string",
                "additionalInfoUri": "string"
              }
            ],
            "type": "PEAK"
          }
        ]
      }
    ],
    "incentives": [
      {
        "displayName": "string",
        "description": "string",
        "category": "GIFT",
        "eligibility": "string"
      }
    ],
    "discounts": [
      {
        "displayName": "string",
        "description": "string",
        "type": "CONDITIONAL",
        "category": "PAY_ON_TIME",
        "endDate": "string",
        "methodUType": "percentOfBill",
        "percentOfBill": {
          "rate": "string"
        },
        "percentOfUse": {
          "rate": "string"
        },
        "fixedAmount": {
          "amount": "string"
        },
        "percentOverThreshold": {
          "rate": "string",
          "usageAmount": "string"
        }
      }
    ],
    "greenPowerCharges": [
      {
        "displayName": "string",
        "description": "string",
        "scheme": "GREENPOWER",
        "type": "FIXED_PER_DAY",
        "tiers": [
          {
            "percentGreen": "string",
            "rate": "string",
            "amount": "string"
          }
        ]
      }
    ],
    "eligibility": [
      {
        "type": "EXISTING_CUST",
        "information": "string",
        "description": "string"
      }
    ],
    "fees": [
      {
        "type": "EXIT",
        "term": "FIXED",
        "amount": "string",
        "rate": "string",
        "description": "string"
      }
    ],
    "solarFeedInTariff": [
      {
        "displayName": "string",
        "description": "string",
        "startDate": "string",
        "endDate": "string",
        "scheme": "PREMIUM",
        "payerType": "GOVERNMENT",
        "tariffUType": "singleTariff",
        "singleTariff": {
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ]
        },
        "timeVaryingTariffs": {
          "type": "PEAK",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "timeVariations": [
            {
              "days": [
                "SUN"
              ],
              "startTime": "string",
              "endTime": "string"
            }
          ]
        }
      }
    ],
    "tariffPeriod": [
      {
        "type": "ENVIRONMENTAL",
        "displayName": "string",
        "startDate": "string",
        "endDate": "string",
        "dailySupplyCharges": "string",
        "timeZone": "LOCAL",
        "rateBlockUType": "singleRate",
        "singleRate": {
          "displayName": "string",
          "description": "string",
          "generalUnitPrice": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "period": "string"
        },
        "timeOfUseRates": [
          {
            "displayName": "string",
            "description": "string",
            "rates": [
              {
                "unitPrice": "string",
                "measureUnit": "KWH",
                "volume": 0
              }
            ],
            "timeOfUse": [
              {
                "days": [
                  "SUN"
                ],
                "startTime": "string",
                "endTime": "string"
              }
            ],
            "type": "PEAK"
          }
        ],
        "demandCharges": [
          {
            "displayName": "string",
            "description": "string",
            "amount": "string",
            "measureUnit": "KWH",
            "startTime": "string",
            "endTime": "string",
            "days": [
              "SUN"
            ],
            "minDemand": "string",
            "maxDemand": "string",
            "measurementPeriod": "DAY",
            "chargePeriod": "DAY"
          }
        ]
      }
    ],
    "termType": "1_YEAR",
    "benefitPeriod": "string",
    "terms": "string",
    "meterTypes": [
      "string"
    ],
    "coolingOffDays": 0,
    "billFrequency": [
      "string"
    ]
  }
}

Properties

allOf

Name	Type	Required	Description
anonymous	EnergyPlan	mandatory	none

and

Name	Type	Required	Description
anonymous	object	mandatory	none
» meteringCharges	[object]	optional	Charges for metering included in the plan
»» displayName	string	mandatory	Display name of the charge
»» description	string	optional	Description of the charge
»» minimumValue	AmountString	mandatory	Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified
»» maximumValue	AmountString	optional	The upper limit of the charge if the charge could occur in a range
»» period	ExternalRef	optional	The charges that occur on a schedule indicates the frequency. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
» gasContract	EnergyPlanContractFullV2	conditional	The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL
» electricityContract	EnergyPlanContractFullV2	conditional	The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL

EnergyPlanContractV2

{
  "additionalFeeInformation": "string",
  "pricingModel": "SINGLE_RATE",
  "timeZone": "LOCAL",
  "isFixed": true,
  "variation": "string",
  "onExpiryDescription": "string",
  "paymentOption": [
    "PAPER_BILL"
  ],
  "intrinsicGreenPower": {
    "greenPercentage": "string"
  },
  "controlledLoad": [
    {
      "displayName": "string",
      "rateBlockUType": "singleRate",
      "startDate": "string",
      "endDate": "string",
      "singleRate": {
        "displayName": "string",
        "description": "string",
        "dailySupplyCharge": "string",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ]
      },
      "timeOfUseRates": [
        {
          "displayName": "string",
          "description": "string",
          "dailySupplyCharge": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "timeOfUse": [
            {
              "days": [
                "SUN"
              ],
              "startTime": "string",
              "endTime": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ],
          "type": "PEAK"
        }
      ]
    }
  ],
  "incentives": [
    {
      "displayName": "string",
      "description": "string",
      "category": "GIFT",
      "eligibility": "string"
    }
  ],
  "discounts": [
    {
      "displayName": "string",
      "description": "string",
      "type": "CONDITIONAL",
      "category": "PAY_ON_TIME",
      "endDate": "string",
      "methodUType": "percentOfBill",
      "percentOfBill": {
        "rate": "string"
      },
      "percentOfUse": {
        "rate": "string"
      },
      "fixedAmount": {
        "amount": "string"
      },
      "percentOverThreshold": {
        "rate": "string",
        "usageAmount": "string"
      }
    }
  ],
  "greenPowerCharges": [
    {
      "displayName": "string",
      "description": "string",
      "scheme": "GREENPOWER",
      "type": "FIXED_PER_DAY",
      "tiers": [
        {
          "percentGreen": "string",
          "rate": "string",
          "amount": "string"
        }
      ]
    }
  ],
  "eligibility": [
    {
      "type": "EXISTING_CUST",
      "information": "string",
      "description": "string"
    }
  ],
  "fees": [
    {
      "type": "EXIT",
      "term": "FIXED",
      "amount": "string",
      "rate": "string",
      "description": "string"
    }
  ],
  "solarFeedInTariff": [
    {
      "displayName": "string",
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "scheme": "PREMIUM",
      "payerType": "GOVERNMENT",
      "tariffUType": "singleTariff",
      "singleTariff": {
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ]
      },
      "timeVaryingTariffs": {
        "type": "PEAK",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ],
        "timeVariations": [
          {
            "days": [
              "SUN"
            ],
            "startTime": "string",
            "endTime": "string"
          }
        ]
      }
    }
  ],
  "tariffPeriod": [
    {
      "type": "ENVIRONMENTAL",
      "displayName": "string",
      "startDate": "string",
      "endDate": "string",
      "dailySupplyCharges": "string",
      "timeZone": "LOCAL",
      "rateBlockUType": "singleRate",
      "singleRate": {
        "displayName": "string",
        "description": "string",
        "generalUnitPrice": "string",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ],
        "period": "string"
      },
      "timeOfUseRates": [
        {
          "displayName": "string",
          "description": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "timeOfUse": [
            {
              "days": [
                "SUN"
              ],
              "startTime": "string",
              "endTime": "string"
            }
          ],
          "type": "PEAK"
        }
      ],
      "demandCharges": [
        {
          "displayName": "string",
          "description": "string",
          "amount": "string",
          "measureUnit": "KWH",
          "startTime": "string",
          "endTime": "string",
          "days": [
            "SUN"
          ],
          "minDemand": "string",
          "maxDemand": "string",
          "measurementPeriod": "DAY",
          "chargePeriod": "DAY"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Description
additionalFeeInformation	string	optional	Free text field containing additional information of the fees for this contract
pricingModel	Enum	mandatory	The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are: 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. 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. 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 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. FLEXIBLE - energy usage is charged at unit rates that vary based on external factors 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. 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
timeZone	Enum	conditional	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
isFixed	boolean	mandatory	Flag indicating whether prices are fixed or variable
variation	string	conditional	Free text description of price variation policy and conditions for the contract. Mandatory if isFixed is false
onExpiryDescription	string	optional	Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period
paymentOption	[Enum]	mandatory	Payment options for this contract
intrinsicGreenPower	object	optional	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
» greenPercentage	RateString	mandatory	Percentage of green power intrinsically included in the plan
controlledLoad	EnergyPlanControlledLoad	conditional	Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
incentives	EnergyPlanIncentives	optional	Optional list of incentives available for the contract
discounts	EnergyPlanDiscounts	optional	Optional list of discounts available for the contract
greenPowerCharges	EnergyPlanGreenPowerCharges	optional	Optional list of charges applicable to green power
eligibility	EnergyPlanEligibility	optional	Eligibility restrictions or requirements
fees	EnergyPlanFees	optional	An array of fees applicable to the plan
solarFeedInTariff	EnergyPlanSolarFeedInTariffV2	optional	Array of feed in tariffs for solar power
tariffPeriod	EnergyPlanTariffPeriod	mandatory	Array of tariff periods

Enumerated Values

Property	Value
pricingModel	SINGLE_RATE
pricingModel	SINGLE_RATE_CONT_LOAD
pricingModel	TIME_OF_USE
pricingModel	TIME_OF_USE_CONT_LOAD
pricingModel	FLEXIBLE
pricingModel	FLEXIBLE_CONT_LOAD
pricingModel	QUOTA
timeZone	LOCAL
timeZone	AEST
paymentOption	PAPER_BILL
paymentOption	CREDIT_CARD
paymentOption	DIRECT_DEBIT
paymentOption	BPAY
paymentOption	OTHER

EnergyPlanContractFullV2

{
  "additionalFeeInformation": "string",
  "pricingModel": "SINGLE_RATE",
  "timeZone": "LOCAL",
  "isFixed": true,
  "variation": "string",
  "onExpiryDescription": "string",
  "paymentOption": [
    "PAPER_BILL"
  ],
  "intrinsicGreenPower": {
    "greenPercentage": "string"
  },
  "controlledLoad": [
    {
      "displayName": "string",
      "rateBlockUType": "singleRate",
      "startDate": "string",
      "endDate": "string",
      "singleRate": {
        "displayName": "string",
        "description": "string",
        "dailySupplyCharge": "string",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ]
      },
      "timeOfUseRates": [
        {
          "displayName": "string",
          "description": "string",
          "dailySupplyCharge": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "timeOfUse": [
            {
              "days": [
                "SUN"
              ],
              "startTime": "string",
              "endTime": "string",
              "additionalInfo": "string",
              "additionalInfoUri": "string"
            }
          ],
          "type": "PEAK"
        }
      ]
    }
  ],
  "incentives": [
    {
      "displayName": "string",
      "description": "string",
      "category": "GIFT",
      "eligibility": "string"
    }
  ],
  "discounts": [
    {
      "displayName": "string",
      "description": "string",
      "type": "CONDITIONAL",
      "category": "PAY_ON_TIME",
      "endDate": "string",
      "methodUType": "percentOfBill",
      "percentOfBill": {
        "rate": "string"
      },
      "percentOfUse": {
        "rate": "string"
      },
      "fixedAmount": {
        "amount": "string"
      },
      "percentOverThreshold": {
        "rate": "string",
        "usageAmount": "string"
      }
    }
  ],
  "greenPowerCharges": [
    {
      "displayName": "string",
      "description": "string",
      "scheme": "GREENPOWER",
      "type": "FIXED_PER_DAY",
      "tiers": [
        {
          "percentGreen": "string",
          "rate": "string",
          "amount": "string"
        }
      ]
    }
  ],
  "eligibility": [
    {
      "type": "EXISTING_CUST",
      "information": "string",
      "description": "string"
    }
  ],
  "fees": [
    {
      "type": "EXIT",
      "term": "FIXED",
      "amount": "string",
      "rate": "string",
      "description": "string"
    }
  ],
  "solarFeedInTariff": [
    {
      "displayName": "string",
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "scheme": "PREMIUM",
      "payerType": "GOVERNMENT",
      "tariffUType": "singleTariff",
      "singleTariff": {
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ]
      },
      "timeVaryingTariffs": {
        "type": "PEAK",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ],
        "timeVariations": [
          {
            "days": [
              "SUN"
            ],
            "startTime": "string",
            "endTime": "string"
          }
        ]
      }
    }
  ],
  "tariffPeriod": [
    {
      "type": "ENVIRONMENTAL",
      "displayName": "string",
      "startDate": "string",
      "endDate": "string",
      "dailySupplyCharges": "string",
      "timeZone": "LOCAL",
      "rateBlockUType": "singleRate",
      "singleRate": {
        "displayName": "string",
        "description": "string",
        "generalUnitPrice": "string",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ],
        "period": "string"
      },
      "timeOfUseRates": [
        {
          "displayName": "string",
          "description": "string",
          "rates": [
            {
              "unitPrice": "string",
              "measureUnit": "KWH",
              "volume": 0
            }
          ],
          "timeOfUse": [
            {
              "days": [
                "SUN"
              ],
              "startTime": "string",
              "endTime": "string"
            }
          ],
          "type": "PEAK"
        }
      ],
      "demandCharges": [
        {
          "displayName": "string",
          "description": "string",
          "amount": "string",
          "measureUnit": "KWH",
          "startTime": "string",
          "endTime": "string",
          "days": [
            "SUN"
          ],
          "minDemand": "string",
          "maxDemand": "string",
          "measurementPeriod": "DAY",
          "chargePeriod": "DAY"
        }
      ]
    }
  ],
  "termType": "1_YEAR",
  "benefitPeriod": "string",
  "terms": "string",
  "meterTypes": [
    "string"
  ],
  "coolingOffDays": 0,
  "billFrequency": [
    "string"
  ]
}

Properties

allOf

Name	Type	Required	Description
anonymous	EnergyPlanContractV2	mandatory	none

and

Name	Type	Required	Description
anonymous	object	mandatory	none
» termType	Enum	optional	The term for the contract. If absent assumes no specified term
» benefitPeriod	string	conditional	Description of the benefit period. Should only be present if termType has the value ONGOING
» terms	string	optional	Free text description of the terms for the contract
» meterTypes	[string]	optional	An array of the meter types that this contract is available for
» coolingOffDays	PositiveInteger	conditional	Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET
» billFrequency	[string]	mandatory	An array of the available billing schedules for this contract. Formatted according to ISO 8601 Durations (excludes recurrence syntax)

Enumerated Values

Property	Value
termType	1_YEAR
termType	2_YEAR
termType	3_YEAR
termType	4_YEAR
termType	5_YEAR
termType	ONGOING
termType	OTHER

EnergyPlanControlledLoad

[
  {
    "displayName": "string",
    "rateBlockUType": "singleRate",
    "startDate": "string",
    "endDate": "string",
    "singleRate": {
      "displayName": "string",
      "description": "string",
      "dailySupplyCharge": "string",
      "rates": [
        {
          "unitPrice": "string",
          "measureUnit": "KWH",
          "volume": 0
        }
      ]
    },
    "timeOfUseRates": [
      {
        "displayName": "string",
        "description": "string",
        "dailySupplyCharge": "string",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ],
        "timeOfUse": [
          {
            "days": [
              "SUN"
            ],
            "startTime": "string",
            "endTime": "string",
            "additionalInfo": "string",
            "additionalInfoUri": "string"
          }
        ],
        "type": "PEAK"
      }
    ]
  }
]

Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD

Properties

Name	Type	Required	Description
displayName	string	mandatory	A display name for the controlled load
rateBlockUType	Enum	mandatory	Specifies the type of controlloed load rate
startDate	DateString	optional	Optional start date of the application of the controlled load rate
endDate	DateString	optional	Optional end date of the application of the controlled load rate
singleRate	object	conditional	Object representing a single controlled load rate. Required if rateBlockUType is singleRate
» displayName	string	mandatory	Display name of the controlled load rate
» description	string	optional	Description of the controlled load rate
» dailySupplyCharge	AmountString	optional	The daily supply charge (exclusive of GST) for this controlled load tier
» rates	[object]	mandatory	Array of controlled load rates in order of usage volume
»» unitPrice	AmountString	mandatory	Unit price of usage per measure unit (exclusive of GST)
»» measureUnit	Enum	optional	The measurement unit of rate. Assumed to be KWH if absent
»» volume	number	optional	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
timeOfUseRates	[object]	conditional	Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates
» displayName	string	mandatory	Display name of the controlled load rate
» description	string	optional	Description of the controlled load rate
» dailySupplyCharge	AmountString	optional	The daily supply charge (exclusive of GST) for this controlled load tier
» rates	[object]	mandatory	Array of controlled load rates in order of usage volume
»» unitPrice	AmountString	mandatory	Unit price of usage per measure unit (exclusive of GST)
»» measureUnit	Enum	optional	The measurement unit of rate. Assumed to be KWH if absent
»» volume	number	optional	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
» timeOfUse	[object]	mandatory	Array of times of use.
»» days	[Enum]	optional	The days that the rate applies to
»» startTime	ExternalRef	conditional	The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
»» endTime	ExternalRef	conditional	The end of the time period per day for which the controlled load rate applies. Required if startTime provided. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
»» additionalInfo	string	conditional	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
»» additionalInfoUri	URIString	optional	Optional link to additional information regarding the controlled load
» type	Enum	mandatory	The type of usage that the rate applies to

Enumerated Values

Property	Value
rateBlockUType	singleRate
rateBlockUType	timeOfUseRates
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
days	SUN
days	MON
days	TUE
days	WED
days	THU
days	FRI
days	SAT
days	PUBLIC_HOLIDAYS
type	PEAK
type	OFF_PEAK
type	SHOULDER
type	SOLAR_SPONGE

EnergyPlanIncentives

[
  {
    "displayName": "string",
    "description": "string",
    "category": "GIFT",
    "eligibility": "string"
  }
]

Optional list of incentives available for the contract

Properties

Name	Type	Required	Description
displayName	string	mandatory	The display name of the incentive
description	string	mandatory	The description of the incentive
category	Enum	mandatory	The type of the incentive
eligibility	string	optional	A display message outlining an eligibility criteria that may apply

Enumerated Values

Property	Value
category	GIFT
category	ACCOUNT_CREDIT
category	OTHER

EnergyPlanDiscounts

[
  {
    "displayName": "string",
    "description": "string",
    "type": "CONDITIONAL",
    "category": "PAY_ON_TIME",
    "endDate": "string",
    "methodUType": "percentOfBill",
    "percentOfBill": {
      "rate": "string"
    },
    "percentOfUse": {
      "rate": "string"
    },
    "fixedAmount": {
      "amount": "string"
    },
    "percentOverThreshold": {
      "rate": "string",
      "usageAmount": "string"
    }
  }
]

Optional list of discounts available for the contract

Properties

Name	Type	Required	Description
displayName	string	mandatory	The display name of the discount
description	string	optional	The description of the discount
type	Enum	mandatory	The type of the discount
category	Enum	optional	The type of the discount. Mandatory if the discount type is CONDITIONAL
endDate	DateString	optional	Optional end date for the discount after which the discount is no longer available
methodUType	Enum	mandatory	The method of calculation of the discount
percentOfBill	object	conditional	Required if methodUType is percentOfBill
» rate	RateString	mandatory	The rate of the discount applied to the bill amount
percentOfUse	object	conditional	Required if methodUType is percentOfUse
» rate	RateString	mandatory	The rate of the discount applied to the usageamount
fixedAmount	object	conditional	Required if methodUType is fixedAmount
» amount	AmountString	mandatory	The amount of the discount
percentOverThreshold	object	conditional	Required if methodUType is percentOverThreshold
» rate	RateString	mandatory	The rate of the discount over the usage amount
» usageAmount	AmountString	mandatory	The usage amount threshold above which the discount applies

Enumerated Values

Property	Value
type	CONDITIONAL
type	GUARANTEED
type	OTHER
category	PAY_ON_TIME
category	DIRECT_DEBIT
category	GUARANTEED_DISCOUNT
category	OTHER
methodUType	percentOfBill
methodUType	percentOfUse
methodUType	fixedAmount
methodUType	percentOverThreshold

EnergyPlanGreenPowerCharges

[
  {
    "displayName": "string",
    "description": "string",
    "scheme": "GREENPOWER",
    "type": "FIXED_PER_DAY",
    "tiers": [
      {
        "percentGreen": "string",
        "rate": "string",
        "amount": "string"
      }
    ]
  }
]

Optional list of charges applicable to green power

Properties

Name	Type	Required	Description
displayName	string	mandatory	The display name of the charge
description	string	optional	The description of the charge
scheme	Enum	mandatory	The applicable green power scheme
type	Enum	mandatory	The type of charge
tiers	[object]	mandatory	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
» percentGreen	RateString	mandatory	The upper percentage of green power used applicable for this tier
» rate	RateString	conditional	The rate of the charge if the type implies the application of a rate
» amount	AmountString	conditional	The amount of the charge if the type implies the application of a fixed amount

Enumerated Values

Property	Value
scheme	GREENPOWER
scheme	OTHER
type	FIXED_PER_DAY
type	FIXED_PER_WEEK
type	FIXED_PER_MONTH
type	FIXED_PER_UNIT
type	PERCENT_OF_USE
type	PERCENT_OF_BILL

EnergyPlanEligibility

[
  {
    "type": "EXISTING_CUST",
    "information": "string",
    "description": "string"
  }
]

Eligibility restrictions or requirements

Properties

Name	Type	Required	Description
type	Enum	mandatory	The type of the eligibility restriction. The CONTINGENT_PLAN value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up)
information	string	mandatory	Information of the eligibility restriction specific to the type of the restriction
description	string	optional	A description of the eligibility restriction

Enumerated Values

Property	Value
type	EXISTING_CUST
type	EXISTING_POOL
type	EXISTING_SOLAR
type	EXISTING_BATTERY
type	EXISTING_SMART_METER
type	EXISTING_BASIC_METER
type	SENIOR_CARD
type	SMALL_BUSINESS
type	NO_SOLAR_FIT
type	NEW_CUSTOMER
type	ONLINE_ONLY
type	REQ_EQUIP_SUPPLIER
type	THIRD_PARTY_ONLY
type	SPORT_CLUB_MEMBER
type	ORG_MEMBER
type	SPECIFIC_LOCATION
type	MINIMUM_USAGE
type	LOYALTY_MEMBER
type	GROUP_BUY_MEMBER
type	CONTINGENT_PLAN
type	OTHER

EnergyPlanFees

[
  {
    "type": "EXIT",
    "term": "FIXED",
    "amount": "string",
    "rate": "string",
    "description": "string"
  }
]

An array of fees applicable to the plan

Properties

Name	Type	Required	Description
type	Enum	mandatory	The type of the fee
term	Enum	mandatory	The term of the fee
amount	AmountString	conditional	The fee amount. Required if term is not PERCENT_OF_BILL
rate	RateString	conditional	The fee rate. Required if term is PERCENT_OF_BILL
description	string	optional	A description of the fee

Enumerated Values

Property	Value
type	EXIT
type	ESTABLISHMENT
type	LATE_PAYMENT
type	DISCONNECTION
type	DISCONNECT_MOVE_OUT
type	DISCONNECT_NON_PAY
type	RECONNECTION
type	CONNECTION
type	PAYMENT_PROCESSING
type	CC_PROCESSING
type	CHEQUE_DISHONOUR
type	DD_DISHONOUR
type	MEMBERSHIP
type	CONTRIBUTION
type	PAPER_BILL
type	OTHER
term	FIXED
term	1_YEAR
term	2_YEAR
term	3_YEAR
term	4_YEAR
term	5_YEAR
term	PERCENT_OF_BILL
term	ANNUAL
term	DAILY
term	WEEKLY
term	MONTHLY
term	BIANNUAL
term	VARIABLE

EnergyPlanSolarFeedInTariffV2

[
  {
    "displayName": "string",
    "description": "string",
    "startDate": "string",
    "endDate": "string",
    "scheme": "PREMIUM",
    "payerType": "GOVERNMENT",
    "tariffUType": "singleTariff",
    "singleTariff": {
      "rates": [
        {
          "unitPrice": "string",
          "measureUnit": "KWH",
          "volume": 0
        }
      ]
    },
    "timeVaryingTariffs": {
      "type": "PEAK",
      "rates": [
        {
          "unitPrice": "string",
          "measureUnit": "KWH",
          "volume": 0
        }
      ],
      "timeVariations": [
        {
          "days": [
            "SUN"
          ],
          "startTime": "string",
          "endTime": "string"
        }
      ]
    }
  }
]

Array of feed in tariffs for solar power

Properties

Name	Type	Required	Description
displayName	string	mandatory	The name of the tariff
description	string	optional	A description of the tariff
startDate	DateString	optional	The start date of the application of the feed in tariff
endDate	DateString	optional	The end date of the application of the feed in tariff
scheme	Enum	mandatory	The applicable scheme
payerType	Enum	mandatory	The type of the payer
tariffUType	Enum	mandatory	The type of the payer
singleTariff	object	conditional	Represents a constant tariff. Mandatory if tariffUType is set to singleTariff
» rates	[object]	mandatory	Array of feed in rates
»» unitPrice	AmountString	mandatory	Unit price of usage per measure unit (exclusive of GST)
»» measureUnit	Enum	optional	The measurement unit of rate. Assumed to be KWH if absent
»» volume	number	optional	Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
timeVaryingTariffs	object	conditional	Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs
» type	Enum	optional	The type of the charging time period. If absent applies to all periods
» rates	[object]	optional	Array of feed in rates
»» unitPrice	AmountString	mandatory	Unit price of usage per measure unit (exclusive of GST)
»» measureUnit	Enum	optional	The measurement unit of rate. Assumed to be KWH if absent
»» volume	number	optional	Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period
» timeVariations	[object]	mandatory	Array of time periods for which this tariff is applicable
»» days	[Enum]	mandatory	The days that the tariff applies to. At least one entry required
»» startTime	ExternalRef	optional	The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight). Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
»» endTime	ExternalRef	optional	The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight). Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.

Enumerated Values

Property	Value
scheme	PREMIUM
scheme	OTHER
payerType	GOVERNMENT
payerType	RETAILER
tariffUType	singleTariff
tariffUType	timeVaryingTariffs
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
type	PEAK
type	OFF_PEAK
type	SHOULDER
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
days	SUN
days	MON
days	TUE
days	WED
days	THU
days	FRI
days	SAT
days	PUBLIC_HOLIDAYS

EnergyPlanTariffPeriod

[
  {
    "type": "ENVIRONMENTAL",
    "displayName": "string",
    "startDate": "string",
    "endDate": "string",
    "dailySupplyCharges": "string",
    "timeZone": "LOCAL",
    "rateBlockUType": "singleRate",
    "singleRate": {
      "displayName": "string",
      "description": "string",
      "generalUnitPrice": "string",
      "rates": [
        {
          "unitPrice": "string",
          "measureUnit": "KWH",
          "volume": 0
        }
      ],
      "period": "string"
    },
    "timeOfUseRates": [
      {
        "displayName": "string",
        "description": "string",
        "rates": [
          {
            "unitPrice": "string",
            "measureUnit": "KWH",
            "volume": 0
          }
        ],
        "timeOfUse": [
          {
            "days": [
              "SUN"
            ],
            "startTime": "string",
            "endTime": "string"
          }
        ],
        "type": "PEAK"
      }
    ],
    "demandCharges": [
      {
        "displayName": "string",
        "description": "string",
        "amount": "string",
        "measureUnit": "KWH",
        "startTime": "string",
        "endTime": "string",
        "days": [
          "SUN"
        ],
        "minDemand": "string",
        "maxDemand": "string",
        "measurementPeriod": "DAY",
        "chargePeriod": "DAY"
      }
    ]
  }
]

Array of tariff periods

Properties

Name	Type	Required	Description
type	Enum	optional	Type of charge. Assumed to be other if absent
displayName	string	mandatory	The name of the tariff period
startDate	string	mandatory	The start date of the tariff period in a calendar year. Formatted in mm-dd format
endDate	string	mandatory	The end date of the tariff period in a calendar year. Formatted in mm-dd format
dailySupplyCharges	AmountString	optional	The amount of access charge for the tariff period, in dollars per day exclusive of GST.
timeZone	Enum	optional	Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.
rateBlockUType	Enum	mandatory	Specifies the type of rate applicable to this tariff period
singleRate	object	conditional	Object representing a single rate. Required if rateBlockUType is singleRate
» displayName	string	mandatory	Display name of the rate
» description	string	optional	Description of the rate
» generalUnitPrice	AmountString	conditional	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’
» rates	[object]	mandatory	Array of controlled load rates in order of usage volume
»» unitPrice	AmountString	mandatory	Unit price of usage per measure unit (exclusive of GST)
»» measureUnit	Enum	optional	The measurement unit of rate. Assumed to be KWH if absent
»» volume	number	optional	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
» period	ExternalRef	optional	Usage period for which the block rate applies. Formatted according to ISO 8601 Durations (excludes recurrence syntax)
timeOfUseRates	[object]	conditional	Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates
» displayName	string	mandatory	Display name of the rate
» description	string	optional	Description of the rate
» rates	[object]	mandatory	Array of controlled load rates in order of usage volume
»» unitPrice	AmountString	mandatory	Unit price of usage per measure unit (exclusive of GST)
»» measureUnit	Enum	optional	The measurement unit of rate. Assumed to be KWH if absent
»» volume	number	optional	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
» timeOfUse	[object]	mandatory	Array of times of use
»» days	[Enum]	mandatory	The days that the rate applies to
»» startTime	ExternalRef	mandatory	Start of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
»» endTime	ExternalRef	mandatory	End of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
» type	Enum	mandatory	The type of usage that the rate applies to
demandCharges	[object]	conditional	Array of demand charges. Required if rateBlockUType is demandCharges
» displayName	string	mandatory	Display name of the charge
» description	string	optional	Description of the charge
» amount	AmountString	mandatory	The charge amount per measure unit exclusive of GST
» measureUnit	Enum	optional	The measurement unit of charge amount. Assumed to be KWH if absent
» startTime	ExternalRef	mandatory	Start of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
» endTime	ExternalRef	mandatory	End of the period. Formatted according to ISO 8601 Times. If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone.
» days	[Enum]	optional	The days that the demand tariff applies to
» minDemand	AmountString	optional	Minimum demand for this demand tariff in kW. If absent then 0 is assumed
» maxDemand	AmountString	optional	Maximum demand for this demand tariff in kW. If present, must be higher than the value of the minDemand field
» measurementPeriod	Enum	mandatory	Application period for the demand tariff
» chargePeriod	Enum	mandatory	Charge period for the demand tariff

Enumerated Values

Property	Value
type	ENVIRONMENTAL
type	REGULATED
type	NETWORK
type	METERING
type	RETAIL_SERVICE
type	RCTI
type	OTHER
timeZone	LOCAL
timeZone	AEST
rateBlockUType	singleRate
rateBlockUType	timeOfUseRates
rateBlockUType	demandCharges
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
days	SUN
days	MON
days	TUE
days	WED
days	THU
days	FRI
days	SAT
days	PUBLIC_HOLIDAYS
type	PEAK
type	OFF_PEAK
type	SHOULDER
type	SHOULDER1
type	SHOULDER2
measureUnit	KWH
measureUnit	KVA
measureUnit	KVAR
measureUnit	KVARH
measureUnit	KW
measureUnit	DAYS
measureUnit	METER
measureUnit	MONTH
days	SUN
days	MON
days	TUE
days	WED
days	THU
days	FRI
days	SAT
days	PUBLIC_HOLIDAYS
measurementPeriod	DAY
measurementPeriod	MONTH
measurementPeriod	TARIFF_PERIOD
chargePeriod	DAY
chargePeriod	MONTH
chargePeriod	TARIFF_PERIOD

Links

{
  "self": "string"
}

Properties

Name	Type	Required	Description
self	URIString	mandatory	Fully qualified link that generated the current response document

Meta

{}

Properties

None

LinksPaginated

{
  "self": "string",
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string"
}

Properties

Name	Type	Required	Description
self	URIString	mandatory	Fully qualified link that generated the current response document
first	URIString	conditional	URI to the first page of this set. Mandatory if this response is not the first page
prev	URIString	conditional	URI to the previous page of this set. Mandatory if this response is not the first page
next	URIString	conditional	URI to the next page of this set. Mandatory if this response is not the last page
last	URIString	conditional	URI to the last page of this set. Mandatory if this response is not the last page

MetaPaginated

{
  "totalRecords": 0,
  "totalPages": 0
}

Properties

Name	Type	Required	Description
totalRecords	NaturalNumber	mandatory	The total number of records in the full set. See pagination.
totalPages	NaturalNumber	mandatory	The total number of pages in the full set. See pagination.