Artisan commands

credits:modify applies one credit change to every entity resolved by the credits.modifiable config, through Credits::for($entity) — so Credits::fake() records it. Register one or more resolver closures — each receives a $modify callback to call per entity:

// config/credits.php
use App\Models\User;

'modifiable' => [
    function (Closure $modify): void {
        User::query()->each(fn (User $user) => $modify($user));
    },
],

Then run it:

php artisan credits:modify --amount=10 --description="monthly bonus"
# Modified credits on 42 entities.

php artisan credits:modify --amount=50 --description="monthly bonus" --bucket=promotional
php artisan credits:modify --amount=-5 --description="correction" --allow-overdraft

• Each row the command writes carries meta ['info' => 'Credits modified by credits:modify command.'].
• Resolved entities that are not Creditable models are skipped with a warning rather than failing the run.
• An entity whose deduction the overdraft guard refuses is skipped too: the run carries on with the rest and prints a Refused line for each.
• Once every entity has been visited, the command reports how many were refused and exits non-zero.
• Each change is its own transaction, so the entities that were charged stay charged — re-run only for the refused ones (for example with a resolver that selects them), not the whole set.
• With no resolvers registered, the command succeeds and changes nothing.

php artisan credits:modify --amount=-50 --description="monthly fee"
# Refused App\Models\User #2: Insufficient credits: tried to deduct 50 but only 20 are available.
# Modified credits on 41 entities.
# Refused 1 entity with insufficient credits.
echo $?   # 1 — the run finished, but not every entity was charged

credits:reset

Resets buckets to a balance at most once per period for every owner with rows in them, or for the credits.modifiable owners with --resolvers — meant for the scheduler. Each owner goes through Credits::for($owner), so the fake records it:

See Periodic resets for scheduling examples, the period keys and what a refused owner does.

credits:expire-holds

Marks holds past their expiry as expired and fires CreditHoldExpired for each — the same sweep as Credits::expireHolds(). Schedule it every minute when holds are on:

php artisan credits:expire-holds
# Expired 3 holds.

php artisan credits:expire-holds --connection=tenant

Inspecting the configuration

The package contributes a section to Laravel’s about command:

php artisan about --only=credits