> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Mark rewards paid > Records that you have paid the customer. Name the entries with `reward_ids`, which can be a single entry for a payment made on its own, or mark every `APPROVED` entry a `filter` matches. They move to `PAID` carrying your `payment_reference`. Entries already `PAID` are unchanged, so retries are safe. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json POST /rewards/mark-paid 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: /rewards/mark-paid: post: tags: - Rewards summary: Mark rewards paid description: >- Records that you have paid the customer. Name the entries with `reward_ids`, which can be a single entry for a payment made on its own, or mark every `APPROVED` entry a `filter` matches. They move to `PAID` carrying your `payment_reference`. Entries already `PAID` are unchanged, so retries are safe. operationId: mark-rewards-paid parameters: [] requestBody: $ref: '#/components/requestBodies/RewardMarkPaid' responses: '200': $ref: '#/components/responses/RewardBatchPaid' '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: RewardMarkPaid: required: true content: application/json: schema: $ref: '#/components/schemas/RewardMarkPaid' examples: One payment: summary: One payment value: reward_ids: - rwd_1a2b3c4d5e6f7a8b9c0d1e2f payment_reference: PAY-2026-09-000184 Several entries, one payment: summary: Several entries, one payment value: reward_ids: - rwd_1a2b3c4d5e6f7a8b9c0d1e2f - rwd_2b3c4d5e6f7a8b9c0d1e2f3a payment_reference: PAY-2026-09-000185 A program's month: summary: A program's month value: filter: program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c start_time: '2026-08-01T00:00:00Z' end_time: '2026-09-01T00:00:00Z' payment_reference: PAY-2026-09-BATCH description: Rewards you have paid. 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' RewardBatchPaid: description: Reward batch response. content: application/json: schema: $ref: '#/components/schemas/RewardBatch' example: object: reward_batch status: PAID count: 1 schemas: RewardMarkPaid: type: object title: RewardMarkPaid additionalProperties: false description: Rewards you have paid. Provide exactly one of `reward_ids` or `filter`. properties: reward_ids: type: array items: type: string minItems: 1 description: Reward entry IDs to mark paid. Each must be `APPROVED`. example: - rwd_6a1f8e375db9de605baadd46 filter: type: object additionalProperties: false minProperties: 1 description: >- Mark every `APPROVED` entry this matches as paid, in one call. Selects entries the same way the filters on [list all rewards](/fleet-api/reference/rewards/list) do. Give at least one field. properties: program_id: type: string description: Only entries accrued under this program. example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c device_id: type: string description: Only this device's entries. example: dev_63a6087272941ef077a8fd3e start_time: type: string format: date-time description: Start of the period, in UTC. example: '2026-08-01T00:00:00Z' end_time: type: string format: date-time description: End of the period, in UTC. example: '2026-09-01T00:00:00Z' example: program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c start_time: '2026-08-01T00:00:00Z' end_time: '2026-09-01T00:00:00Z' payment_reference: type: string description: >- Your reference for the payment, stored on each entry the call marks paid. For payments made one at a time, call once per payment with that payment's entry and reference. example: PAY-2026-09-000184 RewardBatch: type: object title: RewardBatch additionalProperties: false description: The result of approving rewards or marking them paid. required: - object - status - count properties: object: type: string description: Object type, `reward_batch`. example: reward_batch enum: - reward_batch status: type: string enum: - APPROVED - PAID description: The status the entries were moved to. example: PAID count: type: integer minimum: 0 description: >- Number of entries this call changed. Entries that were already in this status, or past it, are not counted. example: 1840 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.