Create a VPP program

curl --request POST \
  --url https://fleet-api.flatpeak.com/vpp-programs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "Community Powershare",
  "description": "Earn from grid events while you keep your tariff.",
  "url": "https://pick.com/programs/community-powershare",
  "managed": false,
  "listed": true,
  "currency_code": "USD",
  "estimate": {
    "amount": 612,
    "period": "YEAR",
    "dispatch_events_per_month": 15
  },
  "terms": {
    "rewards": [
      {
        "basis": "FIXED",
        "rate": 15,
        "period": "QUARTER"
      },
      {
        "basis": "DELIVERED_KWH",
        "rate": 0.35
      }
    ],
    "opt_out_policy": "ALLOWED",
    "notice_days": 30
  },
  "eligibility": {
    "oem_ids": [
      "oem_6a3a8dada72cd0a249ff9528"
    ],
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "min_storage_capacity_kwh": 5,
    "min_export_power_kw": 3,
    "telemetry_requirements": {
      "state_interval_seconds": 300,
      "device_meter_interval_seconds": 900
    }
  },
  "enrollment": {
    "join_days": 10,
    "approval_required": false,
    "dispatch_test_required": true
  }
}
'

{
  "id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
  "object": "vpp_program",
  "live_mode": true,
  "display_name": "Community Powershare",
  "description": "Earn from grid events while you keep your tariff.",
  "url": "https://pick.com/programs/community-powershare",
  "managed": false,
  "listed": true,
  "currency_code": "USD",
  "estimate": {
    "amount": 612,
    "period": "YEAR",
    "dispatch_events_per_month": 15
  },
  "terms": {
    "rewards": [
      {
        "basis": "FIXED",
        "rate": 15,
        "period": "QUARTER"
      },
      {
        "basis": "DELIVERED_KWH",
        "rate": 0.35
      }
    ],
    "opt_out_policy": "ALLOWED",
    "notice_days": 30
  },
  "eligibility": {
    "oem_ids": [
      "oem_6a3a8dada72cd0a249ff9528"
    ],
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "zone_id": null,
    "min_storage_capacity_kwh": 5,
    "min_export_power_kw": 3,
    "telemetry_requirements": {
      "state_interval_seconds": 300,
      "device_meter_interval_seconds": 900
    }
  },
  "enrollment": {
    "join_days": 10,
    "approval_required": false,
    "dispatch_test_required": true,
    "signup_url": null
  },
  "status": "LIVE",
  "rejection_reason": null,
  "time_created": "2026-08-12T09:30:00Z",
  "account_id": "acc_6a5e504c3b98d0d6739b5f72"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

POST

vpp-programs

curl --request POST \
  --url https://fleet-api.flatpeak.com/vpp-programs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "Community Powershare",
  "description": "Earn from grid events while you keep your tariff.",
  "url": "https://pick.com/programs/community-powershare",
  "managed": false,
  "listed": true,
  "currency_code": "USD",
  "estimate": {
    "amount": 612,
    "period": "YEAR",
    "dispatch_events_per_month": 15
  },
  "terms": {
    "rewards": [
      {
        "basis": "FIXED",
        "rate": 15,
        "period": "QUARTER"
      },
      {
        "basis": "DELIVERED_KWH",
        "rate": 0.35
      }
    ],
    "opt_out_policy": "ALLOWED",
    "notice_days": 30
  },
  "eligibility": {
    "oem_ids": [
      "oem_6a3a8dada72cd0a249ff9528"
    ],
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "min_storage_capacity_kwh": 5,
    "min_export_power_kw": 3,
    "telemetry_requirements": {
      "state_interval_seconds": 300,
      "device_meter_interval_seconds": 900
    }
  },
  "enrollment": {
    "join_days": 10,
    "approval_required": false,
    "dispatch_test_required": true
  }
}
'

{
  "id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
  "object": "vpp_program",
  "live_mode": true,
  "display_name": "Community Powershare",
  "description": "Earn from grid events while you keep your tariff.",
  "url": "https://pick.com/programs/community-powershare",
  "managed": false,
  "listed": true,
  "currency_code": "USD",
  "estimate": {
    "amount": 612,
    "period": "YEAR",
    "dispatch_events_per_month": 15
  },
  "terms": {
    "rewards": [
      {
        "basis": "FIXED",
        "rate": 15,
        "period": "QUARTER"
      },
      {
        "basis": "DELIVERED_KWH",
        "rate": 0.35
      }
    ],
    "opt_out_policy": "ALLOWED",
    "notice_days": 30
  },
  "eligibility": {
    "oem_ids": [
      "oem_6a3a8dada72cd0a249ff9528"
    ],
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "zone_id": null,
    "min_storage_capacity_kwh": 5,
    "min_export_power_kw": 3,
    "telemetry_requirements": {
      "state_interval_seconds": 300,
      "device_meter_interval_seconds": 900
    }
  },
  "enrollment": {
    "join_days": 10,
    "approval_required": false,
    "dispatch_test_required": true,
    "signup_url": null
  },
  "status": "LIVE",
  "rejection_reason": null,
  "time_created": "2026-08-12T09:30:00Z",
  "account_id": "acc_6a5e504c3b98d0d6739b5f72"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

Authenticate with the bearer_token obtained from the authentication endpoint.

Body

application/json

Program payload.

Program create payload.

display_name

string

required

Program name shown to customers.

Example:

"Community Powershare"

currency_code

string

required

Currency of every amount on the program, as an ISO 4217 code: estimate.amount and each rate in terms.rewards. Must match the market currency of the devices the program targets. Required, and set once: it cannot be changed after create.

Example:

"USD"

estimate

object

required

What the customer is told to expect before they join. It is a projection and never binding. The copy follows managed: bill savings for a managed tariff, earnings otherwise.

Show child attributes

description

string

Short description shown to customers at enrollment.

Example:

"Earn from grid events while you keep your tariff."

url

string | null

Public page with program details.

Example:

"https://pick.com/programs/community-powershare"

managed

boolean

default:false

true for a managed tariff: you run the device under this program with plans, and it replaces the customer's tariff. Plans are accepted only for devices enrolled in a managed program. Any number of programs can be managed.

Example:

false

listed

boolean

default:true

true to offer the program in OEM apps to eligible devices. Listing requires OEM approval, tracked by status. A program that is not listed goes LIVE without approval and is reachable only from your own app with program_id on the Connect session.

Example:

true

terms

object

What binds you and the customer once they have joined: what you pay, whether they may skip events, and how long leaving takes. The enrollment keeps a copy of the terms it joined with, so a change applies only to later enrollments.

Show child attributes

eligibility

object

Which devices can join the program.

Show child attributes

enrollment

object

How a device gets in.

Show child attributes

Response

Program response.

A program you define: a VPP program, or a managed tariff when managed is true. Customers enroll in your app, or in their OEM's app once the program is listed and the OEM approves it. Enrolled devices arrive through Connect and fire device.connect.

string

required

Flatpeak Program ID.

Example:

"vpr_5c8d1f2a7b3e4d6c9a0f1b2c"

object

enum<string>

required

Object type, vpp_program.

Available options:

vpp_program

Example:

"vpp_program"

live_mode

boolean

required

true for live data, false for test data.

Example:

true

display_name

string

required

Program name shown to customers.

Example:

"Community Powershare"

managed

boolean

default:false

required

Example:

false

listed

boolean

default:true

required

Example:

true

currency_code

string

required

Example:

"USD"

estimate

object

required

What the customer is told to expect before they join. It is a projection and never binding. The copy follows managed: bill savings for a managed tariff, earnings otherwise.

Show child attributes

terms

object

required

Show child attributes

eligibility

object

required

Which devices can join the program.

Show child attributes

enrollment

object

required

How a device gets in.

Show child attributes

status

enum<string>

required

Only LIVE programs are shown to customers. Approval applies to listed programs; an unlisted program goes LIVE on request. Changes fire program.update.

Value	Meaning
`DRAFT`	Private
`PENDING_APPROVAL`	`LIVE` requested, under review by the OEMs in `eligibility`
`LIVE`	Published
`REJECTED`	An OEM declined; see `rejection_reason`
`PAUSED`	No new enrollments

Available options:

DRAFT,

PENDING_APPROVAL,

LIVE,

PAUSED,

REJECTED

Example:

"LIVE"

time_created

string<date-time>

required

Time when the object was created, in UTC.

Example:

"2026-08-12T09:30:00Z"

account_id

string

required

Flatpeak Account ID of the operator that owns the program.

Example:

"acc_649d465ede6a785d2fa5f905"

description

string

Short description shown to customers at enrollment.

Example:

"Earn from grid events while you keep your tariff."

url

string | null

Public page with program details.

Example:

"https://pick.com/programs/community-powershare"

rejection_reason

string | null

read-only

Why the OEM rejected the program. Set when status is REJECTED.

Example:

"Estimated earnings are not supported by the reward terms."

Platform

Enroll customers

Dispatch devices

Organize the fleet

Settle and reward

Create a VPP program

Authorizations

Body

Response