CustomCurrencyDeleted

CustomCurrencyDeleted fires after an Admin deletes a custom currency. Before it fires, Siren sets every program that pays in the currency and isn’t already inactive to inactive, and deletes the currency’s record. Siren refuses the delete while rewards or payouts are written in the currency, and while collaborators hold credit in it unless the Admin chooses to erase those balances.

The event is identified as custom_currency_deleted and lives in Siren\Configs\Core\Events\CustomCurrencyDeleted.

What does this event carry?

The currency’s record is gone by the time the event fires, so the event carries its code and the Admin’s choice.

• getCurrencyCode() is the deleted currency’s code, such as STORE_CREDIT.
• shouldWipeLedger() is true when the Admin chose to erase the currency’s balances.

use Siren\Configs\Core\Events\CustomCurrencyDeleted;

public function handle(Event $event): void
{
    $code = $event->getCurrencyCode();

    if ($event->shouldWipeLedger()) {
        // The currency's balances are being erased too.
    }
}

How does Siren react?

Siren’s own listeners stop paying the currency’s payouts as store credit, delete its credit coupons from every store whose integration registered a credit coupon strategy, and remove its codes from Siren’s coupon records. When shouldWipeLedger() is true, Siren also deletes every ledger entry in the currency.

When would you use it?

Use it to remove the currency from another system that shows balances, or to clean up anything your own integration made for it. On Siren Cloud, this event sends the currency.deleted webhook.

On a WordPress site connected to Siren Cloud, each currency.deleted delivery from Siren Cloud arrives on the site as CustomCurrencyDeleted, with shouldWipeLedger() false. Siren Cloud doesn’t say whether it erased its balances, and the site never erases its own on Siren Cloud’s word.

See the Store Credit Events overview for the rest of the store credit events.