residentialPlans query returns a list of available retail electricity plans for a U.S. residential service location. Supply a ZIP code or a utility ID to scope results to the correct service territory, then tune pricing with monthlyUsage and priceType. Each plan in the response includes rate breakdowns at multiple usage levels, supplier reputation scores, document links, fee details, and ready-to-use enrollment URLs stamped with your partner code.
Parameters
String
ZIP code for the residential service location. If you supply both
zipCode and utilityId, utilityId takes precedence. If neither parameter resolves to a known service area, the query returns an empty list rather than an error.ID
Utility or TDU (Transmission and Distribution Utility) ID. When provided alongside
zipCode, utilityId takes precedence and zipCode is ignored.Long
Monthly electricity usage in kWh used to calculate the returned
price. Defaults to 1000 when omitted.String
Pricing mode applied to
price and to every row in rates. A String, not an enum, so the
value must be quoted."SEASONALIZED"— the default, also applied when the argument is omitted. Prices against a seasonal usage curve built aroundmonthlyUsage."FLAT"— prices the plan at the exactmonthlyUsagevalue with no seasonal adjustment.
priceType: FLAT is a validation error. Any other string is accepted silently and
falls through to seasonalized.See Pricing Concepts for the difference between advertised and all-in rates.Example
Response fields
ID
Unique identifier for the plan.
String
Marketing name of the plan as displayed to customers.
String
Plain-text description of the plan’s key terms and features.
Float
Effective price in $/kWh calculated at the requested
monthlyUsage. Uses seasonalized pricing by default; pass priceType: "FLAT" to price at the exact usage with no seasonal adjustment.Int
Contract length in months.
Int
Percentage of energy sourced from renewable generation, from
0 to 100.RateType
Indicates whether the plan has a
FIXED, VARIABLE, or INDEXED rate structure.Boolean
true if the plan applies different rates depending on the time of day energy is consumed.Boolean
true if the plan’s pricing structure includes bill credits at certain usage thresholds.Boolean
true if the supplier has designated this plan as pet-friendly (no deposit required for customers with pets, per supplier policy).String
Hosted enrollment hand-off URL, pre-stamped with your partner code. Direct customers here to complete sign-up on the PowerHQ-hosted flow.
String
Embeddable enrollment hand-off URL, pre-stamped with your partner code. Use this URL inside an iframe or webview to embed the enrollment flow directly in your product.
Boolean
true if the customer incurs a penalty for cancelling the contract before the term ends.Float
Early termination fee amount in USD.
null when no fee applies or the fee is not a fixed dollar amount.EarlyTerminationFeeType
Describes how the early termination fee is calculated (e.g., flat fee, per-month remaining).
null when no fee applies.Date
Earliest date on which service can begin.
null if no minimum is enforced.Date
Latest date on which service can begin.
null if no maximum is enforced.String
TDU (Transmission and Distribution Utility) code for the service territory.
null when not applicable.String
Two-letter U.S. state code for the plan’s service territory.
null when not resolved.DateTime
Timestamp when the plan was first added to the PowerHQ catalog.
null for legacy plans created before timestamp tracking was introduced.Supplier
The retail electricity supplier offering this plan.
PlanRate[]
Rate breakdowns at standard usage levels (500, 1000, and 2000 kWh/month). Each entry contains both the advertised rate and the all-in rate so you can display accurate cost comparisons.
SupplierScores
Supplier reputation scores sourced independently from plan pricing. This field is nullable — it is
null when score data is unavailable for a supplier.PlanFee[]
List of individual fees that make up the plan’s cost structure. Every residential plan includes an
ENERGY_CHARGE entry, the supplier’s raw energy charge in $/kWh, alongside the TDU delivery charges, bill credits and usage fees that apply to that plan. See Fee breakdown.feeBreakdown may be an empty array if no itemized fees are available. Individual fee entries may include a rules array that is also empty.PlanDocument[]
Regulatory and informational documents associated with the plan, such as the Electricity Facts Label (EFL) and Terms of Service.
documents may be an empty array. Always check the array length before attempting to display document links.PlanTag[]
Plan features and promotions, keyed by an upper-snake-case identifier. Observed keys on production
include
SATISFACTION_GUARANTEE, AUTO_PAY and RATE_DISCOUNT. See PlanTag.tags is frequently an empty array — most plans carry none, and outside Texas the array is
usually empty altogether. Read the tag’s value for the human-readable description; label is
currently null on production plans.