Update Consumption Profile

Update the existing consumption profile for a project.


Each request must contain utility_rate_escalation, one of the energy consumption values below, or both.


Energy consumption. A request accepts only one of the following values.

  • monthly_energy: An array of exactly 12 monthly energy values in kWh. Null values are allowed and represented as "null".

  • monthly_bill: An array of exactly 12 monthly bill values, denominated in the tenant's configured currency (see currency on GET /tenants/{id}). Null values are allowed and represented as "null".

  • interval_data: An array of exactly (8760, 8784, 17520, 17568, 35040, or 35136) energy values in kWh. Null values are allowed and represented as "null".

    • The array must contain at least 1 complete month of contiguous non-null values.
    • The first array value must correspond to the first interval of the year beginning at 1 January 00:00.
  • annual_energy: The total annual energy consumption in kWh. Aurora distributes it across the year using a typical load profile for the project's location, so monthly values follow the expected seasonal variation.

  • annual_bill: The total annual pre-solar electricity bill, denominated in the tenant's configured currency. Aurora finds the annual energy consumption whose bills, under the project's pre-solar utility rate, sum to this amount, then distributes that energy across the year in the same way as annual_energy.

    • The project must have a pre-solar utility rate. The conversion uses the rate set at the time of the request; changing the rate later does not change the consumption profile.

Bill inputs (monthly_bill, annual_bill) are converted to energy using energy and fixed charges only. Demand charges are not included in the conversion, so on a rate with demand charges the returned monthly_bill values are higher than the bills provided.

Annual inputs require a typical load profile for the project's location. The response returns input_values as null for every month, since all monthly values are estimated.


Utility rate escalation. utility_rate_escalation is independent of the energy consumption values. It can be sent on its own, which leaves the consumption profile unchanged, or together with one energy consumption value. If the request is rejected, neither is applied.

  • utility_rate_escalation: The annual escalation of utility rates, as a percentage (4.0 means 4%). New projects start with the tenant's default for the project's type and location. A value must fall within the tenant's configured minimum and maximum for the project, otherwise the request is rejected with a 422 error. The range is only checked when the value changes, so sending the project's current value is always accepted. null is treated as not provided, so the value cannot be reset to the tenant default through the API. Financing options that use an integration-provided escalation rate ignore this value.

Consumption profiles are only supported for residential projects.

Path Params
uuid
required

The ID of the tenant that the project is part of.

uuid
required

The ID of the project to update the consumption profile for.

Body Params
consumption_profile
object

Consumption profile fields to update.

Responses

Language
Credentials
Bearer
header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json