Download the PHP package rabol/laravel-simple-subscription without Composer

Simple subscription package for Laravel

This is a simple to use subscription package for Laravel.

It is heavvly inspired by the renvex/laravel-subscriptions package, just simpler and working :)

Sorry, My point is that the renvex packages seems to be abandond.

Payments

• Payment support is in the works, so stay tuned.
• We will most likley use laraveldaily/laravel-invoices and then a payment package

Installation

You can install the package via composer:

You can publish and run the migrations with:

You can publish the config file with:

This is the contents of the published config file:

Usage

Add Subscriptions to your model

For the sake of simplicity there is a trait that can be added to any model.

The most common use case is to add Subscription functionality to your User model just use the Rabol\SimpleSubscription\Traits\HasSubscriptions trait like this:

That's it, now you can use subscriptions on your user model only have to use that trait in our User model! Now your users may subscribe to plans.

Create a new Plan

`

Add a feature

Subscription plan details

Get Feature Value

There are different ways to get information about a feature on a plan To get the value of the feature 'My cool feature'.:

Get feature usage

Create a Subscription

You can subscribe a user to a plan by using the function available in the 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
method to create the model's subscription.

you can also specify the start date like this:

If no start date is specified, the subscription will start today. The end date is calculated from the settings on the plan.

Change the Plan

To change the plan do this:

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.

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
• 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.
• getFeatureRemaining: returns available uses for a particular feature.
• getFeatureValue: returns the feature value.

All methods share the same signature: e.g. $user->subscription('My cool subscription')->getFeatureUsage('My cool feature');.

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: The difference from the `` method is that the will not look at reset date

Increase Feature Usage

Increasing the feature usage is almost the same as . this function simply add a given quantity to the value:

One more difference from the method is that the will not look at reset date

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

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Steen Rabol
• All Contributors

License

The MIT License (MIT). Please see License File for more information.