README

Note: Special thanks to @hostianer for the new name!

LaraMill is a Laravel package that provides a powerful bridge to Paymill that makes it easy to handle payments and subscriptions

Install
Configuration
Offers
Clients
Payments
Subscriptions
Transactions

Install

Simply add LaraMill to your composer.json:

"tbleckert/laramill": "1.0-beta.2"

...and run composer install tbleckert/laramill. This will install the package. You also have to add 'Tbleckert\LaraMill\LaraMillServiceProvider' to your providers array.

Update users table

LaraMill saves and uses two database columns, these are: subscription_id (string/varchar) and client_id (string/varchar). This means you have to manually make a migration that adds these columns to your user table.

Setup model

To use LaraMill you have to update your User model to something like this:

use Tbleckert\LaraMill\LaraMillInterface;
use Tbleckert\LaraMill\LaraMillTrait;

class User extends Eloquent implements LaraMillInterface {

    use LaraMillTrait;

}

Configure

To start using LaraMill you need to publish the config files:

php artisan config:publish tbleckert/laramill

Then fill in your public and private Paymill keys in your new config located at app/config/packages/tbleckert/laramill/config.php

Offers

To add Paymill offers/plans you open the config file (see above) and fill the offers array as follows:

'offers'  => array(
	'Basic' => array(
		'monthly'  => 'offer_key',
		'annually' => 'offer_key'
	),
	'Special' => array(
		'daily'  => 'offer_key',
		'weekly' => 'offer_key'
	)
)

Each offer has a name and an array containing offer keys for each payment interval that the offer supports. As an example, you would use this code to subscribe a user to the basic plan with annual payment:

$user = User::find(1);
$user->subscription('Basic', 'annually')->create($token);

More about subscriptions further down.

Clients

Each user needs a client in Paymill. I suggest that you set up a client in the user registration step (even if you support free accounts). This way, you have the user prepared for subscriptions and payments.

Create client

The email column will be used by default as the client email.

$user->client()->create();

To set a different email, you can just pass it as a parameter in the create method:

$user->client()->create('myemail@domain.com');

You can also add an optional description text

$user->client()->create('myemail@domain.com', 'Client description');

Update client

Updating a client is very similar to creating one:

$user->client()->update('myemail@domain.com', 'Client description');

Remove client

To remove a client from paymill, simply use the remove method:

$user->client()->remove();

Payments

For any subscription or transaction, the client needs a payment. To create a payment we need to use the Paymill Bridge. The Bridge generates a token that we need when creating our payment.

Create payment

For the token generation, please have a look at the official Paymill documentation. Then, for the back-end:

$token = Input::get('paymillToken');
$user->payment($token)->create();

Update payment

There's no functionality for updating a payment, since that makes no sense. Instead, just create a new one and if you want, remove the old one.

Remove payment

$user->payment(false, 'payment_id')->remove();

Payment details

The details for a payment can give you information like card type, last four card numbers and more.

$user->payment(false, 'payment_id')->details();

List all payments

To get all payments created for a user, use the all method:

$user->payment()->all();

Subscriptions

Subscriptions connects a client to an offer with a payment. Paymill handles the payments automatically on the given interval.

Create subscription

For a subscription to work, the client needs a payment. You can either pass a payment id to the subscription method or let LaraMill automatically set the last registered payment. If the user already have a subscription, the create method will throw an exception.

$user->subscription('Basic', 'annually')->create(); // Alternative 1
$user->subscription('Basic', 'annually', 'payment_id')->create(); // Alternative 2

Subscription details

Since the subscription id is saved to the database, you don't have to pass any parameter.

$user->subscription()->details();

Swap subscription

To move the client to a new subscription plan you can use the swap method. Set the new subscription (just like the create method) and call swap.

$user->subscription('Basic', 'monthly')->swap();

Pause subscription

Pausing a subscription requires no parameters and you can use resume to resume the subscription at any time.

$user->subscription()->pause();

Resume subscription

When a subscription is paused you can use this method to activate it again.

$user->subscription()->resume();

Remove subscription

Removing a subscription will delete it completely from Paymill and removes the subscription id from the database. Check the cancel method to only cancel the subscription.

$user->subscription()->remove();

Cancel subscription

When you cancel a subscription it will remain in your database and in Paymill, but it will not be active. Therefor it can be activated again manually in the Paymill admin. To completely remove it, see the remove method.

$user->subscription()->cancel();

List all subscriptions

At the moment, LaraMill only supports 1 subscription per user, but the all method still exists:

$user->subscription()->all();

Transactions

Transactions are one off payments and can be made against a stored payment.

Create transaction

For a transaction to work, the client needs a payment. You can either pass a payment id to the transaction method or let LaraMill automatically set the last registered payment.

$transaction = $user->transaction('payment_id', false, 1000)->create();

Transaction details

The details for a transaction can give you information like card type, last four card numbers and more.

$transaction = $user->transaction(false, 'transaction_id')->details();

tbleckert / laramill

Maintainers

Details