Skip to main content

Key concepts

The Light API revolves around several key entities that work together to enable seamless management of electricity services for consumers.

Entities​

Apps​

Each App corresponds to a single application or integration built on the Light platform. Apps have their own set of accounts, data, and configuration. Currently, Light support assists with the creation of Apps and provides the necessary credentials to access the Light API.

Accounts​

An Account represents a prospective or active electricity consumer. Creating an account requires minimal information such as an email address and name. Once an account is created, it can be used to enroll or manage the consumer's electricity service for one or more service locations.

Location​

A Location corresponds to a physical service address where an electricity consumer resides with one or more physical electricity meters managed by the local Transmission & Distribution Utility (TDU). The process of creating or attaching a Location to an Account is called "Enrollment." This process includes verifying eligibility, retrieving available plans, and accepting a plan offer.

Plans​

A Plan represents an electricity rate plan available to consumers. Plans include details such as energy rates, delivery rates, contract terms, and additional charges. Each plan comes with standard regulatory documents like the Electricity Facts Label (EFL), Terms of Service (TOS), and Your Rights as a Customer (YRAC).

Invoices and billing​

An Invoice represents the billing statement for electricity consumption over a specific period. Invoices ensure regulatory compliance and provide detailed billing information to consumers. The Light API offers endpoints to access itemized invoice details and download invoice documents.

API structure​

Light API organizes endpoints into groups to make it easier to interact with these entities. These groups include the following:

  • /app endpoints: Used for managing and interacting with Apps, including creating and managing accounts, generating tokens, and retrieving app-specific data.
  • /account endpoints: Used for managing individual consumer Accounts, including enrollment, billing, and service-related functionalities.
    • /account/enroll endpoints: Used for the enrollment process, including address search, retrieving available plans, and accepting a plan.
    • /account/billing endpoints: Used for billing-related tasks, such as retrieving invoices, updating payment methods, and managing billing addresses.
    • /account/locations endpoints: Used for managing Locations, including retrieving location details, accessing service documents, and managing service cancellation.