https://github.com/tomatophp/filament-subscriptions
Manage your subscriptions Like Spark for FilamentPHP
https://github.com/tomatophp/filament-subscriptions
filament-plugin payments subscriptions tomatophp
Last synced: about 1 year ago
JSON representation
Manage your subscriptions Like Spark for FilamentPHP
- Host: GitHub
- URL: https://github.com/tomatophp/filament-subscriptions
- Owner: tomatophp
- License: mit
- Created: 2024-08-21T15:09:31.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-08T09:27:48.000Z (over 1 year ago)
- Last Synced: 2025-03-29T13:08:40.596Z (about 1 year ago)
- Topics: filament-plugin, payments, subscriptions, tomatophp
- Language: PHP
- Homepage: https://tomatophp.com/en/open-source/filament-subscriptions
- Size: 2.17 MB
- Stars: 51
- Watchers: 2
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Filament Subscriptions
[](https://packagist.org/packages/tomatophp/filament-subscriptions)
[](https://packagist.org/packages/tomatophp/filament-subscriptions)
[](https://packagist.org/packages/tomatophp/filament-subscriptions)
Manage subscriptions and feature access with customizable plans in FilamentPHP
thanks for [Laravel Subscriptions](https://github.com/laravelcm/laravel-subscriptions) you can review it before use this package.
## Screenshots
## Features
- [x] Manage plans
- [x] Manage features
- [x] Manage subscriptions
- [x] multi-tenancy support
- [x] Native Filament subscriptions support
- [x] Subscription Middleware
- [x] Subscription Page like Spark
- [x] Subscription Events
- [x] Subscription Facade Hook
- [ ] Subscription Webhooks
- [ ] Subscription Payments Integrations
## Installation
```bash
composer require tomatophp/filament-subscriptions
```
we need the Media Library plugin to be installed and migrated you can use this command to publish the migration
```bash
php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-migrations"
```
now you need to publish your migrations
```bash
php artisan vendor:publish --provider="Laravelcm\Subscriptions\SubscriptionServiceProvider"
```
after that please run this command
```bash
php artisan filament-subscriptions:install
```
finally register the plugin on `/app/Providers/Filament/AdminPanelProvider.php`
```php
->plugin(\TomatoPHP\FilamentSubscriptions\FilamentSubscriptionsPlugin::make())
```
## Using
now on your User.php model or any auth model you like you need to add this trait
```php
namespace App\Models;
use Laravelcm\Subscriptions\Traits\HasPlanSubscriptions;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable
{
use HasPlanSubscriptions;
}
```
To configure the billing provider for your application, use the `FilamentSubscriptionsProvider`:
```php
use TomatoPHP\FilamentSubscriptions\FilamentSubscriptionsProvider;
use TomatoPHP\FilamentSubscriptions\Filament\Pages\Billing;
use Filament\Panel;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->pages([
Billing::class
])
->tenantBillingProvider(new FilamentSubscriptionsProvider());
}
```
This setup allows users to manage their billing through a link in the tenant menu.
## Requiring a Subscription
To enforce a subscription requirement for any part of your application, use the `requiresTenantSubscription()` method:
```php
use Filament\Panel;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->requiresTenantSubscription();
}
```
Users without an active subscription will be redirected to the billing page.
## Register New Subscriber Type
you can register new subscriber type by using this code
```php
use TomatoPHP\FilamentSubscriptions\Facades\FilamentSubscriptions;
public function boot()
{
FilamentSubscriptions::register(
\TomatoPHP\FilamentSubscriptions\Services\Contracts\Subscriber::make()
->name('User')
->model(\App\Models\User::class)
);
}
```
## Use Events
we add events everywhere on the subscription process and here is the list of events
- `TomatoPHP\FilamentSubscriptions\Events\CancelPlan`
- `TomatoPHP\FilamentSubscriptions\Events\ChangePlan`
- `TomatoPHP\FilamentSubscriptions\Events\RequestPlan`
- `TomatoPHP\FilamentSubscriptions\Events\SubscribePlan`
all events have the same payload
```php
return [
"old" => //Plan,
"new" => //Plan,
"subscription" => //Subscription,
]
```
## Use Facade Hook
you can use the facade hook to add your custom logic to the subscription process
```php
use TomatoPHP\FilamentSubscriptions\Facades\FilamentSubscriptions;
FilamentSubscriptions::afterSubscription(function (array $data){
// your logic here
});
FilamentSubscriptions::afterRenew(function (array $data){
// your logic here
});
FilamentSubscriptions::afterChange(function (array $data){
// your logic here
});
FilamentSubscriptions::afterCanceling(function (array $data){
// your logic here
});
```
## Publish Assets
you can publish config file by use this command
```bash
php artisan vendor:publish --tag="filament-subscriptions-config"
```
you can publish views file by use this command
```bash
php artisan vendor:publish --tag="filament-subscriptions-views"
```
you can publish languages file by use this command
```bash
php artisan vendor:publish --tag="filament-subscriptions-lang"
```
## Other Filament Packages
Checkout our [Awesome TomatoPHP](https://github.com/tomatophp/awesome)