Skip to main content
GET
Retrieve a dispatch plan

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

plan_id
string
required

Flatpeak Plan ID.

Response

Plan response.

A plan submitted to a device enrolled in a managed tariff program. It replaces overlapping intervals of earlier plans, and every interval is binding on the OEM. Market activations are committed separately as VPP events.

id
string
required

Flatpeak Plan ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"pln_7e1c2b9a4d0f8a3b6c2e5d41"

object
enum<string>
default:plan
required

Object type, plan.

Available options:
plan
Example:

"plan"

live_mode
boolean
required

true for live data, false for test data.

Example:

true

device_id
string
required

Flatpeak Device ID the plan was submitted to.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"dev_63a6087272941ef077a8fd3e"

intervals
object[]
required

Plan intervals as submitted.

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-07-13T17:45:12Z"

account_id
string
required

Flatpeak Account ID of the operator that owns the plan.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_6a5e504c3b98d0d6739b5f72"

reference_id
string | null

The reference_id the plan was submitted with. null when none was sent.

Example:

"d1f0c2a4-plan-2026-07-08T11:00"