Retrieve an outcome charge

{
  "id": "oc_2xK9cL4vRt",
  "object": "string",
  "customer": "string",
  "outcome_definition": "string",
  "outcome_definition_version": 1,
  "status": "pending",
  "amount": "95",
  "event": "string",
  "confirmation_due_at": "2024-01-15T09:30:00Z",
  "status_transitions": [
    {
      "status": "pending",
      "at": "2024-01-15T09:30:00Z",
      "cause": "event",
      "cause_id": "string",
      "rule": "string"
    }
  ],
  "livemode": true,
  "created_at": "2024-01-15T09:30:00Z",
  "credit_type": "string",
  "currency": "usd",
  "reference": "conv_4821",
  "agent_id": "string",
  "member_id": "string",
  "team_id": "string",
  "run_id": "string",
  "evidence": {
    "description": "Customer confirmed the refund arrived and closed the chat.",
    "url": "https://app.example.com/conversations/conv_4821",
    "properties": {}
  },
  "confirmed_at": "2024-01-15T09:30:00Z",
  "reversible_until": "2024-01-15T09:30:00Z",
  "locked_at": "2024-01-15T09:30:00Z",
  "lock_reason": "reversal_horizon",
  "reversed_at": "2024-01-15T09:30:00Z",
  "reversal": "string",
  "dispute": "string",
  "open_dispute": {
    "id": "dsp_3sE6rT9yUi",
    "decide_by": "2024-01-15T09:30:00Z",
    "holds_lock": true
  },
  "invoice": "string"
}

Includes the charge's full status history, with the cause of each change.

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_...).

Response

The outcome 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

429

Too Many Requests Error

500

Internal Server Error