benecaster_buyup_cancelled
Fires when a subscriber’s buy-up is set to end at the end of their current billing period. It fires in two cases: the subscriber clicks Remove on it, or a tier upgrade moves them onto a tier that does not offer it. Both go through the same path, so it fires once either way.
The subscriber still has the buy-up when this fires, and keeps it until the period ends; nothing is refunded. Use it for a “your extra ends on…” message or to note the cancellation in a CRM. Do not revoke an external entitlement here — listen to benecaster_buyup_revoked, which fires when the buy-up actually ends, whatever ended it.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$user_id |
int |
— | WordPress user ID |
$buyup_id |
int |
— | ID of the buy-up record |
$show_id |
int |
— | ID of the show |
$stripe_subscription_item_id |
string |
— | Stripe subscription item ID for the cancelled buy-up |
Need this built rather than just documented? See our services →