businessEnrollmentUrl query returns an enrollment link for a single commercial plan, stamped with your partner code and carrying whatever context you supply. It works the same way as residentialEnrollmentUrl, with the additional fields a commercial enrollment requires.
Parameters
String
required
The
id of the plan the customer selected, taken from a businessPlans result. Plan ids regenerate when the catalog refreshes, so build the link at the moment the customer chooses a plan.String
required
The five-digit ZIP code of the service location.
Boolean
required
Set to
true when the business is establishing service at a new location, and false when it is switching providers at an address that already has active service. This argument is required here and has no residential equivalent, because a commercial enrollment must declare which case it is.Float
The customer’s annual consumption in kWh. Checkout prices the plan at this usage rather than falling back to its own estimate.
String
The legal name of the business enrolling.
String
The signer’s role at the business, for example
"Owner".EnrollmentCustomerInput
The signer’s contact details, as
firstName, lastName, email and phone. Each field you supply prefills the matching field in the enrollment form.String
The business’s ESID or utility account number, taken from an
utilityAccounts result. See Prefilling the service address.Date
The requested service start date, in
YYYY-MM-DD format. Call nextStartDate first to find the earliest valid date.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
bname, position and is_move_in, alongside the same customer and usage values a residential link carries.
Response fields
String
A link to the full-page, PowerHQ-hosted enrollment flow, with its own header and footer.
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.