List energy accounts
Returns list of energy accounts belonging to the provided end user
You're viewing documentation for v1. The latest version is v3.
AI Actions
Returns list of energy accounts belonging to the provided end user
Query Parameters
A unique identifier for the End User object.
page[before]string
When the page[after] is specified, backwards pagination is achieved
page[after]string
When the page[after] is specified, forwards pagination is achieved
page[size]integer
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. It is capped at 1000.
Response Body
application/json
application/json
application/json
curl -X GET "https://api.fiskil.com/v1/energy/accounts?end_user_id=eu_12345"{
"accounts": [
{
"account_id": "9ccb2d66-bd77-4909-bd8a-bf0e73ef1f59",
"account_number": "41100022",
"arrangement_id": "arr678",
"creation_date": "2024-09-13",
"display_name": "Peter's Energy Account",
"fiskil_id": "energy_account_abcdef123",
"institution_id": "12345",
"open_status": "OPEN",
"plans": [
{
"authorised_contacts": [
{
"first_name": "Mary",
"last_name": "Sherman",
"middle_names": [
"string"
],
"prefix": "Mrs",
"suffix": "Sr"
}
],
"nickname": "Home address",
"plan_detail": {
"electricity_contract": {
"additional_fee_information": "We charge additional fees in specific circumstances.",
"controlled_load": [
{
"display_name": "Fixed controlled load",
"end_date": "2025-01-01",
"rate_block_u_type": "singleRate",
"single_rate": {
"daily_supply_charge": "0.45",
"description": "First 100 KWH usage",
"display_name": "Band 1",
"period": "P3M",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-06-01",
"time_of_use_rates": [
{
"daily_supply_charge": "0.45",
"description": "Your first 100KWH of usage",
"display_name": "First tier",
"period": "P1Y",
"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": [
"FRI"
],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
]
}
],
"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"
}
],
"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": false,
"on_expiry_description": "At the end of the contract period you will revert to the market offering plan",
"payment_option": [
"BPAY"
],
"pricing_model": "TIME_OF_USE_CONT_LOAD",
"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": {
"period": "P1Y",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-09-01",
"tariff_u_type": "singleTariff",
"time_varying_tariffs": {
"display_name": "Basic Solar FIT",
"period": "string",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_variations": [
{
"days": [
"FRI"
],
"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": [
"FRI"
],
"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",
"period": "P1Y",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_of_use": [
{
"days": [
"FRI"
],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
],
"time_zone": "AEST",
"type": "RETAIL_SERVICE"
}
],
"time_zone": "AEST",
"variation": "Pricing may vary from time to time. We will provide two weeks notice via email."
},
"fuel_type": "DUAL",
"gas_contract": {
"additional_fee_information": "We charge additional fees in specific circumstances.",
"controlled_load": [
{
"display_name": "Fixed controlled load",
"end_date": "2025-01-01",
"rate_block_u_type": "singleRate",
"single_rate": {
"daily_supply_charge": "0.45",
"description": "First 100 KWH usage",
"display_name": "Band 1",
"period": "P3M",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-06-01",
"time_of_use_rates": [
{
"daily_supply_charge": "0.45",
"description": "Your first 100KWH of usage",
"display_name": "First tier",
"period": "P1Y",
"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": [
"FRI"
],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
]
}
],
"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"
}
],
"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": false,
"on_expiry_description": "At the end of the contract period you will revert to the market offering plan",
"payment_option": [
"BPAY"
],
"pricing_model": "TIME_OF_USE_CONT_LOAD",
"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": {
"period": "P1Y",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
]
},
"start_date": "2024-09-01",
"tariff_u_type": "singleTariff",
"time_varying_tariffs": {
"display_name": "Basic Solar FIT",
"period": "string",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_variations": [
{
"days": [
"FRI"
],
"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": [
"FRI"
],
"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",
"period": "P1Y",
"rates": [
{
"measure_unit": "KWH",
"unit_price": "0.643",
"volume": 100
}
],
"time_of_use": [
{
"days": [
"FRI"
],
"end_time": "T19:00:00",
"start_time": "T05:30:00"
}
],
"type": "PEAK"
}
],
"time_zone": "AEST",
"type": "RETAIL_SERVICE"
}
],
"time_zone": "AEST",
"variation": "Pricing may vary from time to time. We will provide two weeks notice via email."
},
"is_contingent_plan": false,
"metering_charges": [
{
"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_overview": {
"display_name": "Simple Residential",
"end_date": "2025-09-13",
"start_date": "2024-09-13"
},
"service_point_ids": [
"string"
]
}
]
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}{
"id": "string",
"message": "string",
"name": "string"
}{
"id": "string",
"message": "string",
"name": "string"
}Was this page helpful?