checkout.* events
The checkout ledger's two moments.
The checkout ledger's two moments. Every checkout a member starts, on the portal or in a connector's bot, on any rail, is written down the moment the gateway's page or invoice is handed over (payment.pending announces the start); the hourly sweep counts it as stalled once the project's window has passed with no settled charge and no live membership, and the next charge that settles for the member completes it. These two events are the stall and the recovery; the start is payment.pending.
Background
Guarantees
- A member is counted as stalled at most once a day, however many times they tapped Pay: later open starts inside that day are stamped quietly and raise nothing.
- A member who holds a live membership by the time the window passes paid through another door; their open checkouts close quietly and raise nothing.
checkout.recoveredfires once per stalled checkout, on the first charge that settles for the member afterwards. Checkouts that never stalled close on that charge too, silently.- The window is the project's
checkout_stall_hourssetting (1 to 24 hours, 1 by default), read at the sweep; a change applies to the checkouts still open.
Required ability
Tokens subscribing to checkout.* events must carry project-subscription:view at mint time, the ability the payment and subscription families need.
Events
checkout.stalledA checkout stayed open past the project's window.checkout.recoveredA charge settled for a member whose checkout had stalled.Related
payment.* eventspayment.pending is the start of every checkout, and payment.succeeded the charge that completes one.sequence.* eventsThe passage a stall opens (sequence.enrolled with trigger stalled_checkout) and how it ends (sequence.converted).subscription.* eventsThe membership a recovered checkout became.
How is this guide?
Last updated on