---
title: "Override Applied Tokens"
method: POST
path: "/api/v1/admin/block/s3-invoices/override"
tags: ["Admin APIs", "block-s3-invoices"]
---

# Override Applied Tokens

`POST /api/v1/admin/block/s3-invoices/override`

Override what is applied to one upcoming invoice. ``amount=0`` clears it.

A ``reason`` is required — this changes a figure the client chose, so the row has to say
why. Rejected with 409 ``invoice_no_longer_editable`` once the credit line is on the
Stripe draft, since the amount can no longer change there.

## Request body

- S3OverrideRequest — Cole overriding what a client applied to one upcoming invoice. Unlike the client's own apply, this may target any period the contract will bill — an override exists precisely to reach an invoice the client's surface does not offer.
  - `client_id` string, required
  - `block_contract_id` string, uuid, required
  - `period_seq` integer, required
  - `amount` union, required
    - number
    - string
  - `reason` string, required
  - `idempotency_key` string, nullable

## Response `200`

Successful Response

- S3AdminUpcomingInvoicesResponse
  - `clients` S3AdminClientInvoices[], required
    - `client_id` string, uuid, required
    - `client_name` string, nullable
    - `available` string, required
    - `reserved` string, required
    - `remaining` string, required
    - `invoices` S3AdminInvoiceRow[], required
      - `block_contract_id` string, uuid, required
      - `block_request_id` string, uuid, nullable
      - `dataset_id` string, required
      - `dataset_label` string, nullable
      - `cut` string, nullable
      - `fee_type` string, nullable
      - `period_seq` integer, required
      - `period_start` string, date-time, nullable
      - `send_date` string, date-time, nullable
      - `edit_window_days` integer, nullable
      - `invoice_amount` string, required
      - `max_applicable_tokens` string, required
      - `applied_tokens` string, required
      - `net_due` string, required
      - `declined` boolean
      - `reservation_id` string, uuid, nullable
      - `applied_source` string, nullable
      - `applied_by` string, nullable
      - `editable` boolean
      - `auto_apply_enabled` boolean
      - `recurring_override_tokens` string, nullable
      - `auto_default_tokens` string
      - `block_invoice_draft_id` string, uuid, nullable
      - `review_state` string, nullable
      - `approval_overdue_at` string, date-time, nullable
  - `total_clients` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)