residentialEnrollmentUrl query returns an enrollment link for a single residential plan, stamped with your partner code and carrying whatever customer context you supply. Use it instead of the plain enrollmentUrl on a plan when you already know something about the customer — their name, their service account, their usage — and you want checkout to open with those values already filled in.
Parameters
String
required
The
id of the plan the customer selected, taken from a residentialPlans result. Plan ids regenerate when the catalog refreshes, so build the link at the moment the customer chooses a plan rather than storing it for later.String
required
The five-digit ZIP code of the service location.
String
The customer’s ESID or utility account number, taken from an
utilityAccounts result. This is the argument that attaches the service address to the enrollment — see Prefilling the service address.EnrollmentCustomerInput
The customer’s contact details, as
firstName, lastName, email and phone. Each field you supply prefills the matching field in the enrollment form. Send only the fields you actually hold.Long
The customer’s monthly consumption in kWh, if you already know it. Checkout prices the plan at this usage rather than falling back to its own estimate. Omit the argument and the link carries no usage values at all.
String
The pricing mode applied at checkout. Defaults to
"SEASONALIZED", the all-in rate accounting for how usage changes across the year, which is the same basis your plan cards use. Pass "FLAT" only when you deliberately want every month priced at the exact monthlyUsage you supplied, with no seasonal adjustment. See Pricing.Date
The requested service start date, in
YYYY-MM-DD format.EnrollmentAddressInput
The service address, as
street, street2, city and state. Accepted, but it does not attach the service address on its own — pass utilityAccountNumber for that.Example
prospect_id and state (resolved from utilityAccountNumber), fname, lname, email and phone (from customer), and annual_usage with usage_source=EXTERNAL (from monthlyUsage, multiplied by twelve).
Response fields
String
A link to the full-page, PowerHQ-hosted enrollment flow, with its own header and footer. Use this when you are redirecting the customer away from your site.
String
A link to the same flow without PowerHQ chrome, suitable for embedding in your own page or a webview. It carries identical parameters to
enrollmentUrl.Before presenting any enrollment URL, make sure the plan’s disclosure documents are visible to the customer. See Disclosure Documents.