> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Submit a dispatch plan > Submits a plan, replacing any plan over the same period. Plans are for managed tariffs: the device must have an `ACTIVE` enrollment in one of your managed programs, or the call returns `422` `plan_not_allowed`. Every interval is binding on the OEM. Cap: 12 plans per device per hour, then `429` `plan_rate_limited` with `retry_after` in seconds. Pass `reference_id` to make a retry safe: resubmitting the same value returns the stored plan. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json POST /devices/{device_id}/plans openapi: 3.0.3 info: description: >- The Flatpeak Fleet API. VPP operators use it to enroll, dispatch and settle OEM device fleets. ## Authentication Exchange your `account_id` and `secret_key` for a bearer token at `POST /auth/tokens` with basic auth. Send it as `Authorization: Bearer ` on every request. ## Base URL `https://fleet-api.flatpeak.com` ## Pagination Lists return `data`, `next_cursor` and `url`. Pass `next_cursor` as `cursor` until it is `null`. A cursor is opaque and bound to the endpoint and query parameters that issued it. ## Errors Every non-2xx response carries `object`, `type`, `code` and `message`. Branch on `code`. ## Money and energy Money is a decimal number paired with a `currency_code` (ISO 4217). Power is in kW and energy in kWh. Positive is import, negative is export. ## Live and test `live_mode` marks live or test data. version: 2027-01-01.busbar title: Flatpeak Fleet API termsOfService: https://flatpeak.com/legal contact: name: Technical Support email: support@flatpeak.com url: https://flatpeak.com/contact license: name: Apache 2.0 url: https://flatpeak.com/legal servers: - url: https://fleet-api.flatpeak.com security: - bearerAuth: [] tags: - name: Authentication description: >- Exchange your account credentials for a bearer token to authenticate API requests. - name: Connect description: >- Create and retrieve Connect sessions for onboarding customers through your own app. - name: OEMs description: List and retrieve the OEMs whose devices your fleet can reach. - name: Devices description: >- Retrieve, list and update the devices connected to your account, and read their consent history and shared settings. - name: Locations description: >- Read the location a device sits behind: its timezone, currency, metering and your devices there. - name: Dispatch description: Submit plans to devices on managed tariffs and read the dispatch timeline. - name: Telemetry description: Read device state, device meter records and location meter records. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Events description: Retrieve and list account events. - name: VPP Programs description: >- Define and manage VPP programs: the commercial terms devices enroll under, and their live state. - name: Groups description: >- Named collections of devices for bulk dispatch and aggregated reads. OEMs see them read-only as [groups](/energy-api/reference/groups/list) on the Energy API. - name: Zones description: >- Network areas resolved to devices by Flatpeak, for locational eligibility and grouping without handling addresses. - name: Exports description: >- Package settlement evidence, consent records and enrollment registers as downloadable files. - name: Rewards description: >- The reward ledger: entries accrue from delivery, you approve them, pay the customers and mark them paid. - name: VPP Enrollments description: Track and act on device enrollments across your programs. - name: VPP Events description: >- Commit market activations: create an event for a group, then read its state and its devices' results. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /devices/{device_id}/plans: parameters: - schema: type: string name: device_id in: path required: true description: Flatpeak Device ID. post: tags: - Dispatch summary: Submit a dispatch plan description: >- Submits a plan, replacing any plan over the same period. Plans are for managed tariffs: the device must have an `ACTIVE` enrollment in one of your managed programs, or the call returns `422` `plan_not_allowed`. Every interval is binding on the OEM. Cap: 12 plans per device per hour, then `429` `plan_rate_limited` with `retry_after` in seconds. Pass `reference_id` to make a retry safe: resubmitting the same value returns the stored plan. operationId: submit-device-plan parameters: [] requestBody: $ref: '#/components/requestBodies/DevicePlanSubmit' responses: '201': $ref: '#/components/responses/Plan' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: requestBodies: DevicePlanSubmit: content: application/json: schema: $ref: '#/components/schemas/DevicePlanCreate' required: true responses: '400': description: >- 400 Bad Request: the request was malformed or a required field is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: '401 Unauthorized: authentication credentials are missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: '403 Forbidden: you do not have permission to access this resource.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '404 Not Found: the requested resource does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- 422 Unprocessable Entity: the request is well-formed but cannot be processed, for example missing required data. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '429 Too Many Requests: the rate limit has been exceeded.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- 500 Internal Server Error: an unexpected error occurred. Safe to retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- 503 Service Unavailable: the service is temporarily down for maintenance. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' Plan: description: Plan response. content: application/json: schema: $ref: '#/components/schemas/Plan' example: id: pln_7e1c2b9a4d0f8a3b6c2e5d41 object: plan live_mode: true device_id: dev_63a6087272941ef077a8fd3e reference_id: d1f0c2a4-plan-2026-07-08T11:00 intervals: - start_time: '2026-07-13T20:14:00Z' end_time: '2026-07-13T22:00:00Z' power_kw: -4.3 - start_time: '2026-07-14T02:00:00Z' end_time: '2026-07-14T06:00:00Z' power_kw: 7.4 time_created: '2026-07-13T17:45:12Z' account_id: acc_6a5e504c3b98d0d6739b5f72 schemas: DevicePlanCreate: title: DevicePlanCreate type: object properties: reference_id: type: string description: >- Your reference for the submission. Resubmitting the same value returns the stored plan in place of a new one, so a retry is safe. example: d1f0c2a4-plan-2026-07-08T11:00 intervals: type: array description: Plan intervals, each with a signed `power_kw`. items: type: object properties: start_time: type: string format: date-time example: '2026-02-02T02:00:00Z' description: Time when the interval starts, in UTC. end_time: type: string example: '2026-02-02T04:30:00Z' description: Time when the interval ends, in UTC. format: date-time power_kw: type: number example: -4.3 description: >- Power, in kW. Positive is import, negative is export. Limits: `max_import_power_kw` and `max_export_power_kw` in the device's `dispatch_limits`. required: - start_time - end_time - power_kw required: - intervals description: >- A plan for a device enrolled in one of your managed tariff programs. Every interval is binding on the OEM. Market activations are committed separately, with [VPP events](/fleet-api/reference/vpp-events/create). Plan: title: Plan type: object description: >- 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. properties: id: type: string example: pln_7e1c2b9a4d0f8a3b6c2e5d41 pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ description: Flatpeak Plan ID. object: type: string example: plan description: Object type, `plan`. enum: - plan default: plan live_mode: type: boolean description: '`true` for live data, `false` for test data.' example: true device_id: type: string example: dev_63a6087272941ef077a8fd3e pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ description: Flatpeak Device ID the plan was submitted to. reference_id: type: string description: >- The `reference_id` the plan was submitted with. `null` when none was sent. example: d1f0c2a4-plan-2026-07-08T11:00 nullable: true intervals: type: array description: Plan intervals as submitted. items: type: object properties: start_time: type: string format: date-time example: '2026-07-13T20:14:00Z' description: Time when the interval starts, in UTC. end_time: type: string format: date-time example: '2026-07-13T22:00:00Z' description: Time when the interval ends, in UTC. power_kw: type: number example: -4.3 description: Power, in kW. Positive is import, negative is export. required: - start_time - end_time - power_kw time_created: type: string format: date-time example: '2026-07-13T17:45:12Z' description: Time when the object was created, in UTC. account_id: type: string example: acc_6a5e504c3b98d0d6739b5f72 pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$ description: Flatpeak Account ID of the operator that owns the plan. required: - id - object - live_mode - device_id - intervals - time_created - account_id Error: type: object description: Standard error envelope returned by every non-2xx response. required: - object - type - code - message properties: object: type: string enum: - error default: error description: Object type. type: type: string description: High-level error category. example: invalid_request code: type: string description: Machine-readable error code, safe to branch on. example: access_denied message: type: string description: Human-readable description of the error. example: The requested resource could not be found. context: type: string description: Optional originating context, for example `api.price_get`. example: api.price_get live_mode: type: boolean description: Whether the error occurred against live or test data. time_created: type: string format: date-time description: Time the error was generated (RFC 3339). example: '2026-01-01T00:00:00Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Authenticate with the `bearer_token` obtained from the [authentication](/fleet-api/reference/authentication) endpoint. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.