laravel-billing maintained by bhhaskin
Laravel Billing
Stripe-based subscription and billing management for Laravel applications.
Features
Subscription Management
- Multiple Plans & Add-ons - Support for base plans and both standalone and plan-dependent add-ons
- Stripe Integration - Full Stripe integration with idempotent webhook handling
- Proration - Configurable proration for plan changes and cancellations
- Plan Changes - Immediate and scheduled plan changes with upgrade/downgrade detection
- Trial Periods - Optional trial periods per plan
- Grace Periods - Configurable grace periods for failed payments
- Discount Codes - Percentage and fixed discounts with flexible durations
- Payment Method Expiry - Configurable warning window with
PaymentMethodExpiringevent and scheduled command
Financial Operations
- Integer-Cents Money - All amounts stored and computed as integer minor units (no float precision bugs)
- Refund System - Full and partial refunds with automatic credit creation
- Customer Credits - Complete credit/debit tracking with running balances and expiration support
- Usage-Based Billing - Track and bill for metered usage
- Quota Tracking - Track usage against limits with automatic warnings and exceeded events
Developer Experience
- Workspace Support - Optional multi-tenancy with bhhaskin/laravel-workspaces
- Audit Trail - Optional audit logging with bhhaskin/laravel-audit
- Fully Tested - Comprehensive test suite with 100+ tests
- UUIDs - All models include UUIDs for secure API endpoints
Installation
composer require bhhaskin/laravel-billing
Publish Configuration
php artisan vendor:publish --tag=billing-config
Publish and Run Migrations
php artisan vendor:publish --tag=billing-migrations
php artisan migrate
Configuration
Add your Stripe credentials to .env:
STRIPE_KEY=your_stripe_key
STRIPE_SECRET=your_stripe_secret
STRIPE_WEBHOOK_SECRET=your_webhook_secret
Money Handling
All monetary values are stored and exchanged as integer minor units (cents for USD, pence for GBP, etc.) — never as floats or decimals. This eliminates precision bugs and aligns with Stripe's API conventions.
// $19.99 in cents
$plan = Plan::create(['name' => 'Pro', 'price' => 1999, ...]);
// $50.00 refund
$invoice->refund(amount: 5000);
// $25.00 promotional credit
$user->customer->addCredit(amount: 2500, type: 'promotional');
For display, divide by 100 or use Number::currency($plan->price / 100, 'USD').
If you are upgrading from < 0.4.0, the migrate command converts existing decimal data automatically. See the CHANGELOG for the full upgrade guide.
Usage
Add Billable Trait to User Model
use Bhhaskin\Billing\Concerns\Billable;
class User extends Authenticatable
{
use Billable;
}
Create Plans
use Bhhaskin\Billing\Models\Plan;
$plan = Plan::create([
'name' => 'Professional',
'slug' => 'professional',
'price' => 1999, // $19.99 in cents
'interval' => 'monthly',
'features' => ['feature1', 'feature2'],
'limits' => ['websites' => 5, 'storage_gb' => 100],
]);
Subscribe Users
$user = User::find(1);
$plan = Plan::where('slug', 'professional')->first();
$subscription = $user->subscribe($plan);
Check Subscriptions
// Check if user has any active subscription
if ($user->hasActiveSubscription()) {
// ...
}
// Check if user is subscribed to specific plan
if ($user->subscribedToPlan($plan)) {
// ...
}
// Get combined limits from all subscriptions
$limits = $user->getCombinedLimits();
$websiteLimit = $user->getLimit('websites');
// Check if user has specific feature
if ($user->hasFeature('ssl_certificate')) {
// ...
}
Plan Changes
Change subscription plans immediately or schedule for later:
$subscription = $user->subscriptions()->first();
$newPlan = Plan::where('slug', 'enterprise')->first();
// Immediate plan change with proration
$subscription->changePlan($newPlan, [
'prorate' => true,
]);
// Schedule plan change for end of period
$subscription->changePlan($newPlan, [
'schedule' => true,
'schedule_for' => $subscription->current_period_end,
]);
// Preview plan change costs before applying
$preview = $subscription->previewPlanChange($newPlan);
// Returns: amount, proration_credit, upgrade_charge, is_upgrade, etc.
// Cancel scheduled plan change
$subscription->cancelScheduledPlanChange();
Customer Credits
Manage customer credit balances for refunds, promotions, and adjustments:
// Add credit to customer balance ($25.00 = 2500 cents)
$user->customer->addCredit(
amount: 2500,
type: 'promotional',
description: 'Holiday promotion credit',
options: ['expires_at' => now()->addMonths(3)]
);
// Get available credit balance (in cents)
$balance = $user->customer->getAvailableCredit();
// Credits are automatically applied to invoices
// Or manually apply credits to an invoice
$amountApplied = $user->customer->applyCreditsToInvoice($invoice);
// View credit history
$credits = $user->customer->credits()
->where('type', 'refund')
->get();
Refunds
Create full or partial refunds for paid invoices:
$invoice = $user->invoices()->where('status', 'paid')->first();
// Full refund (defaults to remaining refundable amount)
$refund = $invoice->refund();
// Partial refund ($10.00 = 1000 cents)
$refund = $invoice->refund(
amount: 1000,
reason: 'requested_by_customer',
description: 'Partial service credit'
);
// Check refund status
if ($refund->isSucceeded()) {
// Refund completed - customer credit created
}
// Get refund information
$totalRefunded = $invoice->getTotalRefunded();
$remainingRefundable = $invoice->getRemainingRefundable();
if ($invoice->isFullyRefunded()) {
// Invoice completely refunded
}
Quota Tracking
Track usage against plan limits and automatically fire events when quotas are reached:
// Record usage for a quota (e.g., disk space in MB)
$user->recordUsage('disk_space', 150.5);
// Get current usage
$currentUsage = $user->getUsage('disk_space');
// Set absolute usage (useful for syncing from external sources)
$user->setUsage('bandwidth', 5000);
// Decrement usage (e.g., when files are deleted)
$user->decrementUsage('disk_space', 50);
// Check if over quota
if ($user->isOverQuota('disk_space')) {
// Prevent new uploads
}
// Get remaining quota
$remaining = $user->getRemainingQuota('websites'); // Returns remaining count
// Get percentage used
$percentage = $user->getQuotaPercentage('disk_space'); // Returns 0-100
// Reset usage to zero
$user->resetUsage('disk_space');
Quota Events
The package fires events when quotas reach warning thresholds (default: 80%, 90%) or are exceeded:
// Listen to quota events in your EventServiceProvider
use Bhhaskin\Billing\Events\QuotaWarning;
use Bhhaskin\Billing\Events\QuotaExceeded;
protected $listen = [
QuotaWarning::class => [
SendQuotaWarningNotification::class,
],
QuotaExceeded::class => [
ArchiveUserFiles::class,
SendQuotaExceededNotification::class,
],
];
Event properties:
$event->billable- The billable model (User)$event->quotaKey- The quota identifier (e.g., 'disk_space')$event->currentUsage- Current usage amount$event->limit- The quota limit from the plan$event->thresholdPercentage- Warning threshold (QuotaWarning only)$event->overage- Amount over limit (QuotaExceeded only)
Configure warning thresholds in config/billing.php:
'quota_warning_thresholds' => [80, 90, 95], // Fire warnings at these percentages
API Routes
Include the API routes in your routes/api.php:
Route::middleware('auth:sanctum')->group(function () {
require __DIR__.'/../vendor/bhhaskin/laravel-billing/routes/api.php';
});
Stripe Webhooks
Wire the webhook endpoint to your application's routes file. Exclude it from CSRF verification:
// routes/api.php (or web.php)
use Bhhaskin\Billing\Http\Controllers\WebhookController;
Route::post('/billing/webhook/stripe', [WebhookController::class, 'handle'])
->name('billing.webhook.stripe');
// app/Http/Middleware/VerifyCsrfToken.php (Laravel 10) or
// bootstrap/app.php (Laravel 11+)
protected $except = [
'billing/webhook/stripe',
];
In your application's StripeWebhookController (if you need custom handling), extend the package controller and override only the handler methods you need:
use Bhhaskin\Billing\Http\Controllers\WebhookController as BaseWebhookController;
class StripeWebhookController extends BaseWebhookController
{
protected function handleInvoicePaymentSucceeded($stripeInvoice): void
{
parent::handleInvoicePaymentSucceeded($stripeInvoice);
// Application-specific side effects here
}
}
Webhook Idempotency
Every event delivered to the webhook endpoint is recorded in billing_webhook_events keyed by Stripe's event.id. Duplicate deliveries (Stripe retries, multi-endpoint setups, manual replays) are returned 200 immediately without re-running handlers. Each handler runs inside a database transaction; failures leave processed_at null so a subsequent re-delivery will retry.
Configure retention in config/billing.php (default 90 days), and prune old records:
php artisan billing:prune-webhook-events
The package also auto-schedules this weekly when auto_register_scheduler is enabled.
Payment Method Expiry Warnings
The billing:check-expiring-payment-methods command iterates active card payment methods and dispatches a PaymentMethodExpiring event for any card within the configured warning window (default 60 days, set via billing.payment_method_expiry.warning_days).
php artisan billing:check-expiring-payment-methods
php artisan billing:check-expiring-payment-methods --days=30 --dry-run
php artisan billing:check-expiring-payment-methods --force
Each card fires the event exactly once per (card, expiry-month) combination — debounced via metadata so daily scheduling does not flood your notifications.
Listen for the event in your application:
use Bhhaskin\Billing\Events\PaymentMethodExpiring;
protected $listen = [
PaymentMethodExpiring::class => [
SendCardExpiringNotification::class,
],
];
// Listener:
public function handle(PaymentMethodExpiring $event): void
{
$event->paymentMethod->customer->billable->notify(
new CardExpiringSoon($event->paymentMethod, $event->daysUntilExpiry)
);
}
Daily Billing Processing
The package automatically schedules a daily billing command to process renewals, trial expirations, and grace periods. You can disable this in config and run it manually:
php artisan billing:process
Testing
composer test
License
This package is open-sourced software licensed under the MIT license.