Admin APIs
block-s3-invoices

Override Applied Tokens

Changed on

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.

post/api/v1/admin/block/s3-invoices/override

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/block/s3-invoices/override
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Request body

client_idstring required
block_contract_idstring uuid required
period_seqinteger required
reasonstring required
idempotency_keystring nullable

Response

Successful Response

total_clientsinteger required

Changes