Skip to main content

benecaster_subscription_cadence_switch_cancelled

Action Premium

Fires when a pending self-service billing-period switch is withdrawn before it lands — the subscriber cancelled it themselves, it was dropped ahead of a membership cancellation or a license hard-cutoff billing pause, or it was released or cancelled outside the plugin (for example in the Stripe dashboard). No email is sent to the subscriber for a self-initiated cancellation; use this hook if you need to notify anyone else.

It also fires when a pending move to another tier is withdrawn, since tier moves and billing-period switches share one pending slot. To tell which it was, look up $to_price_id: a price on another tier was a tier move. Use it to undo anything you recorded on benecaster_subscription_tier_switch_scheduled.

Parameters

Name Type Default Description
$user_id int — WordPress user ID
$show_id int — ID of the show
$to_price_id int — The benecaster_membership_prices.id the subscriber would have switched to
$reason string — One of `subscriber` (taken back from the account page), `membership_cancelled` (cancelling the membership drops it first), `billing_paused` (the license hard-cutoff pause drops it first), or `stripe` (released or cancelled outside the plugin)

Need this built rather than just documented? See our services →