action parameter set to VPP, instead of on the Landing page.
- Overview
- Settings
- Code


{
"connect_token": "cot_6587fa4362341be5b524de3b",
"route": "vpp_summary",
"timezone": "America/Denver",
"currency_code": "USD",
"live_mode": true,
"actions": [
"CONNECT_TARIFF",
"CHANGE_PERIOD",
"MANAGE_PAYMENTS",
"MANAGE_PARTICIPATION",
"BACK",
"CLOSE"
],
"tariff_connected": false,
"programme": {
"provider_id": "prv_8587fa49c7e5297ccc6c57e5",
"provider_display_name": "Leap",
"programme_id": "vpr_6a1f8e375db9de605baadd46",
"programme_display_name": "Community Powershare",
"learn_more_url": "https://leap.com/programmes/community-powershare",
"participation_state": "SUSPENDED",
},
"performance": {
"period_type": "MONTH",
"period_start": "2025-02-01",
"period_end": "2025-02-28",
"available_period_types": [
"DAY",
"MONTH",
"YEAR"
],
"has_previous": true,
"has_next": false,
"energy_dispatched_kwh": 54.7,
"earnings": 62.10,
"series": [
{
"date": "2025-02-01",
"dispatched_kwh": 5.15,
"earnings": 5.85
},
{
"date": "2025-02-02",
"dispatched_kwh": 2.57,
"earnings": 2.92
},
{
"date": "2025-02-03",
"dispatched_kwh": 4.6,
"earnings": 5.22
},
{
"date": "2025-02-04",
"dispatched_kwh": 2.98,
"earnings": 3.38
},
{
"date": "2025-02-07",
"dispatched_kwh": 3.52,
"earnings": 4.0
},
{
"date": "2025-02-08",
"dispatched_kwh": 3.52,
"earnings": 4.0
},
{
"date": "2025-02-09",
"dispatched_kwh": 5.55,
"earnings": 6.3
},
{
"date": "2025-02-15",
"dispatched_kwh": 4.74,
"earnings": 5.38
},
{
"date": "2025-02-16",
"dispatched_kwh": 7.85,
"earnings": 8.91
},
{
"date": "2025-02-22",
"dispatched_kwh": 5.42,
"earnings": 6.15
},
{
"date": "2025-02-26",
"dispatched_kwh": 3.93,
"earnings": 4.46
},
{
"date": "2025-02-28",
"dispatched_kwh": 4.87,
"earnings": 5.53
}
]
}
}
Actions
The following actions are supported when responding to Connect on this route:| Action | Result |
|---|---|
CONNECT_TARIFF | Routes customer to tariff connection flow. |
CHANGE_PERIOD | Change reporting period. |
MANAGE_PAYMENTS | Request payment management page. |
MANAGE_PARTICIPATION | Request manage VPP participation page. |
BACK | Returns previous page. If unavailable, returns callback_url. |
CLOSE | Returns callback_url you specified when creating the Connect token. |
Statuses
Possible values of theparticipation_state field:| State | Description |
|---|---|
NOT_ENROLLED | Never enrolled to the programme. |
ENROLLING | Enrolling in progress. |
ACTIVE | Enrolled and active. |
SUSPENDED | Enrolled but suspended. |
UNENROLLING | Unenrollment in progress. |
UNENROLLED | Unenrolled from programme. |
FAILED. | Failed to enrol to programme |
Errors
When you POST your response to Connect, the following validation errors may be returned:| Error Code | Error Description |
|---|---|
data_json_invalid | Data does not conform to the JSON schema. |

