List off session charges
Money taken from a customer’s SAVED payment method with nobody present: the settlement behind an order edit that raised a total, an exchange that cost more, and a post-purchase upsell. Newest first. ONE LIST COVERS THE WHOLE WORKLIST. The dashboard has a second endpoint for the dunning queue; here that is ?retry_due=true, which selects failed charges whose next retry has come due. A client cannot derive that set itself, because the comparison is against the server’s clock. READ status AND next_retry_at TOGETHER. failed does not mean abandoned: a failed charge carrying a next_retry_at is still on the schedule (1h, 6h, 24h, then 72h), and one carrying null has exhausted it and will never be attempted again. idempotency_key is the only link back to the operation that caused the charge, because the row carries no order id at all. It is written by the platform and names the producer and the object it settles. THIS FAMILY IS READ ONLY and there is no write half to add later. Retrying a charge presents a real person’s stored card to the processor again, with no cart, no checkout and nobody present, and the retry schedule exists because issuers penalise rapid re-presentment of a decline. That decision stays with a human in the dashboard, and apiscope mints no write_off_session_charges at all. created_by and saved_payment_method_id are deliberately not published. The first is an unbounded actor stamp that would export staff identity, and the second is a handle onto a stored card mandate with no resource here to resolve it against.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Query Parameters
The charge state. A value outside this set is a 400 rather than an ignored filter, because an unrecognised status matches no row and a reconciliation job would read its own typo as a clean ledger off a 200.
pending, succeeded, failed One shopper's off-session charges. NOT validated against the customer table: an id that names nobody returns an empty page rather than a 404, because a customer who has never been charged off-session gives the same empty answer.
true selects failed charges whose next dunning retry has come due, which is the worklist the platform is about to act on. Omit it to list every charge; false is a 400 rather than a no-op, because it reads two ways (never failed, or failed with the retry still ahead) and answering either silently would be the wrong answer with no way for a client to tell.
true Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.
1 <= x <= 100The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.