Download the PHP package laravelcm/laravel-subscriptions without Composer
On this page you can find all versions of the php package laravelcm/laravel-subscriptions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravelcm/laravel-subscriptions
More information about laravelcm/laravel-subscriptions
Files in laravelcm/laravel-subscriptions
Package laravel-subscriptions
Short Description Laravel Subscriptions is a flexible plans and subscription management system for Laravel, with the required tools to run your SAAS like services efficiently. It's simple architecture, accompanied by powerful underlying to afford solid platform for your business.
License MIT
Homepage https://laravel.cm
Informations about the package laravel-subscriptions
Laravel Subscriptions
Laravel Subscriptions is a flexible plans and subscription management system for Laravel, with the required tools to run your SAAS like services efficiently. It's simple architecture, accompanied by powerful underlying to afford solid platform for your business.
Considerations
- Payments are out of scope for this package.
- You may want to extend some of the core models, in case you need to override the logic behind some helper methods like
renew()
,cancel()
etc. E.g.: when cancelling a subscription you may want to also cancel the recurring payment attached.
Installation
-
Install the package via composer:
-
Publish resources (migrations and config files):
-
Execute migrations via the following command:
- Done!
Usage
Add Subscriptions to User model
Laravel Subscriptions has been specially made for Eloquent and simplicity has been taken very serious as in any other Laravel related aspect. To add Subscription functionality to your User model just use the \Rinvex\Subscriptions\Traits\HasPlanSubscriptions
trait like this:
That's it, we only have to use that trait in our User model! Now your users may subscribe to plans.
Note: you can use
HasPlanSubscriptions
trait on any subscriber model, it doesn't have to be the user model, in fact any model will do.
Create a Plan
Get Plan Details
You can query the plan for further details, using the intuitive API as follows:
Both $plan->features
and $plan->subscriptions
are collections, driven from relationships, and thus you can query these relations as any normal Eloquent relationship. E.g. $plan->features()->where('name', 'listing_title_bold')->first()
.
Get Feature Value
Say you want to show the value of the feature _pictures_perlisting from above. You can do so in many ways:
Create a Subscription
You can subscribe a user to a plan by using the newSubscription()
function available in the HasPlanSubscriptions
trait. First, retrieve an instance of your subscriber model, which typically will be your user model and an instance of the plan your user is subscribing to. Once you have retrieved the model instance, you may use the newSubscription
method to create the model's subscription.
The first argument passed to newSubscription
method should be the title of the subscription. If your application offer a single subscription, you might call this main
or primary
, while the second argument is the plan instance your user is subscribing to, and there's an optional third parameter to specify custom start date as an instance of Carbon\Carbon
(by default if not provided, it will start now).
Change the Plan
You can change subscription plan easily as follows:
If both plans (current and new plan) have the same billing frequency (e.g., invoice_period
and invoice_interval
) the subscription will retain the same billing dates. If the plans don't have the same billing frequency, the subscription will have the new plan billing frequency, starting on the day of the change and the subscription usage data will be cleared. Also, if the new plan has a trial period, and it's a new subscription, the trial period will be applied.
Feature Options
Plan features are great for fine-tuning subscriptions, you can top-up certain feature for X times of usage, so users may then use it only for that amount. Features also have the ability to be resettable and then it's usage could be expired too. See the following examples:
Subscription Feature Usage
There's multiple ways to determine the usage and ability of a particular feature in the user subscription, the most common one is canUseFeature
:
The canUseFeature
method returns true
or false
depending on multiple factors:
- Feature is enabled.
- Feature value isn't
0
/false
/NULL
. - Or feature has remaining uses available.
Other feature methods on the user subscription instance are:
getFeatureUsage
: returns how many times the user has used a particular feature.getFeatureRemainings
: returns available uses for a particular feature.getFeatureValue
: returns the feature value.
All methods share the same signature: e.g.
$user->planSubscription('main')->getFeatureUsage('listings');
.
Record Feature Usage
In order to effectively use the ability methods you will need to keep track of every usage of each feature (or at least those that require it). You may use the recordFeatureUsage
method available through the user subscription()
method:
The recordFeatureUsage
method accept 3 parameters: the first one is the feature's name, the second one is the quantity of uses to add (default is 1
), and the third one indicates if the addition should be incremental (default behavior), when disabled the usage will be override by the quantity provided. E.g.:
Reduce Feature Usage
Reducing the feature usage is almost the same as incrementing it. Here we only substract a given quantity (default is 1
) to the actual usage:
Clear The Subscription Usage Data
Check Subscription Status
For a subscription to be considered active one of the following must be true
:
- Subscription has an active trial.
- Subscription
ends_at
is in the future.
Alternatively you can use the following methods available in the subscription model:
Canceled subscriptions with an active trial or
ends_at
in the future are considered active.
Renew a Subscription
To renew a subscription you may use the renew
method available in the subscription model. This will set a new ends_at
date based on the selected plan and will clear the usage data of the subscription.
Canceled subscriptions with an ended period can't be renewed.
Cancel a Subscription
To cancel a subscription, simply use the cancel
method on the user's subscription:
By default the subscription will remain active until the end of the period, you may pass true
to end the subscription immediately:
Scopes
Subscription Model
Models
Laravel Subscriptions uses 4 models:
Changelog
Refer to the Changelog for a full history of the project.
Support
The following support channels are available at your fingertips:
- Chat on Telegram
- Help on Email
- Follow on Twitter
Contributing & Protocols
Thank you for considering contributing to this project! The contribution guide can be found in CONTRIBUTING.md.
Bug reports, feature requests, and pull requests are very welcome.
- Versioning
- Pull Requests
- Coding Standards
- Feature Requests
- Git Flow
Security Vulnerabilities
If you discover a security vulnerability within this project, please send an e-mail to [email protected]. All security vulnerabilities will be promptly addressed.
About Laravel Cameroon
The community of PHP and Laravel developers in Cameroon, the largest gathering of developers in Cameroon.
License
This software is released under The MIT License (MIT).
(c) 2018-2023 Laravel Cameroun, Some rights reserved.
All versions of laravel-subscriptions with dependencies
illuminate/console Version ^10.0|^11.0
illuminate/container Version ^10.0|^11.0
illuminate/database Version ^10.0|^11.0
illuminate/support Version ^10.0|^11.0
spatie/eloquent-sortable Version ^4.0.0
spatie/laravel-package-tools Version ^1.16
spatie/laravel-sluggable Version ^3.4.2
spatie/laravel-translatable Version ^6.5.0