CreditRedeemed

CreditRedeemed fires after Siren writes a ledger entry that takes store credit from a collaborator’s balance. Two things write one: an order that spent credit at checkout, and an Admin lowering a balance by hand.

The event is identified as credit_redeemed and lives in Siren\Credits\Core\Events\CreditRedeemed.

What does this event carry?

The event carries the CreditEntry Siren wrote. getEntry() returns it, with the same accessors as on CreditIssued.

• getCollaboratorId() says whose balance changed.
• getCurrency() is the custom currency’s code, such as STORE_CREDIT.
• getAmount() is a negative whole number at the currency’s scale.
• getSourceType() is redemption for an order and adjustment for an Admin’s change.
• getSourceId() is null for both.
• getDescription() names the order for a redemption, such as WooCommerce order #1042.
• getIdempotencyKey() is set for a redemption. Siren keys it on the collaborator, the currency, and the order, so the same order is never debited twice.

use Siren\Credits\Core\Events\CreditRedeemed;

public function handle(Event $event): void
{
    $entry = $event->getEntry();
    $spent = abs($entry->getAmount());
    $currency = $entry->getCurrency();
    $order = $entry->getDescription();
}

When does it fire for an order?

An order’s credit is taken after the order completes, not at checkout. The store’s integration fires OrderDiscountsDetected, and Siren queues a job that settles the order’s credit one collaborator at a time, so two checkouts can’t both spend the same balance. The job converts the discount to credit at the currency’s exchange rate and never takes more than the balance holds. When the discount was larger than the balance, the entry records only what was there, and Siren logs the shortfall.

When would you use it?

Use it to tell a collaborator they spent credit, or to keep a copy of their balance in step in another system. On Siren Cloud, this event sends the credit.redeemed webhook.

On a WordPress site connected to Siren Cloud, each credit.redeemed delivery from Siren Cloud arrives on the site as CreditRedeemed.

See the Store Credit Events overview for how the ledger events fit together.