API Reference

This endpoint returns a comprehensive list of input fields necessary for user data collection in the retail electricity enrollment process.

Key features include:

  1. Input Fields: Provides all required and optional fields for the enrollment form.
  2. Validation Rules: Each field includes appropriate validation rules in regex format.
  3. Field Options: Some fields come with supported options and their corresponding labels.
  4. Conditional Fields: Certain fields are required based on dependent keys and values.
  5. Agreement Fields: Includes necessary text and agreement fields for terms of service.
  6. Service Types & Dates: Includes supported service types (switch, forward switch, move, priority move) with corresponding available dates. (For Texas only)
  7. Utility Validations:
  • For Non-Texas: Specific validation rules for Utility Account Numbers (UAN)
  • For Texas: ESIID (Electric Service Identifier) validation rules
  1. Optional Fields: Includes fields for deposit, autopay, and deposit with autopay scenarios.
    These are particularly useful for validating card details when the enrollment requires
    deposit, autopay, deposit with autopay or deposit waiver based on credit-check response.

Payment Metrix:

SupplierDeposit OptionsAutopay OptionsDepositAutopay Options
Payless Powercredit cardcredit cardcredit card
Chariot Energycredit card/deposit waiver
4Change Energycredit cardcredit cardcredit card
Veteran Energycredit cardcredit cardcredit card
Express Energycredit cardcredit cardcredit card

The API requires a plan_id as input, which should be selected from the "offers" endpoint.

Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!