User APIs
ledger-platform

Apply S3 Tokens

Changed on

Apply tokens to one upcoming invoice.

Synchronous on purpose: the client has to learn now that an invoice is no longer editable, rather than discovering later that their application silently did nothing.

Applying reserves the tokens; it writes no ledger transaction. The CONSUME lands only when the invoice finalizes, which is what makes editing and un-applying free.

Returns 409 invoice_no_longer_editable once the credit line is on the Stripe draft.

post/api/v1/ledger/s3/apply

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/ledger/s3/apply
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Request body

block_contract_idstring uuid required
period_seqinteger required
idempotency_keystring nullable

Response

Successful Response

reservation_idstring uuid required
block_contract_idstring uuid required
period_seqinteger required
applied_tokensstring required
invoice_amountstring required
net_duestring required
availablestring required
reservedstring required
remainingstring required

Changes