Skip to navigation
API ReferenceOutcomesOutcome charges

List outcome charges

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.

Query parameters

customer_idstringOptional
Only objects belonging to this customer.
statusenumOptional
Only charges with this status.
Allowed values:
outcome_definitionstringOptional

Only charges for this outcome definition (ID or key).

referencestringOptional
Only charges with this reference.
invoicestringOptional
Only charges billed on this invoice.
confirmation_due_beforedatetimeOptional
Only pending charges that confirm before this time. Shows what is about to confirm.
reversible_until_beforedatetimeOptional
Only confirmed charges whose reversal horizon ends before this time. Shows what is about to lock.
sortenumOptionalDefaults to created_at

Order the page by this field. confirmation_due_at and reversible_until put the soonest first; created_at, the default, puts the newest first.

Allowed values:
test_clockstringOptional
Sandbox only. Only charges for customers on this test clock.
created_afterdatetimeOptional
Only objects created at or after this time.
created_beforedatetimeOptional
Only objects created before this time.
limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

includeenumOptional

Send total_count to add total_count to the list: how many objects match the filters across every page. The count is capped, and total_count_approximate: true says when the real number is higher. It is slower than a plain list, so ask for it when you show a number.

Allowed values:

Response

A page of outcome charges.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional
total_countintegerOptional

Only with include=total_count. How many objects match the filters.

total_count_approximatebooleanOptional

Only with include=total_count. True when the count was capped and the real number is higher.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error