Core Resources
Banking Api
Energy Api
Common api
Obtain a list of energy plans that are currently offered to the market.
Plan Endpoints
Retrieves a Plan object.
{
"plans": [
{
"additional_information": {
"bundle_uri": "https://example.com/bundles",
"eligibility_uri": "https://example.com/eligibility",
"overview_uri": "https://example.com/overview",
"pricing_uri": "https://example.com/pricing",
"terms_uri": "https://example.com/terms"
},
"application_uri": "https://example.com/apply",
"brand": "Brand123",
"brand_name": "ACME Energy",
"customer_type": "RESIDENTIAL",
"description": "A simple flat-rate residential energy plan.",
"display_name": "Everyday Simple",
"effective_from": "2023-01-01T00:00:00Z",
"effective_to": "2025-01-01T00:00:00Z",
"fuel_type": "ELECTRICITY",
"geography": {
"distributors": [
"Ausgrid"
],
"excluded_postcodes": [
"3000",
"3001"
],
"included_postcodes": [
"4000",
"4001"
]
},
"institution_id": "140",
"institution_name": "ACME Energy Corp.",
"last_updated": "2024-09-15T12:34:56Z",
"plan_id": "89e4cf54-1228-473f-aa99-38fcc7c6cc4d",
"type": "MARKET"
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}/v1/energy/plans
Obtain a list of energy plans that are currently offered to the market.
A unique identifier for the Retailer object. It must be a valid CDR brand id, you can use AER website to know all available retailers. Exactly one of retailer_id or institution_id parameters is required.
A unique identifier for the Institution object. It must be a valid ID fetched from Institutions API. Exactly one of retailer_id or institution_id parameters is required.
When the page[before] is specified, backwards pagination is achieved
When the page[after] is specified, forwards pagination is achieved
When the page[size] is specified, no more than page[size] resources will be included in the response's data field. This parameter is set to a sensible default, which varies depending on the endpoint.
curl --request GET \
--url https://api.fiskil.com/v1/v1/energy/plans?retailer_id={retailer_id}&institution_id={institution_id}&page[before]={page[before]}&page[after]={page[after]}&page[size]={page[size]} \
--header 'Authorization: Bearer {access_token}' \
--header 'accept: application/json; charset=UTF-8' \
--header 'content-type: application/json; charset=UTF-8'
{
"plans": [
{
"additional_information": {
"bundle_uri": "https://example.com/bundles",
"eligibility_uri": "https://example.com/eligibility",
"overview_uri": "https://example.com/overview",
"pricing_uri": "https://example.com/pricing",
"terms_uri": "https://example.com/terms"
},
"application_uri": "https://example.com/apply",
"brand": "Brand123",
"brand_name": "ACME Energy",
"customer_type": "RESIDENTIAL",
"description": "A simple flat-rate residential energy plan.",
"display_name": "Everyday Simple",
"effective_from": "2023-01-01T00:00:00Z",
"effective_to": "2025-01-01T00:00:00Z",
"fuel_type": "ELECTRICITY",
"geography": {
"distributors": [
"Ausgrid"
],
"excluded_postcodes": [
"3000",
"3001"
],
"included_postcodes": [
"4000",
"4001"
]
},
"institution_id": "140",
"institution_name": "ACME Energy Corp.",
"last_updated": "2024-09-15T12:34:56Z",
"plan_id": "89e4cf54-1228-473f-aa99-38fcc7c6cc4d",
"type": "MARKET"
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}/v1/energy/plans/{plan_id}
Retrieve a specific plan detail for the given planId
A unique identifier for the plan object as returned by the List Plans API.
curl --request GET \
--url https://api.fiskil.com/v1/v1/energy/plans/{plan_id} \
--header 'Authorization: Bearer {access_token}' \
--header 'accept: application/json; charset=UTF-8' \
--header 'content-type: application/json; charset=UTF-8'
{
"data": {
"additional_information": {
"bundle_uri": "https://example.com/bundles",
"eligibility_uri": "https://example.com/eligibility",
"overview_uri": "https://example.com/overview",
"pricing_uri": "https://example.com/pricing",
"terms_uri": "https://example.com/terms"
},
"application_uri": "https://example.com/apply",
"brand": "Brand123",
"brand_name": "ACME Energy",
"customer_type": "RESIDENTIAL",
"description": "A simple flat-rate residential energy plan.",
"display_name": "Everyday Simple",
"effective_from": "2023-01-01T00:00:00Z",
"effective_to": "2025-01-01T00:00:00Z",
"electricityContract": {
"additional_fee_information": "This is a great value energy plan for households with basic meters",
"benefit_period": "You'll receieve 20% off the market rate for the first 6 months",
"bill_frequency": [
"P3M",
"P1Y",
"P1M"
],
"controlled_load": [
{
"display_name": "Fixed controlled load",
"end_date": "2025-01-01",
"rate_block_u_type": "singleRate",
"singleRate": {
"daily_supply_charge": "0.45",
"description": "First 100 KWH usage",
"display_name": "Band 1",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-06-01",
"timeOfUseRates": [
{
"daily_supply_charge": "0.45",
"description": "Your first 100KWH of usage",
"display_name": "First tier",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_of_use": [
{
"additional_info": "This is our simplest controlled load plan",
"additional_info_uri": "https://www.acme-energy.com.au/controlled-load",
"days": [],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
]
}
],
"cooling_off_days": 14,
"discounts": [
{
"category": "PAY_ON_TIME",
"description": "Save 2% of your bill if you pay on time",
"display_name": "Pay on time discount",
"end_date": "2025-01-01",
"fixed_amount": {
"amount": "15.00"
},
"method_u_type": "percentOfBill",
"percent_of_bill": {
"rate": "0.02"
},
"percent_of_use": {
"rate": "0.1"
},
"percent_over_threshold": {
"rate": "0.50",
"usage_amount": "150.00"
},
"type": "CONDITIONAL,GUARANTEED,OTHER"
}
],
"eligibility": [
{
"description": "To be eligible for this plan you need to purchase a bundle plan of electricity and gas",
"information": "You must also take up a gas plan with us",
"type": "CONTINGENT_PLAN"
}
],
"fees": [
{
"amount": "17.50",
"description": "A fixed fee applies for new connections where a technician must attend the site",
"rate": "0.05",
"term": "VARIABLE",
"type": "CONNECTION"
}
],
"green_power_charges": [
{
"description": "For an additional fee you can guarantee you're using renewable energy",
"display_name": "Green power guarantee",
"scheme": "GREENPOWER",
"tiers": [
{
"amount": "0.10",
"percent_green": "1.0",
"rate": "0.1"
}
],
"type": "FIXED_PER_UNIT"
}
],
"incentives": [
{
"category": "OTHER",
"description": "100 Mega Points are credited to your account 6 months after signup",
"display_name": "Mega Points",
"eligibility": "You must have a valid mega points customer number and pass it to us when you sign up"
}
],
"intrinsic_green_power": {
"green_percentage": "0.3"
},
"is_fixed": true,
"meter_types": [
"Type 4",
"Type 4a",
"Type 5",
"Type 6"
],
"on_expiry_description": "After 6 months you will revert to the market plan",
"payment_option": [
"CREDIT_CARD",
"DIRECT_DEBIT"
],
"pricing_model": "SINGLE_RATE",
"solar_feed_in_tariff": [
{
"description": "10c per kWH will be credited to your bill",
"display_name": "Anytime Solar FIT",
"end_date": "2025-09-01",
"payer_type": "RETAILER",
"scheme": "OTHER",
"single_tariff": {
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-09-01",
"tariffUType": "singleTariff",
"timeVaryingTariffs": {
"display_name": "Basic Solar FIT",
"period": "string",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_variations": [
{
"days": [],
"end_time": "T22:00:00",
"start_time": "T05:00:00"
}
],
"type": "PEAK"
},
"time_varying_tariffs_v2": [
{
"display_name": "Basic Solar FIT",
"period": "string",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_variations": [
{
"days": [],
"end_time": "T22:00:00",
"start_time": "T05:00:00"
}
],
"type": "PEAK"
}
]
}
],
"tariff_period": [
{
"banded_daily_supply_charges": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"daily_supply_charge": "0.54",
"daily_supply_charge_type": "SINGLE",
"daily_supply_charges": "0.54",
"demand_charges": [
{
"amount": "0.812",
"charge_period": "TARIFF_PERIOD",
"days": [
"FRI",
"MON",
"TUE",
"WED",
"THU"
],
"description": "Additional tariffs apply if usage exceeds a specific demand threshold",
"display_name": "Demand charges",
"end_time": "T19:00:00",
"max_demand": "10.00",
"measure_unit": "KVA",
"measurement_period": "DAY",
"min_demand": "5.00",
"start_time": "T08:00:00"
}
],
"display_name": "Basic Any Time",
"end_date": "31-12",
"rate_block_u_type": "singleRate",
"single_rate": {
"description": "This rate applies to your usage at any time of day",
"display_name": "Anytime Basic",
"general_unit_price": "0.355",
"period": "P1Y",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "01-01",
"time_of_use_rates": [
{
"description": "The standard Time-Of-Use rates applying to your usage",
"display_name": "ToU rate",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_of_use": [
{
"days": [],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
],
"time_zone": "AEST",
"type": "RETAIL_SERVICE"
}
],
"term_type": "ONGOING",
"terms": "You must pay all bills on time to be eligible for your 20% discount",
"time_zone": "AEST",
"variation": "From time-to-time we may vary the cost of your plan as the energy market changes. You will receive 14 days notice via your contact email address."
},
"fuel_type": "ELECTRICITY",
"gasContract": {
"additional_fee_information": "This is a great value energy plan for households with basic meters",
"benefit_period": "You'll receieve 20% off the market rate for the first 6 months",
"bill_frequency": [
"P3M",
"P1Y",
"P1M"
],
"controlled_load": [
{
"display_name": "Fixed controlled load",
"end_date": "2025-01-01",
"rate_block_u_type": "singleRate",
"singleRate": {
"daily_supply_charge": "0.45",
"description": "First 100 KWH usage",
"display_name": "Band 1",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-06-01",
"timeOfUseRates": [
{
"daily_supply_charge": "0.45",
"description": "Your first 100KWH of usage",
"display_name": "First tier",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_of_use": [
{
"additional_info": "This is our simplest controlled load plan",
"additional_info_uri": "https://www.acme-energy.com.au/controlled-load",
"days": [],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
]
}
],
"cooling_off_days": 14,
"discounts": [
{
"category": "PAY_ON_TIME",
"description": "Save 2% of your bill if you pay on time",
"display_name": "Pay on time discount",
"end_date": "2025-01-01",
"fixed_amount": {
"amount": "15.00"
},
"method_u_type": "percentOfBill",
"percent_of_bill": {
"rate": "0.02"
},
"percent_of_use": {
"rate": "0.1"
},
"percent_over_threshold": {
"rate": "0.50",
"usage_amount": "150.00"
},
"type": "CONDITIONAL,GUARANTEED,OTHER"
}
],
"eligibility": [
{
"description": "To be eligible for this plan you need to purchase a bundle plan of electricity and gas",
"information": "You must also take up a gas plan with us",
"type": "CONTINGENT_PLAN"
}
],
"fees": [
{
"amount": "17.50",
"description": "A fixed fee applies for new connections where a technician must attend the site",
"rate": "0.05",
"term": "VARIABLE",
"type": "CONNECTION"
}
],
"green_power_charges": [
{
"description": "For an additional fee you can guarantee you're using renewable energy",
"display_name": "Green power guarantee",
"scheme": "GREENPOWER",
"tiers": [
{
"amount": "0.10",
"percent_green": "1.0",
"rate": "0.1"
}
],
"type": "FIXED_PER_UNIT"
}
],
"incentives": [
{
"category": "OTHER",
"description": "100 Mega Points are credited to your account 6 months after signup",
"display_name": "Mega Points",
"eligibility": "You must have a valid mega points customer number and pass it to us when you sign up"
}
],
"intrinsic_green_power": {
"green_percentage": "0.3"
},
"is_fixed": true,
"meter_types": [
"Type 4",
"Type 4a",
"Type 5",
"Type 6"
],
"on_expiry_description": "After 6 months you will revert to the market plan",
"payment_option": [
"CREDIT_CARD",
"DIRECT_DEBIT"
],
"pricing_model": "SINGLE_RATE",
"solar_feed_in_tariff": [
{
"description": "10c per kWH will be credited to your bill",
"display_name": "Anytime Solar FIT",
"end_date": "2025-09-01",
"payer_type": "RETAILER",
"scheme": "OTHER",
"single_tariff": {
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-09-01",
"tariffUType": "singleTariff",
"timeVaryingTariffs": {
"display_name": "Basic Solar FIT",
"period": "string",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_variations": [
{
"days": [],
"end_time": "T22:00:00",
"start_time": "T05:00:00"
}
],
"type": "PEAK"
},
"time_varying_tariffs_v2": [
{
"display_name": "Basic Solar FIT",
"period": "string",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_variations": [
{
"days": [],
"end_time": "T22:00:00",
"start_time": "T05:00:00"
}
],
"type": "PEAK"
}
]
}
],
"tariff_period": [
{
"banded_daily_supply_charges": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"daily_supply_charge": "0.54",
"daily_supply_charge_type": "SINGLE",
"daily_supply_charges": "0.54",
"demand_charges": [
{
"amount": "0.812",
"charge_period": "TARIFF_PERIOD",
"days": [
"FRI",
"MON",
"TUE",
"WED",
"THU"
],
"description": "Additional tariffs apply if usage exceeds a specific demand threshold",
"display_name": "Demand charges",
"end_time": "T19:00:00",
"max_demand": "10.00",
"measure_unit": "KVA",
"measurement_period": "DAY",
"min_demand": "5.00",
"start_time": "T08:00:00"
}
],
"display_name": "Basic Any Time",
"end_date": "31-12",
"rate_block_u_type": "singleRate",
"single_rate": {
"description": "This rate applies to your usage at any time of day",
"display_name": "Anytime Basic",
"general_unit_price": "0.355",
"period": "P1Y",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "01-01",
"time_of_use_rates": [
{
"description": "The standard Time-Of-Use rates applying to your usage",
"display_name": "ToU rate",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_of_use": [
{
"days": [],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
],
"time_zone": "AEST",
"type": "RETAIL_SERVICE"
}
],
"term_type": "ONGOING",
"terms": "You must pay all bills on time to be eligible for your 20% discount",
"time_zone": "AEST",
"variation": "From time-to-time we may vary the cost of your plan as the energy market changes. You will receive 14 days notice via your contact email address."
},
"geography": {
"distributors": [
"Ausgrid"
],
"excluded_postcodes": [
"3000",
"3001"
],
"included_postcodes": [
"4000",
"4001"
]
},
"institution_id": "140",
"institution_name": "ACME Energy Corp.",
"last_updated": "2024-09-15T12:34:56Z",
"meteringCharges": [
{
"description": "A charge that applies of the technician is unable to read the meter due to failed access",
"display_name": "Read retry fee",
"maximum_value": "15.00",
"minimum_value": "0.00",
"period": "P3M"
}
],
"plan_id": "89e4cf54-1228-473f-aa99-38fcc7c6cc4d",
"type": "MARKET"
}
}Was this page helpful?