Skip to navigation
API ReferenceOutcomesOutcome charges

Confirm an outcome charge early

Confirms a pending charge before its confirmation window closes, for example when the end customer marks the conversation resolved. The reversal horizon starts now. Only pending charges can be confirmed this way.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

outcome_charge_idstringRequired

The outcome charge ID (oc_...).

Request

This endpoint expects an object.
notestringOptional<=500 characters
Why it was confirmed early. Kept in the status history.

Response

The confirmed charge.
idstring
object"outcome_charge"
customerstring
outcome_definitionstring
outcome_definition_versioninteger
The version whose criteria, clocks and rules govern this charge.
statusenum

pending: inside the confirmation window and not billed. disputed: a dispute is open. confirmed: billed, and reversible until reversible_until. locked: final. reversed: given back. A charge with an open dispute stays disputed and doesn’t lock, even after its horizon passes, until the dispute is decided.

Allowed values:
amountstring

Decimal string. Credits for prepaid plans; minor units for postpaid plans.

eventstring
The event that created the charge.
confirmation_due_atdatetime
When the charge confirms if nothing happens first.
status_transitionslist of objects
Every status change, oldest first, with what caused it.
livemodeboolean
created_atdatetime
credit_typestringOptional
currencystringOptional
referencestringOptional
agent_idstringOptional
member_idstringOptional
team_idstringOptional
run_idstringOptional
evidenceobjectOptional

What shows an outcome happened, stamped on the outcome charge. Keep it short and factual; it is shown to people deciding disputes. Free text is sanitized before it reaches dashboards or agent tools.

confirmed_atdatetimeOptional
reversible_untildatetimeOptional
When the reversal horizon ends. Set once the charge confirms.
locked_atdatetimeOptional
lock_reasonenumOptional

Why the charge locked. reversal_horizon: the horizon passed. dispute_upheld: a dispute held the lock past the horizon and was decided uphold, which is shown as “locked after dispute”. Only when locked.

Allowed values:
reversed_atdatetimeOptional
reversalstringOptional
disputestringOptional
The most recent dispute.
open_disputeobjectOptional
Only while a dispute is open. States whether it is holding the lock.
invoicestringOptional
Postpaid only. The invoice the charge was billed on.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error