Cara menggunakan php install numberformatter

Pada kesempatan kali ini, saya akan share sedikit tips bagi kalian yang pusing dengan bagaimana cara membuat format angka dalam rupiah? maksudnya misal kita punya sebuah angka 1000000, kalau tiadak ada titiknya kan pusing juga bacanya? maka dari itu tutorial ini saya buat agar bisa membuat sebuah format uang standar.

Sebenarnya PHP sudah menyediakan sebuah fungsi yang benar-benar bisa memecahkan masalah ini hanya dengan 1 baris skrip saja. fungsi tersebut antara lain :

<?php
$angka = 1000000;

echo number_format($angka, 0, '', '.');
?>

Dari skrip diatas terlihat kita akan mengubah angka 1000000 menjadi 1.000.000. Pasti pada bingung dengan fungsi number_format() tersebut? berikut ini penjelasan parameter apa saja yang dibutuhkan pada fungsi tersebut :

number_format(param1, param2, param3, param4)

1. Parameter pertama (param1) diisi dengan angka yang ingin kita ubah formatnya. Pada skrip diatas saya set dengan angka 1000000.
2. Parameter kedua (param2) diisi dengan jumlah angka desimal (angka 0) pada akhir angka. contoh dari angka 1.000.000,00 (angka yang saya beri merah itulah angka desimal). Pada skrip kita diatas, saya set angka desimalnya 0, jadi otomatis tidak ada angka desimalnya.
3. Parameter ketiga (param3) diisi dengan tanda pemisah dengan angka desimal. Untuk tanda pemisah ini, jika dalam rupiah biasanya berupa tanda koma (,). Contoh dari angka 1.000.000,00 (koma (warna merah) itulah yang dimaksud dengna pemisah disini)
4. Parameter keempat (param4) diisi dengan tanda pemisah angka ribuan (angka yang diset pada param1). Dalam pecahan rupiah, tanda pemisahnya adalah titik (.). Contoh 1.000.000 (titik merah itulah yang saya maksud disini)

Oke sebagai contoh biar lebih jelas soal penjelasan mengenai parameter-parameter diatas. Kita akan coba berbagai kustom parameternya. Silakan buat sebuah folder dengan nama latihan_php, lalu simpan pada folder xampp/htdocs. Kemudian buat sebuah file dengan nama format_uang.php, lalu simpan pada folder xampp/htdocs/latihan_php/. Berikut ini kodenya :

<?php
$angka = 1000000;

echo "<b>Contoh 1</b> (tanpa angka desimal dan tanda pemisah angka ribuan adalah titik)<br>";
echo "<h2>Rp. ".number_format($angka, 0, '', '.')."</h2>";

echo "<br>";
echo "<b>Contoh 2</b> (dengan 2 angka desimal, tanda pemisah angka desimal adalah koma, tanda pemisah angka ribuan adalah titik)<br>";
echo "<h2>Rp. ".number_format($angka, 2, ',', '.')."</h2>";

echo "<br>";
echo "<b>Contoh 3</b> (tanpa angka desimal dan tanda pemisah angka ribuan adalah koma)<br>";
echo "<h2>Rp. ".number_format($angka, 0, '', ',')."</h2>";
?>

Kemudian save file tadi. Lalu buka browser dan ketik localhost/latihan_php/format_uang.php. Berikut ini tampilan dari hasil kode diatas :

Sudah cukup mengerti dengan maksud dari penjelasan saya? dari 3 contoh diatas seharusnya sudah bisa lebih paham dan mengerti bagaimana cara menggunakan fungsi number_format yang disediakan PHP.

Baca Juga:

• Tutorial Codeigniter Bahasa Indonesia Lengkap Plus Source Code
• Tutorial PHP Bahasa Indonesia Lengkap Plus Source Code
• Cara Mudah Membuat Form Login dengan Session PHP
• Cara Membuat Multiple Upload Gambar dengan PHP AJAX Bootstrap

Mungkin sekian untuk catatan kali ini. Semoga bisa bermanfaat. Jika ada yang kurang dipahami, langsung tanyakan pada form komentar dibawah ini. Jangan lupa LIKE dan SHARE nya, Terimakasih banyak.

Laravel Cashier Stripe provides an expressive, fluent interface to Stripe'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.

Upgrading Cashier

When upgrading to a new version of Cashier, it's important that you carefully review the upgrade guide.

Warning
To prevent breaking changes, Cashier uses a fixed Stripe API version. Cashier 14 utilizes Stripe API version

php artisan vendor:publish --tag="cashier-migrations"

84. The Stripe API version will be updated on minor releases in order to make use of new Stripe features and improvements.

Installation

First, install the Cashier package for Stripe using the Composer package manager:

composer require laravel/cashier

Warning
To ensure Cashier properly handles all Stripe events, remember to .

Database Migrations

Cashier's service provider registers its own database migration directory, so remember to migrate your database after installing the package. The Cashier migrations will add several columns to your

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

If you need to overwrite the migrations that ship with Cashier, you can publish them using the

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

If you would like to prevent Cashier's migrations from running entirely, you may use the

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Warning
Stripe recommends that any column used for storing Stripe identifiers should be case-sensitive. Therefore, you should ensure the column collation for the

php artisan vendor:publish --tag="cashier-migrations"

91 column is set to

php artisan vendor:publish --tag="cashier-migrations"

92 when using MySQL. More information regarding this can be found in the .

Configuration

Billable Model

Before using Cashier, add the

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Billable;
class User extends Authenticatable

Cashier assumes your billable model will be the

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

php artisan vendor:publish --tag="cashier-migrations"

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Warning
If you're using a model other than Laravel's supplied

php artisan vendor:publish --tag="cashier-migrations"

94 model, you'll need to publish and alter the provided to match your alternative model's table name.

API Keys

Next, you should configure your Stripe API keys in your application's

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Warning
You should ensure that the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

01 environment variable is defined in your application's

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

00 file, as this variable is used to ensure that incoming webhooks are actually from Stripe.

Currency Configuration

The default Cashier currency is United States Dollars (USD). You can change the default currency by setting the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

In addition to configuring Cashier's currency, you may also specify a locale to be used when formatting money values for display on invoices. Internally, Cashier utilizes PHP's

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

Warning
In order to use locales other than

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

06, ensure the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

07 PHP extension is installed and configured on your server.

Tax Configuration

Thanks to Stripe Tax, it's possible to automatically calculate taxes for all invoices generated by Stripe. You can enable automatic tax calculation by invoking the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

Once tax calculation has been enabled, any new subscriptions and any one-off invoices that are generated will receive automatic tax calculation.

For this feature to work properly, your customer's billing details, such as the customer's name, address, and tax ID, need to be synced to Stripe. You may use the and methods offered by Cashier to accomplish this.

Warning
No tax is calculated for or .

Logging

Cashier allows you to specify the log channel to be used when logging fatal Stripe errors. You may specify the log channel by defining the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Exceptions that are generated by API calls to Stripe will be logged through your application's default log channel.

Using Custom Models

You are free to extend the models used internally by Cashier by defining your own model and extending the corresponding Cashier model:

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

After defining your model, you may instruct Cashier to use your custom model via the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

Customers

Retrieving Customers

You can retrieve a customer by their Stripe ID using the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

Creating Customers

Occasionally, you may wish to create a Stripe customer without beginning a subscription. You may accomplish this using the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

Once the customer has been created in Stripe, you may begin a subscription at a later date. You may provide an optional

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

You may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

Updating Customers

Occasionally, you may wish to update the Stripe customer directly with additional information. You may accomplish this using the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

Balances

Stripe allows you to credit or debit a customer's "balance". Later, this balance will be credited or debited on new invoices. To check the customer's total balance you may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

To credit a customer's balance, you may provide a value to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

Providing a value to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

Tax IDs

Cashier offers an easy way to manage a customer's tax IDs. For example, the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

You can also retrieve a specific tax ID for a customer by its identifier:

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

You may create a new Tax ID by providing a valid and value to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

You may delete a tax ID using the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Syncing Customer Data With Stripe

Typically, when your application's users update their name, email address, or other information that is also stored by Stripe, you should inform Stripe of the updates. By doing so, Stripe's copy of the information will be in sync with your application's.

To automate this, you may define an event listener on your billable model that reacts to the model's

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Now, every time your customer model is updated, its information will be synced with Stripe. For convenience, Cashier will automatically sync your customer's information with Stripe on the initial creation of the customer.

You may customize the columns used for syncing customer information to Stripe by overriding a variety of methods provided by Cashier. For example, you may override the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Similarly, you may override the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Billing Portal

Stripe offers an easy way to set up a billing portal so that your customer can manage their subscription, payment methods, and view their billing history. You can redirect your users to the billing portal by invoking the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

By default, when the user is finished managing their subscription, they will be able to return to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

If you would like to generate the URL to the billing portal without generating an HTTP redirect response, you may invoke the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Payment Methods

Storing Payment Methods

In order to create subscriptions or perform "one-off" charges with Stripe, you will need to store a payment method and retrieve its identifier from Stripe. The approach used to accomplish this differs based on whether you plan to use the payment method for subscriptions or single charges, so we will examine both below.

Payment Methods For Subscriptions

When storing a customer's credit card information for future use by a subscription, the Stripe "Setup Intents" API must be used to securely gather the customer's payment method details. A "Setup Intent" indicates to Stripe the intention to charge a customer's payment method. Cashier's

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

After you have created the Setup Intent and passed it to the view, you should attach its secret to the element that will gather the payment method. For example, consider this "update payment method" form:

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Next, the Stripe.js library may be used to attach a Stripe Element to the form and securely gather the customer's payment details:

use Laravel\Cashier\Billable;
class User extends Authenticatable

Next, the card can be verified and a secure "payment method identifier" can be retrieved from Stripe using Stripe's

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

After the card has been verified by Stripe, you may pass the resulting

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Note
If you would like more information about Setup Intents and gathering customer payment details please .

Payment Methods For Single Charges

Of course, when making a single charge against a customer's payment method, we will only need to use a payment method identifier once. Due to Stripe limitations, you may not use the stored default payment method of a customer for single charges. You must allow the customer to enter their payment method details using the Stripe.js library. For example, consider the following form:

use Laravel\Cashier\Billable;
class User extends Authenticatable

After defining such a form, the Stripe.js library may be used to attach a Stripe Element to the form and securely gather the customer's payment details:

use Laravel\Cashier\Billable;
class User extends Authenticatable

Next, the card can be verified and a secure "payment method identifier" can be retrieved from Stripe using :

use Laravel\Cashier\Billable;
class User extends Authenticatable

If the card is verified successfully, you may pass the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Retrieving Payment Methods

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

By default, this method will return payment methods of the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

To retrieve the customer's default payment method, the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

You can retrieve a specific payment method that is attached to the billable model using the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

Determining If A User Has A Payment Method

To determine if a billable model has a default payment method attached to their account, invoke the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

You may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

This method will determine if the billable model has payment methods of the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Updating The Default Payment Method

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

To sync your default payment method information with the customer's default payment method information in Stripe, you may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Warning
The default payment method on a customer can only be used for invoicing and creating new subscriptions. Due to limitations imposed by Stripe, it may not be used for single charges.

Adding Payment Methods

To add a new payment method, you may call the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Note
To learn how to retrieve payment method identifiers please review the .

Deleting Payment Methods

To delete a payment method, you may call the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

By default, this method will delete payment methods of the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Warning
If a user has an active subscription, your application should not allow them to delete their default payment method.

Subscriptions

Subscriptions provide a way to set up recurring payments for your customers. Stripe subscriptions managed by Cashier provide support for multiple subscription prices, subscription quantities, trials, and more.

Creating Subscriptions

To create a subscription, first retrieve an instance of your billable model, which typically will be an instance of

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

The first argument passed to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Warning
Passing a payment method identifier directly to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

76 subscription method will also automatically add it to the user's stored payment methods.

Collecting Recurring Payments Via Invoice Emails

Instead of collecting a customer's recurring payments automatically, you may instruct Stripe to email an invoice to the customer each time their recurring payment is due. Then, the customer may manually pay the invoice once they receive it. The customer does not need to provide a payment method up front when collecting recurring payments via invoices:

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

The amount of time a customer has to pay their invoice before their subscription is cancelled is determined by the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Quantities

If you would like to set a specific quantity for the price when creating the subscription, you should invoke the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Additional Details

If you would like to specify additional customer or subscription options supported by Stripe, you may do so by passing them as the second and third arguments to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Coupons

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

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Or, if you would like to apply a Stripe promotion code, you may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

The given promotion code ID should be the Stripe API ID assigned to the promotion code and not the customer facing promotion code. If you need to find a promotion code ID based on a given customer facing promotion code, you may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

In the example above, the returned

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

The coupon instance allows you to determine the discount amount and whether the coupon represents a fixed discount or percentage based discount:

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

You can also retrieve the discounts that are currently applied to a customer or subscription:

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

The returned

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

If you would like to apply a new coupon or promotion code to a customer or subscription, you may do so via the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

Remember, you should use the Stripe API ID assigned to the promotion code and not the customer facing promotion code. Only one coupon or promotion code can be applied to a customer or subscription at a given time.

For more info on this subject, please consult the Stripe documentation regarding coupons and promotion codes.

Adding Subscriptions

If you would like to add a subscription to a customer who already has a default payment method you may invoke the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

Creating Subscriptions From The Stripe Dashboard

You may also create subscriptions from the Stripe dashboard itself. When doing so, Cashier will sync newly added subscriptions and assign them a name of

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

In addition, you may only create one type of subscription via the Stripe dashboard. If your application offers multiple subscriptions that use different names, only one type of subscription may be added through the Stripe dashboard.

Finally, you should always make sure to only add one active subscription per type of subscription offered by your application. If a customer has two

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

Checking Subscription Status

Once a customer is subscribed to your application, you may easily check their subscription status using a variety of convenient methods. First, the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

The

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

If you would like to determine if a user is still within their trial period, you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

CASHIER_CURRENCY_LOCALE=nl_BE

The

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

By passing an array to the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

CASHIER_CURRENCY_LOCALE=nl_BE

The

use Laravel\Cashier\Billable;
class User extends Authenticatable

CASHIER_CURRENCY_LOCALE=nl_BE

The

use Laravel\Cashier\Billable;
class User extends Authenticatable

CASHIER_CURRENCY_LOCALE=nl_BE

Warning
If a user has two subscriptions with the same name, the most recent subscription will always be returned by the

use Laravel\Cashier\Billable;
class User extends Authenticatable

10 method. For example, a user might have two subscription records named

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

74; however, one of the subscriptions may be an old, expired subscription, while the other is the current, active subscription. The most recent subscription will always be returned while older subscriptions are kept in the database for historical review.

Canceled Subscription Status

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

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

You may also determine if a user has canceled 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

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

To determine if the user has canceled their subscription and is no longer within their "grace period", you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

Incomplete and Past Due Status

If a subscription requires a secondary payment action after creation the subscription will be marked as

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

Similarly, if a secondary payment action is required when swapping prices the subscription will be marked as

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

When a subscription has an incomplete payment, you should direct the user to Cashier's payment confirmation page, passing the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

If you would like the subscription to still be considered active when it's in a

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

Warning
When a subscription is in an

use Laravel\Cashier\Billable;
class User extends Authenticatable

16 state it cannot be changed until the payment is confirmed. Therefore, the

use Laravel\Cashier\Billable;
class User extends Authenticatable

30 and

use Laravel\Cashier\Billable;
class User extends Authenticatable

31 methods will throw an exception when the subscription is in an

use Laravel\Cashier\Billable;
class User extends Authenticatable

16 state.

Subscription Scopes

Most subscription states are also available as query scopes so that you may easily query your database for subscriptions that are in a given state:

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

A complete list of available scopes is available below:

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

Changing Prices

After a customer is subscribed to your application, they may occasionally want to change to a new subscription price. To swap a customer to a new price, pass the Stripe price's identifier to the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

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

If you would like to swap prices and cancel any trial period the customer is currently on, you may invoke the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

If you would like to swap prices and immediately invoice the customer instead of waiting for their next billing cycle, you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

Prorations

By default, Stripe prorates charges when swapping between prices. The

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

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

Warning
Executing the

use Laravel\Cashier\Billable;
class User extends Authenticatable

36 method before the

use Laravel\Cashier\Billable;
class User extends Authenticatable

35 method will have no effect on proration. An invoice will always be issued.

Subscription Quantity

Sometimes subscriptions are affected by "quantity". For example, a project management application might charge $10 per month per project. You may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

Alternatively, you may set a specific quantity using the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

The

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

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

Quantities For Subscriptions With Multiple Products

If your subscription is a , you should pass the ID of the price whose quantity you wish to increment or decrement as the second argument to the increment / decrement methods:

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

Subscriptions With Multiple Products

Subscription with multiple products allow you to assign multiple billing products to a single subscription. For example, imagine you are building a customer service "helpdesk" application that has a base subscription price of $10 per month but offers a live chat add-on product for an additional $15 per month. Information for subscriptions with multiple products is stored in Cashier's

use Laravel\Cashier\Billable;
class User extends Authenticatable

You may specify multiple products for a given subscription by passing an array of prices as the second argument to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

In the example above, the customer will have two prices attached to their

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

If you would like to add another price to an existing subscription, you may invoke the subscription's

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

The example above will add the new price and the customer will be billed for it on their next billing cycle. If you would like to bill the customer immediately you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Subscription as CashierSubscription;
class Subscription extends CashierSubscription

If you would like to add a price with a specific quantity, you can pass the quantity as the second argument of the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

You may remove prices from subscriptions using the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

Warning
You may not remove the last price on a subscription. Instead, you should simply cancel the subscription.

Swapping Prices

You may also change the prices attached to a subscription with multiple products. For example, imagine a customer has a

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

When executing the example above, the underlying subscription item with the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

You can also specify subscription item options by passing an array of key / value pairs to the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

If you want to swap a single price on a subscription, you may do so using the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

Proration

By default, Stripe will prorate charges when adding or removing prices from a subscription with multiple products. If you would like to make a price adjustment without proration, you should chain the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

Quantities

If you would like to update quantities on individual subscription prices, you may do so using the by passing the name of the price as an additional argument to the method:

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

Warning
When a subscription has multiple prices the

use Laravel\Cashier\Billable;
class User extends Authenticatable

62 and

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

80 attributes on the

use Laravel\Cashier\Billable;
class User extends Authenticatable

64 model will be

use Laravel\Cashier\Billable;
class User extends Authenticatable

65. To access the individual price attributes, you should use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

66 relationship available on the

use Laravel\Cashier\Billable;
class User extends Authenticatable

64 model.

Subscription Items

When a subscription has multiple prices, it will have multiple subscription "items" stored in your database's

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

You can also retrieve a specific price using the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

Multiple Subscriptions

Stripe allows your customers to have multiple subscriptions simultaneously. For example, you may run a gym that offers a swimming subscription and a weight-lifting subscription, and each subscription may have different pricing. Of course, customers should be able to subscribe to either or both plans.

When your application creates subscriptions, you may provide the name of the subscription to the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\Subscription;
use App\Models\Cashier\SubscriptionItem;
 * Bootstrap any application services.
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);

In this example, we initiated a monthly swimming subscription for the customer. However, they may want to swap to a yearly subscription at a later time. When adjusting the customer's subscription, we can simply swap the price on the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

Of course, you may also cancel the subscription entirely:

php artisan vendor:publish --tag="cashier-migrations"

Metered Billing

Metered billing allows you to charge customers based on their product usage during a billing cycle. For example, you may charge customers based on the number of text messages or emails they send per month.

To start using metered billing, you will first need to create a new product in your Stripe dashboard with a metered price. Then, use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

You may also start a metered subscription via :

php artisan vendor:publish --tag="cashier-migrations"

Reporting Usage

As your customer uses your application, you will report their usage to Stripe so that they can be billed accurately. To increment the usage of a metered subscription, you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

By default, a "usage quantity" of 1 is added to the billing period. Alternatively, you may pass a specific amount of "usage" to add to the customer's usage for the billing period:

php artisan vendor:publish --tag="cashier-migrations"

If your application offers multiple prices on a single subscription, you will need to use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

Sometimes, you may need to update usage which you have previously reported. To accomplish this, you may pass a timestamp or a

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

Retrieving Usage Records

To retrieve a customer's past usage, you may use a subscription instance's

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

If your application offers multiple prices on a single subscription, you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

The

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

For a full reference of all usage data returned and how to use Stripe's cursor based pagination, please consult the official Stripe API documentation.

Subscription Taxes

Warning
Instead of calculating Tax Rates manually, you can

To specify the tax rates a user pays on a subscription, you should implement the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

The

use Laravel\Cashier\Billable;
class User extends Authenticatable

If you're offering subscriptions with multiple products, you may define different tax rates for each price by implementing a

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

Warning
The

use Laravel\Cashier\Billable;
class User extends Authenticatable

82 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.

Syncing Tax Rates

When changing the hard-coded tax rate IDs returned by the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

This will also sync any item tax rates for a subscription with multiple products. If your application is offering subscriptions with multiple products, you should ensure that your billable model implements the

use Laravel\Cashier\Billable;
class User extends Authenticatable

Tax Exemption

Cashier also offers the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

Warning
These methods are also available on any

use Laravel\Cashier\Billable;
class User extends Authenticatable

93 object. However, when invoked on an

use Laravel\Cashier\Billable;
class User extends Authenticatable

94 object, the methods will determine the exemption status at the time the invoice was created.

Subscription Anchor Date

By default, the billing cycle anchor is the date the subscription was created or, if a trial period is used, the date that the trial ends. If you would like to modify the billing anchor date, you may use the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

For more information on managing subscription billing cycles, consult the Stripe billing cycle documentation

Cancelling Subscriptions

To cancel a subscription, call the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

When a subscription is canceled, Cashier will automatically set the

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

For example, if a customer cancels a subscription on March 1st, but the subscription was not scheduled to end until March 5th, the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Billable;
class User extends Authenticatable

You may determine if a user has canceled their subscription but are still on their "grace period" using the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

If you wish to cancel a subscription immediately, call the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

If you wish to cancel a subscription immediately and invoice any remaining un-invoiced metered usage or new / pending proration invoice items, call the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

You may also choose to cancel the subscription at a specific moment in time:

php artisan vendor:publish --tag="cashier-migrations"

Resuming Subscriptions

If a customer has canceled their subscription and you wish to resume it, you may invoke the

use App\Models\Cashier\User;



use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
 Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

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

Subscription Trials

With Payment Method 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

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

This method will set the trial period ending date on the subscription record within the database and instruct Stripe to not begin billing the customer until after this date. When using the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Warning
If the customer's subscription is not canceled 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.

The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

You may determine if a user is within their trial period using either the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

You may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

To determine if an existing trial has expired, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Defining Trial Days In Stripe / Cashier

You may choose to define how many trial days your price's receive in the Stripe dashboard or always pass them explicitly using Cashier. If you choose to define your price's trial days in Stripe you should be aware that new subscriptions, including new subscriptions for a customer that had a subscription in the past, will always receive a trial period unless you explicitly call the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Without Payment Method Up Front

If you would like to offer trial periods without collecting the user's payment method information up front, you may set the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Warning
Be sure to add a for the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

16 attribute within your billable model's class definition.

Cashier refers to this type of trial as a "generic trial", since it is not attached to any existing subscription. The

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Once you are ready to create an actual subscription for the user, you may use the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

php artisan vendor:publish --tag="cashier-migrations"

To retrieve the user's trial ending date, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

You may also use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Extending Trials

The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Handling Stripe Webhooks

Note
You may use the Stripe CLI to help test webhooks during local development.

Stripe can notify your application of a variety of events via webhooks. By default, a route that points to Cashier's webhook controller is automatically registered by the Cashier service provider. This controller will handle all incoming webhook requests.

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

To ensure your application can handle Stripe webhooks, be sure to configure the webhook URL in the Stripe control panel. By default, Cashier's webhook controller responds to the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  27

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  28

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  29

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  30

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  31

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  32

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  33

For convenience, Cashier includes a

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

By default, the created webhook will point to the URL defined by the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

The webhook that is created will use the Stripe API version that your version of Cashier is compatible with. If you would like to use a different Stripe version, you may provide the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

After creation, the webhook will be immediately active. If you wish to create the webhook but have it disabled until you're ready, you may provide the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Warning
Make sure you protect incoming Stripe webhook requests with Cashier's included middleware.

Webhooks & CSRF Protection

Since Stripe webhooks need to bypass Laravel's CSRF protection, be sure to list the URI as an exception in your application's

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Defining Webhook Event Handlers

Cashier automatically handles subscription cancellations for failed charges and other common Stripe webhook events. However, if you have additional webhook events you would like to handle, you may do so by listening to the following events that are dispatched by Cashier:

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  42

• use App\Models\Cashier\User;
  use Laravel\Cashier\Cashier;
   * Bootstrap any application services.
      Cashier::useCustomerModel(User::class);

  43

Both events contain the full payload of the Stripe webhook. For example, if you wish to handle the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Once your listener has been defined, you may register it within your application's

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Verifying Webhook Signatures

To secure your webhooks, you may use Stripe's webhook signatures. For convenience, Cashier automatically includes a middleware which validates that the incoming Stripe webhook request is valid.

To enable webhook verification, ensure that the

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Single Charges

Simple Charge

If you would like to make a one-time charge against a customer, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

You may also use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Warning
The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

49 method accepts the payment amount in the lowest denominator of the currency used by your application. For example, if customers are paying in United States Dollars, amounts should be specified in pennies.

Charge With Invoice

Sometimes you may need to make a one-time charge and offer a PDF receipt to your customer. The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

The invoice will be immediately charged against the user's default payment method. The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Similarly to

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Alternatively, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Although the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Warning
The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

65,

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

57, and

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

61 methods 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.

Creating Payment Intents

You can create a new Stripe payment intent by invoking the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

After creating the payment intent, you can return the client secret to your application's frontend so that the user can complete the payment in their browser. To read more about building entire payment flows using Stripe payment intents, please consult the Stripe documentation.

When using the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Warning
The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

68 and

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

71 methods accept the payment amount in the lowest denominator of the currency used by your application. For example, if customers are paying in United States Dollars, amounts should be specified in pennies.

Refunding Charges

If you need to refund a Stripe charge, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Invoices

Retrieving Invoices

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

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use Laravel\Cashier\Billable;
class User extends Authenticatable

php artisan vendor:publish --tag="cashier-migrations"

If you would like to include pending invoices in the results, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

You may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Displaying Invoice Information

When listing the invoices for the customer, you may use the invoice's 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:

php artisan vendor:publish --tag="cashier-migrations"

Upcoming Invoices

To retrieve the upcoming invoice for a customer, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Similarly, if the customer has multiple subscriptions, you can also retrieve the upcoming invoice for a specific subscription:

php artisan vendor:publish --tag="cashier-migrations"

Previewing Subscription Invoices

Using the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

You may pass an array of prices to the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Generating Invoice PDFs

Before generating invoice PDFs, you should use Composer to install the Dompdf library, which is the default invoice renderer for Cashier:

php artisan vendor:publish --tag="cashier-migrations"

From within a route or controller, you may use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

By default, all data on the invoice is derived from the customer and invoice data stored in Stripe. The filename is based on your

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

The

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Custom Invoice Renderer

Cashier also makes it possible to use a custom invoice renderer. By default, Cashier uses the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Once you have implemented the invoice renderer contract, you should update the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Checkout

Cashier Stripe also provides support for Stripe Checkout. Stripe Checkout takes the pain out of implementing custom pages to accept payments by providing a pre-built, hosted payment page.

The following documentation contains information on how to get started using Stripe Checkout with Cashier. To learn more about Stripe Checkout, you should also consider reviewing Stripe's own documentation on Checkout.

Product Checkouts

You may perform a checkout for an existing product that has been created within your Stripe dashboard using the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

If needed, you may also specify a product quantity:

php artisan vendor:publish --tag="cashier-migrations"

When a customer visits this route they will be redirected to Stripe's Checkout page. By default, when a user successfully completes or cancels a purchase they will be redirected to your

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

When defining your

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Promotion Codes

By default, Stripe Checkout does not allow user redeemable promotion codes. Luckily, there's an easy way to enable these for your Checkout page. To do so, you may invoke the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

Single Charge Checkouts

You can also perform a simple charge for an ad-hoc product that has not been created in your Stripe dashboard. To do so you may use the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

Warning
When using the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

01 method, Stripe will always create a new product and price in your Stripe dashboard. Therefore, we recommend that you create the products up front in your Stripe dashboard and use the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

92 method instead.

Subscription Checkouts

Warning
Using Stripe Checkout for subscriptions requires you to enable the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

27 webhook in your Stripe dashboard. This webhook will create the subscription record in your database and store all of the relevant subscription items.

You may also use Stripe Checkout to initiate subscriptions. After defining your subscription with Cashier's subscription builder methods, you may call the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

Just as with product checkouts, you may customize the success and cancellation URLs:

php artisan vendor:publish --tag="cashier-migrations"

Of course, you can also enable promotion codes for subscription checkouts:

php artisan vendor:publish --tag="cashier-migrations"

Warning
Unfortunately Stripe Checkout does not support all subscription billing options when starting subscriptions. Using the

use Laravel\Cashier\Billable;
class User extends Authenticatable

95 method on the subscription builder, setting proration behavior, or setting payment behavior will not have any effect during Stripe Checkout sessions. Please consult the Stripe Checkout Session API documentation to review which parameters are available.

Stripe Checkout & Trial Periods

Of course, you can define a trial period when building a subscription that will be completed using Stripe Checkout:

php artisan vendor:publish --tag="cashier-migrations"

However, the trial period must be at least 48 hours, which is the minimum amount of trial time supported by Stripe Checkout.

Subscriptions & Webhooks

Remember, Stripe and Cashier update subscription statuses via webhooks, so there's a possibility a subscription might not yet be active when the customer returns to the application after entering their payment information. To handle this scenario, you may wish to display a message informing the user that their payment or subscription is pending.

Collecting Tax IDs

Checkout also supports collecting a customer's Tax ID. To enable this on a checkout session, invoke the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

When this method is invoked, a new checkbox will be available to the customer that allows them to indicate if they're purchasing as a company. If so, they will have the opportunity to provide their Tax ID number.

Warning
If you have already configured in your application's service provider then this feature will be enabled automatically and there is no need to invoke the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

07 method.

Guest Checkouts

Using the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

Similarly to when creating checkout sessions for existing users, you may utilize additional methods available on the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

After a guest checkout has been completed, Stripe can dispatch a

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

Handling Failed Payments

Sometimes, payments for subscriptions or single charges can fail. When this happens, Cashier will throw an

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

First, you could redirect your customer to the dedicated payment confirmation page which is included with Cashier. This page already has an associated named route that is registered via Cashier's service provider. So, you may catch the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

On the payment confirmation page, the customer will be prompted to enter their credit card information again and perform any additional actions required by Stripe, such as "3D Secure" confirmation. After confirming their payment, the user will be redirected to the URL provided by the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

• Credit Cards
• Alipay
• Bancontact
• BECS Direct Debit
• EPS
• Giropay
• iDEAL
• SEPA Direct Debit

Alternatively, you could allow Stripe to handle the payment confirmation for you. In this case, instead of redirecting to the payment confirmation page, you may setup Stripe's automatic billing emails in your Stripe dashboard. However, if an

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Payment exceptions may be thrown for the following methods:

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

use Laravel\Cashier\Cashier;
 * Register any application services.
    Cashier::ignoreMigrations();

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Determining if an existing subscription has an incomplete payment may be accomplished using the

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::calculateTaxes();

You can derive the specific status of an incomplete payment by inspecting the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

Strong Customer Authentication

If your business or one of your customers is based in Europe you will need to abide by the EU's Strong Customer Authentication (SCA) regulations. These regulations were imposed in September 2019 by the European Union to prevent payment fraud. Luckily, Stripe and Cashier are prepared for building SCA compliant applications.

Warning
Before getting started, review Stripe's guide on PSD2 and SCA as well as their documentation on the new SCA APIs.

Payments Requiring Additional Confirmation

SCA regulations often require extra verification in order to confirm and process a payment. When this happens, Cashier will throw a

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Payment confirmation screens presented by Stripe or Cashier may be tailored to a specific bank or card issuer's payment flow and can include additional card confirmation, a temporary small charge, separate device authentication, or other forms of verification.

Incomplete and Past Due State

When a payment needs additional confirmation, the subscription will remain in an

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

For more information on

use Laravel\Cashier\Billable;
class User extends Authenticatable

use Laravel\Cashier\Billable;
class User extends Authenticatable

Off-Session Payment Notifications

Since SCA regulations require customers to occasionally verify their payment details even while their subscription is active, Cashier can send a notification to the customer when off-session payment confirmation is required. For example, this may occur when a subscription is renewing. Cashier's payment notification can be enabled by setting the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

To ensure that off-session payment confirmation notifications are delivered, verify that for your application and the

use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;
 * Bootstrap any application services.
    Cashier::useCustomerModel(User::class);

php artisan vendor:publish --tag="cashier-migrations"

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

Warning
Notifications will be sent even when customers are manually making a payment that requires additional confirmation. Unfortunately, there is no way for Stripe to know that the payment was done manually or "off-session". But, a customer will simply see a "Payment Successful" message if they visit the payment page after already confirming their payment. The customer will not be allowed to accidentally confirm the same payment twice and incur an accidental second charge.

Stripe SDK

Many of Cashier's objects are wrappers around Stripe SDK objects. If you would like to interact with the Stripe objects directly, you may conveniently retrieve them using the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

You may also use the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

You may invoke the

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

php artisan vendor:publish --tag="cashier-migrations"

Testing

When testing an application that uses Cashier, you may mock the actual HTTP requests to the Stripe API; however, this requires you to partially re-implement Cashier's own behavior. Therefore, we recommend allowing your tests to hit the actual Stripe API. While this is slower, it provides more confidence that your application is working as expected and any slow tests may be placed within their own PHPUnit testing group.

When testing, remember that Cashier itself already has a great test suite, so you should only focus on testing the subscription and payment flow of your own application and not every underlying Cashier behavior.

To get started, add the testing version of your Stripe secret to your

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

use Laravel\Cashier\Billable;
class User extends Authenticatable

Now, whenever you interact with Cashier while testing, it will send actual API requests to your Stripe testing environment. For convenience, you should pre-fill your Stripe testing account with subscriptions / prices that you may use during testing.