Laravel Cashier

Introduction

Laravel Cashier provides an expressive, fluent interface to Stripe's and Braintree's subscription billing services. It handles almost all of the boilerplate subscription billing code you are dreading writing. In addition to basic subscription management, Cashier can handle coupons, swapping subscription, subscription "quantities", cancellation grace periods, and even generate invoice PDFs.

{note} If you're only performing "one-off" charges and do not offer subscriptions, you should not use Cashier. Instead, use the Stripe and Braintree SDKs directly.

Configuration

Stripe

Composer

First, add the Cashier package for Stripe to your dependencies:

  1. composer require "laravel/cashier":"~7.0"

Database Migrations

Before using Cashier, we'll also need to prepare the database. We need to add several columns to your users table and create a new subscriptions table to hold all of our customer's subscriptions:

  1. Schema::table('users', function ($table) {
  2.     $table->string('stripe_id')->nullable();
  3.     $table->string('card_brand')->nullable();
  4.     $table->string('card_last_four')->nullable();
  5.     $table->timestamp('trial_ends_at')->nullable();
  6. });
  8. Schema::create('subscriptions', function ($table) {
  9.     $table->increments('id');
  10.     $table->integer('user_id');
  11.     $table->string('name');
  12.     $table->string('stripe_id');
  13.     $table->string('stripe_plan');
  14.     $table->integer('quantity');
  15.     $table->timestamp('trial_ends_at')->nullable();
  16.     $table->timestamp('ends_at')->nullable();
  17.     $table->timestamps();
  18. });

Once the migrations have been created, run the migrate Artisan command.

Billable Model

Next, add the Billable trait to your model definition. This trait provides various methods to allow you to perform common billing tasks, such as creating subscriptions, applying coupons, and updating credit card information:

  1. use Laravel\Cashier\Billable;
  3. class User extends Authenticatable
  4. {
  5.     use Billable;
  6. }

API Keys

Finally, you should configure your Stripe key in your services.php configuration file. You can retrieve your Stripe API keys from the Stripe control panel:

  1. 'stripe' => [
  2.     'model'  => App\User::class,
  3.     'key' => env('STRIPE_KEY'),
  4.     'secret' => env('STRIPE_SECRET'),
  5. ],

Braintree

Braintree Caveats

For many operations, the Stripe and Braintree implementations of Cashier function the same. Both services provide subscription billing with credit cards but Braintree also supports payments via PayPal. However, Braintree also lacks some features that are supported by Stripe. You should keep the following in mind when deciding to use Stripe or Braintree:

  • Braintree supports PayPal while Stripe does not.
  • Braintree does not support the increment and decrement methods on subscriptions. This is a Braintree limitation, not a Cashier limitation.
  • Braintree does not support percentage based discounts. This is a Braintree limitation, not a Cashier limitation.

Composer

First, add the Cashier package for Braintree to your dependencies:

  1. composer require "laravel/cashier-braintree":"~2.0"

Plan Credit Coupon

Before using Cashier with Braintree, you will need to define a plan-credit discount in your Braintree control panel. This discount will be used to properly prorate subscriptions that change from yearly to monthly billing, or from monthly to yearly billing.

The discount amount configured in the Braintree control panel can be any value you wish, as Cashier will override the defined amount with our own custom amount each time we apply the coupon. This coupon is needed since Braintree does not natively support prorating subscriptions across subscription frequencies.

Database Migrations

Before using Cashier, we'll need to prepare the database. We need to add several columns to your users table and create a new subscriptions table to hold all of our customer's subscriptions:

  1. Schema::table('users', function ($table) {
  2.     $table->string('braintree_id')->nullable();
  3.     $table->string('paypal_email')->nullable();
  4.     $table->string('card_brand')->nullable();
  5.     $table->string('card_last_four')->nullable();
  6.     $table->timestamp('trial_ends_at')->nullable();
  7. });
  9. Schema::create('subscriptions', function ($table) {
  10.     $table->increments('id');
  11.     $table->integer('user_id');
  12.     $table->string('name');
  13.     $table->string('braintree_id');
  14.     $table->string('braintree_plan');
  15.     $table->integer('quantity');
  16.     $table->timestamp('trial_ends_at')->nullable();
  17.     $table->timestamp('ends_at')->nullable();
  18.     $table->timestamps();
  19. });

Once the migrations have been created, run the migrate Artisan command.

Billable Model

Next, add the Billable trait to your model definition:

  1. use Laravel\Cashier\Billable;
  3. class User extends Authenticatable
  4. {
  5.     use Billable;
  6. }

API Keys

Next, you should configure the following options in your services.php file:

  1. 'braintree' => [
  2.     'model'  => App\User::class,
  3.     'environment' => env('BRAINTREE_ENV'),
  4.     'merchant_id' => env('BRAINTREE_MERCHANT_ID'),
  5.     'public_key' => env('BRAINTREE_PUBLIC_KEY'),
  6.     'private_key' => env('BRAINTREE_PRIVATE_KEY'),
  7. ],

Then you should add the following Braintree SDK calls to your AppServiceProvider service provider's boot method:

  1. \Braintree_Configuration::environment(config('services.braintree.environment'));
  2. \Braintree_Configuration::merchantId(config('services.braintree.merchant_id'));
  3. \Braintree_Configuration::publicKey(config('services.braintree.public_key'));
  4. \Braintree_Configuration::privateKey(config('services.braintree.private_key'));

Currency Configuration

The default Cashier currency is United States Dollars (USD). You can change the default currency by calling the Cashier::useCurrency method from within the boot method of one of your service providers. The useCurrency method accepts two string parameters: the currency and the currency's symbol:

  1. use Laravel\Cashier\Cashier;
  3. Cashier::useCurrency('eur', '€');

Subscriptions

Creating Subscriptions

To create a subscription, first retrieve an instance of your billable model, which typically will be an instance of App\User. Once you have retrieved the model instance, you may use the newSubscription method to create the model's subscription:

  1. $user = User::find(1);
  3. $user->newSubscription('main', 'premium')->create($stripeToken);

The first argument passed to the newSubscription method should be the name of the subscription. If your application only offers a single subscription, you might call this main or primary. The second argument is the specific Stripe / Braintree plan the user is subscribing to. This value should correspond to the plan's identifier in Stripe or Braintree.

The create method, which accepts a Stripe credit card / source token, will begin the subscription as well as update your database with the customer ID and other relevant billing information.

Additional User Details

If you would like to specify additional customer details, you may do so by passing them as the second argument to the create method:

  1. $user->newSubscription('main', 'monthly')->create($stripeToken, [
  2.     'email' => $email,
  3. ]);

To learn more about the additional fields supported by Stripe or Braintree, check out Stripe's documentation on customer creation or the corresponding Braintree documentation.

Coupons

If you would like to apply a coupon when creating the subscription, you may use the withCoupon method:

  1. $user->newSubscription('main', 'monthly')
  2.      ->withCoupon('code')
  3.      ->create($stripeToken);

Checking Subscription Status

Once a user is subscribed to your application, you may easily check their subscription status using a variety of convenient methods. First, the subscribed method returns true if the user has an active subscription, even if the subscription is currently within its trial period:

  1. if ($user->subscribed('main')) {
  2.     //
  3. }

The subscribed method also makes a great candidate for a route middleware, allowing you to filter access to routes and controllers based on the user's subscription status:

  1. public function handle($request, Closure $next)
  2. {
  3.     if ($request->user() && ! $request->user()->subscribed('main')) {
  4.         // This user is not a paying customer...
  5.         return redirect('billing');
  6.     }
  8.     return $next($request);
  9. }

If you would like to determine if a user is still within their trial period, you may use the onTrial method. This method can be useful for displaying a warning to the user that they are still on their trial period:

  1. if ($user->subscription('main')->onTrial()) {
  2.     //
  3. }

The subscribedToPlan method may be used to determine if the user is subscribed to a given plan based on a given Stripe / Braintree plan ID. In this example, we will determine if the user's main subscription is actively subscribed to the monthly plan:

  1. if ($user->subscribedToPlan('monthly', 'main')) {
  2.     //
  3. }

Cancelled Subscription Status

To determine if the user was once an active subscriber, but has cancelled their subscription, you may use the cancelled method:

  1. if ($user->subscription('main')->cancelled()) {
  2.     //
  3. }

You may also determine if a user has cancelled their subscription, but are still on their "grace period" until the subscription fully expires. For example, if a user cancels a subscription on March 5th that was originally scheduled to expire on March 10th, the user is on their "grace period" until March 10th. Note that the subscribed method still returns true during this time:

  1. if ($user->subscription('main')->onGracePeriod()) {
  2.     //
  3. }

Changing Plans

After a user is subscribed to your application, they may occasionally want to change to a new subscription plan. To swap a user to a new subscription, pass the plan's identifier to the swap method:

  1. $user = App\User::find(1);
  3. $user->subscription('main')->swap('provider-plan-id');

If the user is on trial, the trial period will be maintained. Also, if a "quantity" exists for the subscription, that quantity will also be maintained.

If you would like to swap plans and cancel any trial period the user is currently on, you may use the skipTrial method:

  1. $user->subscription('main')
  2.         ->skipTrial()
  3.         ->swap('provider-plan-id');

Subscription Quantity

{note} Subscription quantities are only supported by the Stripe edition of Cashier. Braintree does not have a feature that corresponds to Stripe's "quantity".

Sometimes subscriptions are affected by "quantity". For example, your application might charge $10 per month per user on an account. To easily increment or decrement your subscription quantity, use the incrementQuantity and decrementQuantity methods:

  1. $user = User::find(1);
  3. $user->subscription('main')->incrementQuantity();
  5. // Add five to the subscription's current quantity...
  6. $user->subscription('main')->incrementQuantity(5);
  8. $user->subscription('main')->decrementQuantity();
  10. // Subtract five to the subscription's current quantity...
  11. $user->subscription('main')->decrementQuantity(5);

Alternatively, you may set a specific quantity using the updateQuantity method:

  1. $user->subscription('main')->updateQuantity(10);

The noProrate method may be used to update the subscription's quantity without pro-rating the charges:

  1. $user->subscription('main')->noProrate()->updateQuantity(10);

For more information on subscription quantities, consult the Stripe documentation.

Subscription Taxes

To specify the tax percentage a user pays on a subscription, implement the taxPercentage method on your billable model, and return a numeric value between 0 and 100, with no more than 2 decimal places.

  1. public function taxPercentage() {
  2.     return 20;
  3. }

The taxPercentage method enables you to apply a tax rate on a model-by-model basis, which may be helpful for a user base that spans multiple countries and tax rates.

{note} The taxPercentage method only applies to subscription charges. If you use Cashier to make "one off" charges, you will need to manually specify the tax rate at that time.

Cancelling Subscriptions

To cancel a subscription, call the cancel method on the user's subscription:

  1. $user->subscription('main')->cancel();

When a subscription is cancelled, Cashier will automatically set the ends_at column in your database. This column is used to know when the subscribed method should begin returning false. For example, if a customer cancels a subscription on March 1st, but the subscription was not scheduled to end until March 5th, the subscribed method will continue to return true until March 5th.

You may determine if a user has cancelled their subscription but are still on their "grace period" using the onGracePeriod method:

  1. if ($user->subscription('main')->onGracePeriod()) {
  2.     //
  3. }

If you wish to cancel a subscription immediately, call the cancelNow method on the user's subscription:

  1. $user->subscription('main')->cancelNow();

Resuming Subscriptions

If a user has cancelled their subscription and you wish to resume it, use the resume method. The user must still be on their grace period in order to resume a subscription:

  1. $user->subscription('main')->resume();

If the user cancels a subscription and then resumes that subscription before the subscription has fully expired, they will not be billed immediately. Instead, their subscription will be re-activated, and they will be billed on the original billing cycle.

Updating Credit Cards

The updateCard method may be used to update a customer's credit card information. This method accepts a Stripe token and will assign the new credit card as the default billing source:

  1. $user->updateCard($stripeToken);

Subscription Trials

With Credit Card Up Front

If you would like to offer trial periods to your customers while still collecting payment method information up front, you should use the trialDays method when creating your subscriptions:

  1. $user = User::find(1);
  3. $user->newSubscription('main', 'monthly')
  4.             ->trialDays(10)
  5.             ->create($stripeToken);

This method will set the trial period ending date on the subscription record within the database, as well as instruct Stripe / Braintree to not begin billing the customer until after this date.

{note} If the customer's subscription is not cancelled before the trial ending date they will be charged as soon as the trial expires, so you should be sure to notify your users of their trial ending date.

You may determine if the user is within their trial period using either the onTrial method of the user instance, or the onTrial method of the subscription instance. The two examples below are identical:

  1. if ($user->onTrial('main')) {
  2.     //
  3. }
  5. if ($user->subscription('main')->onTrial()) {
  6.     //
  7. }

Without Credit Card Up Front

If you would like to offer trial periods without collecting the user's payment method information up front, you may set the trial_ends_at column on the user record to your desired trial ending date. This is typically done during user registration:

  1. $user = User::create([
  2.     // Populate other user properties...
  3.     'trial_ends_at' => now()->addDays(10),
  4. ]);

{note} Be sure to add a date mutator for trial_ends_at to your model definition.

Cashier refers to this type of trial as a "generic trial", since it is not attached to any existing subscription. The onTrial method on the User instance will return true if the current date is not past the value of trial_ends_at:

  1. if ($user->onTrial()) {
  2.     // User is within their trial period...
  3. }

You may also use the onGenericTrial method if you wish to know specifically that the user is within their "generic" trial period and has not created an actual subscription yet:

  1. if ($user->onGenericTrial()) {
  2.     // User is within their "generic" trial period...
  3. }

Once you are ready to create an actual subscription for the user, you may use the newSubscription method as usual:

  1. $user = User::find(1);
  3. $user->newSubscription('main', 'monthly')->create($stripeToken);

Handling Stripe Webhooks

Both Stripe and Braintree can notify your application of a variety of events via webhooks. To handle Stripe webhooks, define a route that points to Cashier's webhook controller. This controller will handle all incoming webhook requests and dispatch them to the proper controller method:

  1. Route::post(
  2.     'stripe/webhook',
  3.     '\Laravel\Cashier\Http\Controllers\[email protected]'
  4. );

{note} Once you have registered your route, be sure to configure the webhook URL in your Stripe control panel settings.

By default, this controller will automatically handle cancelling subscriptions that have too many failed charges (as defined by your Stripe settings); however, as we'll soon discover, you can extend this controller to handle any webhook event you like.

Webhooks & CSRF Protection

Since Stripe webhooks need to bypass Laravel's CSRF protection, be sure to list the URI as an exception in your VerifyCsrfToken middleware or list the route outside of the web middleware group:

  1. protected $except = [
  2.     'stripe/*',
  3. ];

Defining Webhook Event Handlers

Cashier automatically handles subscription cancellation on failed charges, but if you have additional Stripe webhook events you would like to handle, extend the Webhook controller. Your method names should correspond to Cashier's expected convention, specifically, methods should be prefixed with handle and the "camel case" name of the Stripe webhook you wish to handle. For example, if you wish to handle the invoice.payment_succeeded webhook, you should add a handleInvoicePaymentSucceeded method to the controller:

  1. <?php
  3. namespace App\Http\Controllers;
  5. use Laravel\Cashier\Http\Controllers\WebhookController as CashierController;
  7. class WebhookController extends CashierController
  8. {
  9.     /**
  10.      * Handle a Stripe webhook.
  11.      *
  12.      * @param  array  $payload
  13.      * @return Response
  14.      */
  15.     public function handleInvoicePaymentSucceeded($payload)
  16.     {
  17.         // Handle The Event
  18.     }
  19. }

Failed Subscriptions

What if a customer's credit card expires? No worries - Cashier includes a Webhook controller that can easily cancel the customer's subscription for you. As noted above, all you need to do is point a route to the controller:

  1. Route::post(
  2.     'stripe/webhook',
  3.     '\Laravel\Cashier\Http\Controllers\[email protected]'
  4. );

That's it! Failed payments will be captured and handled by the controller. The controller will cancel the customer's subscription when Stripe determines the subscription has failed (normally after three failed payment attempts).

Handling Braintree Webhooks

Both Stripe and Braintree can notify your application of a variety of events via webhooks. To handle Braintree webhooks, define a route that points to Cashier's webhook controller. This controller will handle all incoming webhook requests and dispatch them to the proper controller method:

  1. Route::post(
  2.     'braintree/webhook',
  3.     '\Laravel\Cashier\Http\Controllers\[email protected]'
  4. );

{note} Once you have registered your route, be sure to configure the webhook URL in your Braintree control panel settings.

By default, this controller will automatically handle cancelling subscriptions that have too many failed charges (as defined by your Braintree settings); however, as we'll soon discover, you can extend this controller to handle any webhook event you like.

Webhooks & CSRF Protection

Since Braintree webhooks need to bypass Laravel's CSRF protection, be sure to list the URI as an exception in your VerifyCsrfToken middleware or list the route outside of the web middleware group:

  1. protected $except = [
  2.     'braintree/*',
  3. ];

Defining Webhook Event Handlers

Cashier automatically handles subscription cancellation on failed charges, but if you have additional Braintree webhook events you would like to handle, extend the Webhook controller. Your method names should correspond to Cashier's expected convention, specifically, methods should be prefixed with handle and the "camel case" name of the Braintree webhook you wish to handle. For example, if you wish to handle the dispute_opened webhook, you should add a handleDisputeOpened method to the controller:

  1. <?php
  3. namespace App\Http\Controllers;
  5. use Braintree\WebhookNotification;
  6. use Laravel\Cashier\Http\Controllers\WebhookController as CashierController;
  8. class WebhookController extends CashierController
  9. {
  10.     /**
  11.      * Handle a Braintree webhook.
  12.      *
  13.      * @param  WebhookNotification  $webhook
  14.      * @return Response
  15.      */
  16.     public function handleDisputeOpened(WebhookNotification $notification)
  17.     {
  18.         // Handle The Event
  19.     }
  20. }

Failed Subscriptions

What if a customer's credit card expires? No worries - Cashier includes a Webhook controller that can easily cancel the customer's subscription for you. Just point a route to the controller:

  1. Route::post(
  2.     'braintree/webhook',
  3.     '\Laravel\Cashier\Http\Controllers\[email protected]'
  4. );

That's it! Failed payments will be captured and handled by the controller. The controller will cancel the customer's subscription when Braintree determines the subscription has failed (normally after three failed payment attempts). Don't forget: you will need to configure the webhook URI in your Braintree control panel settings.

Single Charges

Simple Charge

{note} When using Stripe, the charge method accepts the amount you would like to charge in the lowest denominator of the currency used by your application. However, when using Braintree, you should pass the full dollar amount to the charge method:

If you would like to make a "one off" charge against a subscribed customer's credit card, you may use the charge method on a billable model instance.

  1. // Stripe Accepts Charges In Cents...
  2. $user->charge(100);
  4. // Braintree Accepts Charges In Dollars...
  5. $user->charge(1);

The charge method accepts an array as its second argument, allowing you to pass any options you wish to the underlying Stripe / Braintree charge creation. Consult the Stripe or Braintree documentation regarding the options available to you when creating charges:

  1. $user->charge(100, [
  2.     'custom_option' => $value,
  3. ]);

The charge method will throw an exception if the charge fails. If the charge is successful, the full Stripe / Braintree response will be returned from the method:

  1. try {
  2.     $response = $user->charge(100);
  3. } catch (Exception $e) {
  4.     //
  5. }

Charge With Invoice

Sometimes you may need to make a one-time charge but also generate an invoice for the charge so that you may offer a PDF receipt to your customer. The invoiceFor method lets you do just that. For example, let's invoice the customer $5.00 for a "One Time Fee":

  1. // Stripe Accepts Charges In Cents...
  2. $user->invoiceFor('One Time Fee', 500);
  4. // Braintree Accepts Charges In Dollars...
  5. $user->invoiceFor('One Time Fee', 5);

The invoice will be charged immediately against the user's credit card. The invoiceFor method also accepts an array as its third argument, allowing you to pass any options you wish to the underlying Stripe / Braintree charge creation:

  1. $user->invoiceFor('One Time Fee', 500, [
  2.     'custom-option' => $value,
  3. ]);

{note} The invoiceFor method will create a Stripe invoice which will retry failed billing attempts. If you do not want invoices to retry failed charges, you will need to close them using the Stripe API after the first failed charge.

Invoices

You may easily retrieve an array of a billable model's invoices using the invoices method:

  1. $invoices = $user->invoices();
  3. // Include pending invoices in the results...
  4. $invoices = $user->invoicesIncludingPending();

When listing the invoices for the customer, you may use the invoice's helper methods to display the relevant invoice information. For example, you may wish to list every invoice in a table, allowing the user to easily download any of them:

  1. <table>
  2.     @foreach ($invoices as $invoice)
  3.         <tr>
  4.             <td>{{ $invoice->date()->toFormattedDateString() }}</td>
  5.             <td>{{ $invoice->total() }}</td>
  6.             <td><a href="/user/invoice/{{ $invoice->id }}">Download</a></td>
  7.         </tr>
  8.     @endforeach
  9. </table>

Generating Invoice PDFs

From within a route or controller, use the downloadInvoice method to generate a PDF download of the invoice. This method will automatically generate the proper HTTP response to send the download to the browser:

  1. use Illuminate\Http\Request;
  3. Route::get('user/invoice/{invoice}', function (Request $request, $invoiceId) {
  4.     return $request->user()->downloadInvoice($invoiceId, [
  5.         'vendor'  => 'Your Company',
  6.         'product' => 'Your Product',
  7.     ]);
  8. });