Revenue Recovery API

Revenue Recovery is what a project does when a renewal fails, when a member cancels, and after a member leaves. A failed renewal keeps the member's access for a grace window the creator sets (0 to 30 days, 7 by default) while the gateway retries, with a notice at the failure, a reminder on day three, a final warning on the last day and one more when access pauses, each carrying the rail's own way to pay again; the first charge that settles restores access and counts as a recovery. A member who cancels is asked why and, where the owner's plan includes the offers, shown one offer for their rail: a pause for one billing cycle, a discount on the renewals, or a coupon to come back with. After they leave, a win-back sequence can reach them on the days the creator chose; those live under their own tag, Win-back Sequences.

The settings, the figures and the two ledgers live under /v1/projects/{project}/retention. A project holds one row of settings, created on the first read, so the resource is addressed by the project alone.

The notices, the grace window and the cancellation question are on every plan. The three offers and the sequences need Growth or the Revenue Recovery Addon; offers_available on the settings says whether this project has them. The offer settings are stored on every plan and ignored by the cancellation screen without the entitlement, so switching one on early is accepted and starts working the day the plan includes it.

EndpointsCopy Anchor Link

Related

Revenue RecoveryThe grace window, the notice ladder with the way back per rail, the cancellation screen and the sequences.subscription.* eventssubscription.payment_recovered, subscription.access_suspended, subscription.access_restored, subscription.cancellation_feedback and subscription.offer_taken announce what the ledger records.Win-back Sequences APIThe sequences, their steps and the passages members make through them.Subscriptions APIA subscription in grace or paused for non-payment keeps the past_due status while the gateway retries.Ability ReferenceThe settings and the ledgers sit behind project-subscription:*, because they are facts about a project's subscriptions.