API Reference

This endpoint submits a deregulated electricity order to the chosen supplier. Before making this call, the GET /form endpoint should already have been called.
Input query parameters for this endpoint include the plan_id from the previous step, the user's IP address, and whether you'd like us to send a follow up email.
The request should also include a body containing the form as defined in the previous GET request.

Note: This API should use the enroll.wattbuy.com base URL rather than apis.wattbuy.com. It is also recommended that you use QA (qaenroll.wattbuy.com) for development.

This endpoint returns the code, status, sub status, agent, and metadata.

The metadata includes:

- Customer info fields
- WattBuy order_id for further reference
- reference_id from the supplier (if provided by the supplier)
- status_reason if the order fails
- deposit amount and payment link if a deposit is required

Order Status Metrix:

CodeStatusSub StatusDescription
S1SUBMITTEDApprovedThe enrollment has been successfully submitted to the supplier but service has not started
S2SUBMITTEDApproved with Deposit NeededThe enrollment has been successfully submitted to the supplier but a deposit is needed to turn on service
S3SUBMITTEDApproved with Deposit Waiver NeededThe enrollment has been successfully submitted to the supplier but a deposit waiver is needed to turn on service
F3FAILEDDeclinedThe enrollment has been declined by the supplier
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!