README

A simple laravel package for Subscriptions.

All ideas are welcome, please send your issue in: Send your issues in here

Installation

You can install the package via composer:

This package work in laravel 5.8 or later because Carbon is updated to 2.0.

composer require beksos/laravel-subscriptions

Register Service Provider

Add Beksos\LaravelSubscriptions\LaravelSubscriptionsServiceProvider::class to your file config/app.php

'providers' => [
    /**
    * Some Providers
    */
    Beksos\LaravelSubscriptions\LaravelSubscriptionsServiceProvider::class
]

Config file and migrations

Publish package config file and migrations with the following command:

php artisan vendor:publish --provider="Beksos\LaravelSubscriptions\LaravelSubscriptionsServiceProvider"

Then run migrations:

php artisan migrate

Features Overview

Create plans and his features or consumables. (consumables is in development)
Manage your plans: get all plans, disable, delete, etc.
Your user can subscribe to a plan.
The user can renew, cancel, upgrade or downgrade his subscription.
Group your plans now is very simple.
A lot more

A few examples

Configure your User model for use subscriptions

<?php
use Beksos\LaravelSubscriptions\Traits\HasSubscriptions;

class User extends Authenticable
{
    use HasSubscriptions; // Add this line for use subscriptions

Create a plan with features

<?php
use Beksos\LaravelSubscriptions\Entities\Plan;
use Beksos\LaravelSubscriptions\Entities\PlanFeature;
use \Beksos\LaravelSubscriptions\Entities\PlanConsumable;
use Beksos\LaravelSubscriptions\Entities\PlanInterval;

$plan = Plan::create(
        'name of plan', //name
        'this is a description', //description
        1 // sort order
    );
$features = [
    PlanFeature::make('listings', 50),
    PlanFeature::make('pictures_per_listing', 10),
    PlanFeature::make('listing_duration_days', 30),
    PlanFeature::make('listing_title_bold', true),
    PlanConsumable::make('number_of_contacts', 10),
];

// adding features to plan
$plan->features()->saveMany($features);

$plan->isFree(); // return true;

// adding interval of price
$interval = PlanInterval::make(PlanInterval::MONTH, 1, 4.90);
$plan->setInterval($interval);

$plan->isFree(); // return false;
$plan->isNotFree(); // return true;

An user can subscribe to a plan

<?php
use Beksos\LaravelSubscriptions\Entities\Plan;

$user = \Auth::user();
$plan = Plan::find(1);

$user->subscribeTo($plan);

$user->hasActiveSubscription(); // return true;

$currentSubscription = $user->getActiveSubscription(); // return Subscription object;

Upgrade or Downgrade Subscription

<?php
use Beksos\LaravelSubscriptions\Entities\Plan;

$user = \Auth::user();
$firstPlan = Plan::find(1);
$secondPlan = Plan::find(2);

//upgrade or downgrade depending of the price
$user->changePlanTo($secondPlan);

Unsubscribe

<?php
$user = \Auth::user();

// the subscription is will end in the expiration date
$user->unsubscribe();

// the subscription end now
$user->forceUnsubscribe();

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email ronnie.adolfo@gmail.com instead of using the issue tracker.

Credits

License

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

beksos / laravel-subscriptions

Maintainers

Details