Store Credit Events

Store credit events follow a collaborator’s balance in a custom currency. Siren keeps store credit in a ledger. Each entry adds to or takes from one collaborator’s balance in one currency, and the balance is the sum of the entries. These events span two domains: the ledger (Siren\Credits\Core\Events) and custom currencies (Siren\Configs\Core\Events). Store credit comes with Siren Essentials and up, so Siren Lite raises none of them. Store Credit and Custom Currencies covers the feature from the dashboard.

Ledger entries

Every change to a balance writes one ledger entry and fires one event. The entry’s source type says why the balance changed.

CreditIssued fires after Siren writes an entry that adds credit: a payout paid as store credit, a refund that gives back credit an order spent, or an Admin raising a balance.

CreditRedeemed fires after Siren writes an entry that takes credit away: credit an order spent at checkout, or an Admin lowering a balance.

Custom currencies

Store credit is always held in a custom currency, so a currency’s events matter to anything that tracks balances.

CustomCurrencyCreated fires when an Admin creates a custom currency, or when applying a recipe creates one.

CustomCurrencyDeleted fires after an Admin deletes a custom currency, and says whether they chose to erase its balances.

Spending credit at checkout

Credit spent at checkout reaches the ledger through OrderDiscountsDetected, the commerce event a store’s integration fires when an order that used credit completes. Siren takes the credit from the collaborator’s balance, which fires CreditRedeemed. OrderDiscountsReversed gives it back when the order is refunded, or cancelled where the platform has that status, which fires CreditIssued.

A checkout also relies on three extension points that have no page of their own. CreditCouponStrategyRegistryInitiated (credit_coupon_strategy_registry_initiated) lets an integration register its credit coupon strategy with addStrategy(). The strategy makes, applies, and deletes the store’s credit coupons. CheckoutSessionLocatorRegistryInitiated (checkout_session_locator_registry_initiated) lets it register a checkout session locator with addLocator(), and deleteLocator() takes one out. The locator keeps a token for each checkout, so Siren can hold the credit a shopper applied until their order settles. CreditAutoApplyRequested (credit_auto_apply_requested) is the event an integration fires when the cart or checkout loads. It carries getUserId() and getPlatform(), and Siren answers by applying the shopper’s credit coupons and holding their credit. Commerce Events shows how an integration wires all of this together.

CreditPrimitiveCreated and CreditAliasDeleted are internal events for Siren’s record of credit coupon codes. No shipping integration uses them, so this reference leaves them out.

On Siren Cloud, your code can’t listen for these events directly. Each one reaches it as a webhook: credit.issued, credit.redeemed, currency.created, and currency.deleted.