VPP quickstart

Start from a working tariff integration: a user, a location with a connected tariff, and a device. If the location has no tariff, Connect asks the user to connect one first.

Prepare the device

Add the hardware identity and capabilities with update a device.

hardware.hardware_id: the serial number, or the VIN for a vehicle.
capabilities: one block per subsystem, such as battery, inverter, evse or vehicle.

Request example

curl --request PATCH \
  --url https://energy-api.flatpeak.com/devices/dev_9c1f70a4e2b6485db3f0c8a1 \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hardware": {
    "hardware_id": "PU2426A103557",
    "manufacturer": "Nova Systems",
    "model_code": "PICOXN2",
    "model_name": "Pico Ultimate"
  },
  "capabilities": {
    "battery": {
      "capacity_kwh": 14.2,
      "power_kw": 7.2
    }
  }
}'

Switch VPP on

Switch VPP on for your account in Console > Settings; Connect offers no program until it is on. The switch sets the default for vpp_enabled on every device.The test VPP programs ignore the switch, so build with them first.To opt one device in or out, set its vpp_enabled:

Request example

curl --request PATCH \
  --url https://energy-api.flatpeak.com/devices/dev_9c1f70a4e2b6485db3f0c8a1 \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vpp_enabled": true
}'

Launch Connect

Create a Connect session for the device. Sessions are single-use and expire after 48 hours.

curl --request POST \
  --url https://energy-api.flatpeak.com/connect-sessions \
  --header 'Authorization: Bearer <bearer_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "device_id": "dev_9c1f70a4e2b6485db3f0c8a1",
  "connect_url": "https://busbar.connect-web.flatpeak.com",
  "callback_url": "myapp://flatpeak/complete"
}'

{
  "id": "cos_6a40d6e74440857d4e098d96",
  "object": "connect_session",
  "live_mode": true,
  "time_created": "2026-06-15T10:00:00Z",
  "time_expiry": "2026-06-17T10:00:00Z"
}

Open Connect with flow set to VPP:

https://busbar.connect-web.flatpeak.com/?connect_session=cos_6a40d6e74440857d4e098d96&flow=VPP

The user selects a program, consents and enrolls, and Connect then returns to your callback_url.

The Connect VPP flow: program selection, consent and enrollment — Connect VPP flow

With a test-mode secret key and an Antarctic Energy tariff, Connect offers the test VPP programs.

Get started

Tariffs

VPP

Platform

Prepare the device

Switch VPP on

Launch Connect

Next steps

Enrollment

Dispatch