Create Commitment

Register a prepaid commitment an account draws down as it consumes. Unused balance forfeits, rolls over, or is invoiced as a shortfall — the contract decides.

POST/api/v1/billing/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/billing/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: CREATE_COMMITMENT" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "commitment_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "committed_amount": "string",
    "currency": "USD",
    "term_end": "2026-01-15T09:30:00Z",
    "term_start": "2026-01-15T09:30:00Z",
    "treatment": "FORFEIT"
  }'

Authorization

Minimum role: FinanceThe caller must hold this role or a higher one.
Multi-factor sign-in: Required. The access token must come from a session that completed multi-factor sign-in.
Action: CREATE_COMMITMENT

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be CREATE_COMMITMENT for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

account_iduuidRequired
No description yet.
commitment_iduuidRequired
No description yet.
committed_amountstringRequired
No description yet.
currencystringRequired
No description yet.
minimum length 3
maximum length 3
term_enddate-timeRequired
No description yet.
term_startdate-timeRequired
No description yet.
treatmentenumRequired
What happens to whatever is unused at term end. No default: the three treatments settle in three different directions.
Allowed values
- FORFEIT
- ROLLOVER
- TAKE_OR_PAY
FORFEIT
Unused balance is lost — the customer bought capacity, not units.
ROLLOVER
Unused balance carries into the next term.
TAKE_OR_PAY
The customer owes the difference between commitment and consumption.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send CREATE_COMMITMENT.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below finance, the session has not completed multi-factor sign-in, or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.