Recovery Sequences API

A sequence is the ordered set of messages a member receives on the days the creator chose after one of four moments: each step waits a number of days after the one before (the first after the trigger, 0 for the next hourly run), says what the creator wrote with {name}, {project}, {coupon}, {discount} and {link} filled per member, carries the way to the plan as a button and, optionally, a coupon. A member enrols once per firing, never while they hold what the trigger counts as a conversion, and leaves the sequence the moment a charge settles for them, which counts as a win on a churn sequence and a conversion on the others. Sequences live under a project at /v1/projects/{project}/sequences.

Sequences need Growth or the Revenue Recovery Addon. Building or changing one on a plan without them is refused as 422 VALIDATION_FAILED; a sequence that exists when the plan lapses keeps its rows and holds every due step until the plan includes sequences again.

Four triggers enrol a member: churned (their last live membership ended), lead (they arrived without buying), stalled_checkout (a checkout they started stayed open past the project's checkout window) and trial_ending (a trial without a card is about to end, the project's trial reminder before it; both windows are settings under Revenue Recovery). A sequence runs on one trigger; a member enters it once per firing, never while they hold what the trigger counts as a conversion, and leaves it the moment a charge settles for them. Every step carries a Stop command, and a member who pressed it stays out of every sequence until a charge settles for them or they switch the follow-ups back on in the portal.

EndpointsCopy Anchor Link

Related

Revenue Recovery APIThe settings, the figures and the two ledgers; a sequence step is a row of the activity ledger.sequence.* eventsThe seven events, from the sequence's own lifecycle to each passage's enrolment, steps, win and exit.Coupons APIA step's coupon is one of the project's own, and the member redeems it at checkout.Ability ReferenceHow project-sequence:* maps onto team roles.