<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Retrieve the currently authenticated user...</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Retrieve the currently authenticated user's ID...</span></div><div class="line"><span style="color: #BEC5D4;">$id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">id</span><span style="color: #BFC7D5;">();</span></div>

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span

Determining if the Current User is
Authenticated

To determine if the user making the incoming HTTP request is authenticated, you may use the
check method on the Auth facade. This method will return
true if the user is authenticated:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">check</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user is logged in...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Protecting Routes

Route middleware can be used to only allow
authenticated users to access a given route. Laravel ships with an
auth middleware, which is a middleware alias for the
Illuminate\Auth\Middleware\Authenticate class. Since this middleware
is already aliased internally by Laravel, all you need to do is attach the
middleware to a route definition:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/flights</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Only authenticated users may access this <code>route...
})->middleware('auth');

Redirecting
Unauthenticated Users

When the auth middleware detects an unauthenticated user, it will
redirect the user to the login named
route. You may modify this behavior using the method
redirectGuestsTo of your application’s bootstrap/app.php file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">withMiddleware</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Middleware</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$<code>middleware) {
 $middleware->redirectGuestsTo('/login');
 
 // Using a closure...
 $middleware->redirectGuestsTo(fn (Request $request) => route('login'));
})

Specifying a Guard

When attaching the auth middleware to a route, you may
also specify which «guard» should be used to authenticate the user. The guard specified should
correspond to one of the keys in the guards array of your auth.php
configuration file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/flights</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Only authenticated users may access this <code>route...
})->middleware('auth:admin');

Login Throttling

If you are using the Laravel Breeze or Laravel Jetstream starter
kits, rate limiting will automatically be applied to login attempts. By default, the
user will not be able to login for one minute if they fail to provide the correct credentials
after several attempts. The throttling is unique to the user’s username / email address and
their IP address.

Manually Authenticating Users

You are not required to use the authentication scaffolding included with Laravel’s application starter kits. If you choose not to use this
scaffolding, you will need to manage user authentication using the Laravel authentication
classes directly. Don’t worry, it’s a cinch!

We will access Laravel’s authentication services via the Auth facade, so we’ll need to make sure to import the Auth
facade at the top of the class. Next, let’s check out the attempt method. The
attempt method is normally used to handle authentication attempts from your
application’s «login» form. If authentication is successful, you should regenerate the user’s session to prevent session fixation:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Controllers;
 
use Illuminate\Http\Request;
use Illuminate\Http\RedirectResponse;
use Illuminate\Support\Facades\Auth;
 
class LoginController extends Controller
{
 /**
     * Handle an authentication attempt.
 */
 public function authenticate(Request $request): RedirectResponse
    {
 $credentials = $request->validate([
 'email' => ['required', 'email'],
 'password' => ['required'],
        ]);
 
 if (Auth::attempt($credentials)) {
 $request->session()->regenerate();
 
 return redirect()->intended('dashboard');
        }
 
 return back()->withErrors([
 'email' => 'The provided credentials do not match our records.',
        ])->onlyInput('email');
    }
}

The attempt method accepts an array of key / value pairs as its first argument. The
values in the array will be used to find the user in your database table. So, in
the example above, the user will be retrieved by the value of the email column. If
the user is found, the hashed password stored in the database will be compared with
the password value passed to the method via the array. You should not hash the
incoming request’s password value, since the framework will automatically hash the
value before comparing it to the hashed password in the database. An authenticated
session will be started for the user if the two hashed passwords match.

Remember, Laravel’s authentication services will retrieve users from your database
based on your authentication guard’s «provider» configuration. In the default
config/auth.php configuration file, the Eloquent user provider is
specified and it is instructed to use the App\Models\User model when
retrieving users. You may change these values within your configuration file based
on the needs of your application.

The attempt method will return true if authentication was successful.
Otherwise, false will be returned.

The intended method provided by Laravel’s redirector will redirect the user to the
URL they were attempting to access before being intercepted by the authentication
middleware. A fallback URI may be given to this method in case the intended
destination is not available.

Specifying
Additional Conditions

If you wish, you may also add extra query conditions to the authentication query in addition to
the user’s email and password. To accomplish this, we may simply add the query conditions to the
array passed to the attempt method. For example, we may verify that the user is
marked as «active»:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">attempt</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">email</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$email</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$password</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">active</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">])) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Authentication was successful...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

For complex query conditions, you may provide a closure in your array of credentials. This
closure will be invoked with the query instance, allowing you to customize the query based on
your application’s needs:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Database\Eloquent\</span><span style="color: #FFCB8B;">Builder</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">attempt</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">email</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$email</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$password</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">fn</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Builder</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$query</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> => </span><span style="color: #BEC5D4;">$query</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">has</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">activeSubscription</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">),</span></div><div class="line"><span style="color: #BFC7D5;">])) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Authentication was successful...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

The attemptWhen method, which receives a closure as its second argument, may be used
to perform more extensive inspection of the potential user before actually authenticating the
user. The closure receives the potential user and should return true or
false to indicate if the user may be authenticated:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">attemptWhen</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">email</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$email</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$password</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">], </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isNotBanned</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">})) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Authentication was successful...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Accessing
Specific Guard Instances

Via the Auth facade’s guard method, you may specify which guard
instance you would like to utilize when authenticating the user. This allows you to manage
authentication for separate parts of your application using entirely separate authenticatable
models or user tables.

The guard name passed to the guard method should correspond to one of the guards
configured in your auth.php configuration file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">guard</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">admin</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">attempt</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$credentials</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Remembering Users

Many web applications provide a «remember me» checkbox on their login form. If you would like to
provide «remember me» functionality in your application, you may pass a boolean value as the
second argument to the attempt method.

When this value is true, Laravel will keep the user authenticated indefinitely or
until they manually logout. Your users table must include the string
remember_token column, which will be used to store the «remember me» token. The
users table migration included with new Laravel applications already
includes this column:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">attempt</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">email</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$email</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$password</span><span style="color: #BFC7D5;">], </span><span style="color: #BEC5D4;">$remember</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user is being remembered...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

If your application offers «remember me» functionality, you may use the viaRemember
method to determine if the currently authenticated user was authenticated using the «remember
me» cookie:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">viaRemember</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Other Authentication
Methods

Authenticate a User
Instance

If you need to set an existing user instance as the currently authenticated user, you may pass
the user instance to the Auth facade’s login method. The given user
instance must be an implementation of the Illuminate\Contracts\Auth\Authenticatable
contract. The App\Models\User model
included with Laravel already implements this interface. This method of authentication is useful
when you already have a valid user instance, such as directly after a user registers with your
application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">login</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">);</span></div>

You may pass a boolean value as the second argument to the login method. This value
indicates if «remember me» functionality is desired for the authenticated session. Remember,
this means that the session will be authenticated indefinitely or until the user manually logs
out of the application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">login</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$remember</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">true</span><span style="color: #BFC7D5;">);</span></div>

If needed, you may specify an authentication guard before calling the login method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">guard</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">admin</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">login</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">);</span></div>

Authenticate a User by
ID

To authenticate a user using their database record’s primary key, you may use the
loginUsingId method. This method accepts the primary key of the user you wish to
authenticate:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">loginUsingId</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div>

You may pass a boolean value to the remember argument of the
loginUsingId method. This value indicates if «remember me» functionality is desired
for the authenticated session. Remember, this means that the session will be authenticated
indefinitely or until the user manually logs out of the application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">loginUsingId</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">, remember: </span><span style="color: #82AAFF;">true</span><span style="color: #BFC7D5;">);</span></div>

Authenticate a User Once

You may use the once method to authenticate a user with the application for a single
request. No sessions or cookies will be utilized when calling this method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">once</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$credentials</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

HTTP Basic
Authentication

HTTP Basic Authentication
provides a quick way to authenticate users of your application without setting up a dedicated
«login» page. To get started, attach the auth.basic middleware to a route. The
auth.basic middleware is included with the Laravel framework, so you
do not need to define it:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/profile</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Only authenticated users may access this <code>route...
})->middleware('auth.basic');

Once the middleware has been attached to the route, you will
automatically be prompted for credentials when accessing the route in your browser.
By default, the auth.basic middleware will assume the
email column on your users database table is the user’s
«username».

A Note on FastCGI

If you are using PHP FastCGI and Apache to serve your Laravel application, HTTP Basic
authentication may not work correctly. To correct these problems, the following lines may be
added to your application’s .htaccess file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">RewriteCond</span><span style="color: #BFC7D5;"> </span><span style="color: #80CBC4;">%{HTTP:Authorization}</span><span style="color: #BFC7D5;"> </span><span style="color: #C3E88D;">^(.+)$</span></div><div class="line"><span style="color: #C792EA;">RewriteRule</span><span style="color: #BFC7D5;"> </span><span style="color: #80CBC4;">.*</span><span style="color: #BFC7D5;"> </span><span style="color: #C3E88D;">-</span><span style="color: #BFC7D5;"> [E=HTTP_AUTHORIZATION:%{</span><span style="color: #FFCB6B;">HTTP:Authorization</span><span style="color: #BFC7D5;">}]</span></div>

Stateless HTTP Basic Authentication

You may also use HTTP Basic Authentication without setting a user identifier cookie in the
session. This is primarily helpful if you choose to use HTTP Authentication to authenticate
requests to your application’s API. To accomplish this, define a
middleware that calls the onceBasic method. If no response is
returned by the onceBasic method, the request may be passed further into the
application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Symfony\Component\HttpFoundation\Response;
 
class AuthenticateOnceWithBasicAuth
{
 /**
     * Handle an incoming request.
     *
     * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
 */
 public function handle(Request $request, Closure $next): Response
    {
 return Auth::onceBasic() ?: $next($request);
    }
 
}

Next, attach the middleware to a route:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/api/user</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Only authenticated users may access this <code>route...
})->middleware(AuthenticateOnceWithBasicAuth::class);

Logging Out

To manually log users out of your application, you may use the logout method
provided by the Auth facade. This will remove the authentication information from
the user’s session so that subsequent requests are not authenticated.

In addition to calling the logout method, it is recommended that you invalidate the
user’s session and regenerate their CSRF token. After logging the user
out, you would typically redirect the user to the root of your application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">RedirectResponse</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Log the user out of the application.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">logout</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">RedirectResponse</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">logout</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">session</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invalidate</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">session</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">regenerateToken</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">redirect</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Invalidating Sessions on Other Devices

Laravel also provides a mechanism for invalidating and «logging out» a user’s sessions that are
active on other devices without invalidating the session on their current device. This feature
is typically utilized when a user is changing or updating their password and you would like to
invalidate sessions on other devices while keeping the current device authenticated.

Before getting started, you should make sure that the
Illuminate\Session\Middleware\AuthenticateSession middleware is
included on the routes that should receive session authentication. Typically, you
should place this middleware on a route group definition so that it
can be applied to the majority of your application’s routes. By default, the
AuthenticateSession middleware may be attached to a route
using the auth.session middleware alias:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;"><code>middleware(['auth', 'auth.session'])->group(function () {
 Route::get('/', function () {
 // ...
    });
});

Then, you may use the logoutOtherDevices method provided by the Auth
facade. This method requires the user to confirm their current password, which your application
should accept through an input form:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">logoutOtherDevices</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$currentPassword</span><span style="color: #BFC7D5;">);</span></div>

When the logoutOtherDevices method is invoked, the user’s other sessions will be
invalidated entirely, meaning they will be «logged out» of all guards they were previously
authenticated by.

Password Confirmation

While building your application, you may occasionally have actions that should require the user
to confirm their password before the action is performed or before the user is redirected to a
sensitive area of the application. Laravel includes built-in middleware to make
this process a breeze. Implementing this feature will require you to define two
routes: one route to display a view asking the user to
confirm their password and another route to confirm that the password is valid and
redirect the user to their intended destination.

Configuration

After confirming their password, a user will not be asked to confirm their password again for
three hours. However, you may configure the length of time before the user is
re-prompted for their password by changing the value of the password_timeout
configuration value within your application’s config/auth.php
configuration file.

Routing

The Password
Confirmation Form

First, we will define a route to display a view that requests the user
to confirm their password:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/confirm-password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>view('auth.confirm-password');
})->middleware('auth')->name('password.confirm');

As you might expect, the view that is returned by this route should
have a form containing a password field. In addition, feel free to include text
within the view that explains that the user is entering a protected area of the
application and must confirm their password.

Confirming the Password

Next, we will define a route that will handle the form request from the «confirm
password» view. This route will be responsible for validating the
password and redirecting the user to their intended destination:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Hash</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Redirect</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/confirm-password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #C792EA;">!</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Hash</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">check</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->password</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">->password</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">back</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">withErrors</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">password</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">The provided password does not match our records.</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">]</span></div><div class="line"><span style="color: #BFC7D5;">        ]);</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">session</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">passwordConfirmed</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">redirect</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">intended</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;"><code>middleware(['auth', 'throttle:6,1']);

Before moving on, let’s examine this route in more detail. First, the request’s
password field is determined to actually match the authenticated user’s password.
If the password is valid, we need to inform Laravel’s session that the user has confirmed their
password. The passwordConfirmed method will set a timestamp in the user’s session
that Laravel can use to determine when the user last confirmed their password. Finally, we can
redirect the user to their intended destination.

Protecting Routes

You should ensure that any route that performs an action which requires recent
password confirmation is assigned the password.confirm middleware.
This middleware is included with the default installation of Laravel and will
automatically store the user’s intended destination in the session so that the user may be
redirected to that location after confirming their password. After storing the user’s intended
destination in the session, the middleware will redirect the user to the
password.confirm named route:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/settings</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;"><code>middleware(['password.confirm']);
 
Route::post('/settings', function () {
 // ...
})->middleware(['password.confirm']);

Adding Custom Guards

You may define your own authentication guards using the extend method on the
Auth facade. You should place your call to the extend method within a
service provider. Since Laravel already ships with an
AppServiceProvider, we can place the code in that provider:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Providers;
 
use App\Services\Auth\JwtGuard;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\ServiceProvider;
 
class AppServiceProvider extends ServiceProvider
{
 // ...
 
 /**
     * Bootstrap any application services.
 */
 public function boot(): void
    {
 Auth::extend('jwt', function (Application $app, string $name, array $config) {
 // Return an instance of Illuminate\Contracts\Auth\Guard...
 
 return new JwtGuard(Auth::createUserProvider($config['provider']));
        });
    }
}

As you can see in the example above, the callback passed to the extend method should
return an implementation of Illuminate\Contracts\Auth\Guard. This interface
contains a few methods you will need to implement to define a custom guard. Once your custom
guard has been defined, you may reference the guard in the guards
configuration of your auth.php configuration file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">guards</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">api</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">driver</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">jwt</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">provider</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">users</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">    ],</span></div><div class="line"><span style="color: #BFC7D5;">],</span></div>

Closure Request Guards

The simplest way to implement a custom, HTTP request based authentication system is by using the
Auth::viaRequest method. This method allows you to quickly define your
authentication process using a single closure.

To get started, call the Auth::viaRequest method within the boot method
of your application’s AppServiceProvider. The viaRequest method
accepts an authentication driver name as its first argument. This name can be any string that
describes your custom guard. The second argument passed to the method should be a closure that
receives the incoming HTTP request and returns a user instance or, if authentication fails,
null:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Auth</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">viaRequest</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">custom-token</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">where</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">token</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, (</span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;">) </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->token</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">first</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">    });</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Once your custom authentication driver has been defined, you may configure it as a
driver within the guards configuration of your auth.php
configuration file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">guards</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">api</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">driver</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">custom-token</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">    ],</span></div><div class="line"><span style="color: #BFC7D5;">],</span></div>

Finally, you may reference the guard when assigning the authentication middleware to
a route:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;"><code>middleware('auth:api')->group(function () {
 // ...
});

Adding Custom User
Providers

If you are not using a traditional relational database to store your users, you will
need to extend Laravel with your own authentication user provider. We will use the
provider method on the Auth facade to define a custom user provider.
The user provider resolver should return an implementation of
Illuminate\Contracts\Auth\UserProvider:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Providers;
 
use App\Extensions\MongoUserProvider;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\ServiceProvider;
 
class AppServiceProvider extends ServiceProvider
{
 // ...
 
 /**
     * Bootstrap any application services.
 */
 public function boot(): void
    {
 Auth::provider('mongo', function (Application $app, array $config) {
 // Return an instance of Illuminate\Contracts\Auth\UserProvider...
 
 return new MongoUserProvider($app->make('mongo.connection'));
        });
    }
}

After you have registered the provider using the provider method, you may switch to
the new user provider in your auth.php configuration file. First,
define a provider that uses your new driver:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">providers</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">users</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">driver</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">mongo</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">    ],</span></div><div class="line"><span style="color: #BFC7D5;">],</span></div>

Finally, you may reference this provider in your guards configuration:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">guards</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">web</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">driver</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">session</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">provider</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">users</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">    ],</span></div><div class="line"><span style="color: #BFC7D5;">],</span></div>

The User Provider
Contract

Illuminate\Contracts\Auth\UserProvider implementations are responsible for fetching
an Illuminate\Contracts\Auth\Authenticatable implementation out of a persistent
storage system, such as MySQL, MongoDB, etc. These two interfaces allow the Laravel
authentication mechanisms to continue functioning regardless of how the user data is stored or
what type of class is used to represent the authenticated user:

Let’s take a look at the Illuminate\Contracts\Auth\UserProvider contract:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace Illuminate\Contracts\Auth;
 
interface UserProvider
{
 public function retrieveById($identifier);
 public function retrieveByToken($identifier, $token);
 public function updateRememberToken(Authenticatable $user, $token);
 public function retrieveByCredentials(array $credentials);
 public function validateCredentials(Authenticatable $user, array $credentials);
 public function rehashPasswordIfRequired(Authenticatable $user, array $credentials, bool $force = false);
}

The retrieveById function typically receives a key representing the user, such as an
auto-incrementing ID from a MySQL database. The Authenticatable
implementation matching the ID should be retrieved and returned by the method.

The retrieveByToken function retrieves a user by their unique
$identifier and «remember me» $token, typically stored in a
database column like remember_token. As with the previous method, the
Authenticatable implementation with a matching token value should be returned by
this method.

The updateRememberToken method updates the $user instance’s
remember_token with the new $token. A fresh token is assigned to users
on a successful «remember me» authentication attempt or when the user is logging out.

The retrieveByCredentials method receives the array of credentials passed to the
Auth::attempt method when attempting to authenticate with an application. The
method should then «query» the underlying persistent storage for the user matching those
credentials. Typically, this method will run a query with a «where» condition that searches for
a user record with a «username» matching the value of $credentials['username']. The
method should return an implementation of Authenticatable. This method
should not attempt to do any password validation or authentication.

The validateCredentials method should compare the given $user with the
$credentials to authenticate the user. For example, this method will typically use
the Hash::check method to compare the value of
$user->getAuthPassword() to the value of $credentials['password'].
This method should return true or false indicating whether the
password is valid.

The rehashPasswordIfRequired method should rehash the given $user‘s
password if required and supported. For example, this method will typically use the
Hash::needsRehash method to determine if the $credentials['password']
value needs to be rehashed. If the password needs to be rehashed, the method should use the
Hash::make method to rehash the password and update the user’s record in the
underlying persistent storage.

The Authenticatable
Contract

Now that we have explored each of the methods on the UserProvider, let’s take a look
at the Authenticatable contract. Remember, user providers should return
implementations of this interface from the retrieveById,
retrieveByToken, and retrieveByCredentials methods:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace Illuminate\Contracts\Auth;
 
interface Authenticatable
{
 public function getAuthIdentifierName();
 public function getAuthIdentifier();
 public function getAuthPasswordName();
 public function getAuthPassword();
 public function getRememberToken();
 public function setRememberToken($value);
 public function getRememberTokenName();
}

This interface is simple. The getAuthIdentifierName method should return the name of
the «primary key» column for the user and the getAuthIdentifier method should
return the «primary key» of the user. When using a MySQL back-end, this would likely be the
auto-incrementing primary key assigned to the user record. The getAuthPasswordName
method should return the name of the user’s password column. The getAuthPassword
method should return the user’s hashed password.

This interface allows the authentication system to work with any «user» class, regardless of what
ORM or storage abstraction layer you are using. By default, Laravel includes an
App\Models\User class in the app/Models directory which implements
this interface.

Automatic Password
Rehashing

Laravel’s default password hashing algorithm is bcrypt. The «work factor» for bcrypt hashes can
be adjusted via your application’s config/hashing.php configuration
file or the BCRYPT_ROUNDS environment variable.

Typically, the bcrypt work factor should be increased over time as CPU / GPU processing power
increases. If you increase the bcrypt work factor for your application, Laravel will gracefully
and automatically rehash user passwords as users authenticate with your application via
Laravel’s starter kits or when you manually authenticate
users via the attempt method.

Typically, automatic password rehashing should not disrupt your application; however, you may
disable this behavior by publishing the hashing configuration file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan config:publish hashing

Once the configuration file has been published, you may set the
rehash_on_login configuration value to false:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">rehash_on_login</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">false</span><span style="color: #BFC7D5;">,</span></div>

Events

Laravel dispatches a variety of events during the authentication
process. You may define listeners for any of the following events:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">define</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">===</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #89DDFF;">->user_id</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    });</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Policies\</span><span style="color: #FFCB8B;">PostPolicy</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">define</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, [</span><span style="color: #FFCB8B;">PostPolicy</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">]);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span

If you would like to determine if a user other than the currently authenticated user is
authorized to perform an action, you may use the forUser method on the
Gate facade:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">forUser</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">allows</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user can update the post...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">forUser</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">denies</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user can't update the post...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

You may authorize multiple actions at a time using the any or none
methods:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">any</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">delete-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">], </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user can update or delete the post...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">none</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">delete-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">], </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user can't update or delete the post...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Authorizing or Throwing Exceptions

If you would like to attempt to authorize an action and automatically throw an
Illuminate\Auth\Access\AuthorizationException if the user is not allowed to perform
the given action, you may use the Gate facade’s authorize method.
Instances of AuthorizationException are automatically converted to a 403 HTTP
response by Laravel:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">authorize</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> The action is authorized...</span></div>

Supplying
Additional Context

The gate methods for authorizing abilities (allows, denies,
check, any, none, authorize,
can, cannot) and the authorization Blade directives (@can, @cannot,
@canany) can receive an array as their second argument. These array elements are
passed as parameters to the gate closure, and can be used for additional context when making
authorization decisions:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Category</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">define</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Category</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$category</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">bool</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$pinned</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #C792EA;">!</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">canPublishToGroup</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$category</span><span style="color: #89DDFF;">->group</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">false</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    } </span><span style="color: #C792EA;">elseif</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$pinned</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">&&</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">!</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">canPinPosts</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">false</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">true</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">check</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create-post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, [</span><span style="color: #BEC5D4;">$category</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$pinned</span><span style="color: #BFC7D5;">])) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The user can create the post...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Gate Responses

So far, we have only examined gates that return simple boolean values. However, sometimes you may
wish to return a more detailed response, including an error message. To do so, you may return an
Illuminate\Auth\Access\Response from your gate:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Auth\Access\</span><span style="color: #FFCB8B;">Response</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">define</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">edit-settings</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->isAdmin</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">?</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allow</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">deny</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">You must be an administrator.</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

Even when you return an authorization response from your gate, the Gate::allows
method will still return a simple boolean value; however, you may use the
Gate::inspect method to get the full authorization response returned by the gate:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$response</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">inspect</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">edit-settings</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$response</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">allowed</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The action is authorized...</span></div><div class="line"><span style="color: #BFC7D5;">} </span><span style="color: #C792EA;">else</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">echo</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$response</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">message</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

When using the Gate::authorize method, which throws an
AuthorizationException if the action is not authorized, the error message provided
by the authorization response will be propagated to the HTTP response:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">authorize</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">edit-settings</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> The action is authorized...</span></div>

Customizing
The HTTP Response Status

When an action is denied via a Gate, a 403 HTTP response is returned; however, it
can sometimes be useful to return an alternative HTTP status code. You may customize the HTTP
status code returned for a failed authorization check using the denyWithStatus
static constructor on the Illuminate\Auth\Access\Response class:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Auth\Access\</span><span style="color: #FFCB8B;">Response</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">define</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">edit-settings</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->isAdmin</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">?</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allow</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">denyWithStatus</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">404</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

Because hiding resources via a 404 response is such a common pattern for web
applications, the denyAsNotFound method is offered for convenience:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Auth\Access\</span><span style="color: #FFCB8B;">Response</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">define</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">edit-settings</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->isAdmin</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">?</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allow</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">denyAsNotFound</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

Intercepting Gate Checks

Sometimes, you may wish to grant all abilities to a specific user. You may use the
before method to define a closure that is run before all other authorization
checks:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">before</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$ability</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isAdministrator</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">true</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

If the before closure returns a non-null result that result will be considered the
result of the authorization check.

You may use the after method to define a closure to be executed after all other
authorization checks:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">after</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$ability</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">bool</span><span style="color: #BFC7D5;">|</span><span style="color: #C792EA;">null</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$result</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">mixed</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$arguments</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isAdministrator</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">true</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

Values returned by after closures will not override the result of the authorization
check unless the gate or policy returned null.

Inline Authorization

Occasionally, you may wish to determine if the currently authenticated user is authorized to
perform a given action without writing a dedicated gate that corresponds to the action. Laravel
allows you to perform these types of «inline» authorization checks via the
Gate::allowIf and Gate::denyIf methods. Inline authorization does not
execute any defined «before» or «after» authorization
hooks:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allowIf</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">fn</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> => </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isAdministrator</span><span style="color: #BFC7D5;">());</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">denyIf</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">fn</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> => </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">banned</span><span style="color: #BFC7D5;">());</span></div>

If the action is not authorized or if no user is currently authenticated, Laravel will
automatically throw an Illuminate\Auth\Access\AuthorizationException exception.
Instances of AuthorizationException are automatically converted to a 403 HTTP
response by Laravel’s exception handler.

Creating Policies

Generating Policies

Policies are classes that organize authorization logic around a particular model or
resource. For example, if your application is a blog, you may have an
App\Models\Post model and a corresponding
App\Policies\PostPolicy to authorize user actions such as creating or updating
posts.

You may generate a policy using the make:policy Artisan command. The generated
policy will be placed in the app/Policies directory. If this directory does not
exist in your application, Laravel will create it for you:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan make:policy PostPolicy

The make:policy command will generate an empty policy class. If you would like to
generate a class with example policy methods related to viewing, creating,
updating, and deleting the resource, you may provide a --model option when
executing the command:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan make:policy PostPolicy --model=Post

Registering Policies

Policy Discovery

By default, Laravel automatically discover policies as long as the model and policy
follow standard Laravel naming conventions. Specifically, the policies must be in a
Policies directory at or above the directory that contains your
models. So, for example, the models may be placed in the
app/Models directory while the policies may be placed in the
app/Policies directory. In this situation, Laravel will check for policies in
app/Models/Policies then app/Policies. In addition, the policy name
must match the model name and have a Policy suffix. So, a
User model would correspond to a UserPolicy policy class.

If you would like to define your own policy discovery logic, you may register a custom policy
discovery callback using the Gate::guessPolicyNamesUsing method. Typically, this
method should be called from the boot method of your application’s
AppServiceProvider:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">guessPolicyNamesUsing</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$<code>modelClass) {
 // Return the name of the policy class for the given model...
});

Manually Registering
Policies

Using the Gate facade, you may manually register policies and their corresponding
models within the boot method of your application’s
AppServiceProvider:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Order</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Policies\</span><span style="color: #FFCB8B;">OrderPolicy</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">policy</span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB8B;">Order</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">OrderPolicy</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Writing Policies

Policy Methods

Once the policy class has been registered, you may add methods for each action it authorizes. For
example, let’s define an update method on our PostPolicy which
determines if a given App\Models\User can update a given
App\Models\Post instance.

The update method will receive a User and a Post instance
as its arguments, and should return true or false indicating whether
the user is authorized to update the given Post. So, in this example, we will
verify that the user’s id matches the user_id on the post:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Policies;
 
use App\Models\Post;
use App\Models\User;
 
class PostPolicy
{
 /**
     * Determine if the given post can be updated by the user.
 */
 public function update(User $user, Post $post): bool
    {
 return $user->id === $post->user_id;
    }
}

You may continue to define additional methods on the policy as needed for the various actions it
authorizes. For example, you might define view or delete methods to
authorize various Post related actions, but remember you are free to give your
policy methods any name you like.

If you used the --model option when generating your policy via the Artisan console,
it will already contain methods for the viewAny, view,
create, update, delete, restore, and
forceDelete actions.

Policy Responses

So far, we have only examined policy methods that return simple boolean values. However,
sometimes you may wish to return a more detailed response, including an error message. To do so,
you may return an Illuminate\Auth\Access\Response instance from your policy method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Auth\Access\</span><span style="color: #FFCB8B;">Response</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Determine if the given post can be updated by the user.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">update</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">===</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #89DDFF;">->user_id</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">?</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allow</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">deny</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">You do not own this post.</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

When returning an authorization response from your policy, the Gate::allows method
will still return a simple boolean value; however, you may use the Gate::inspect
method to get the full authorization response returned by the gate:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$response</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">inspect</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$response</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">allowed</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The action is authorized...</span></div><div class="line"><span style="color: #BFC7D5;">} </span><span style="color: #C792EA;">else</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">echo</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$response</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">message</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

When using the Gate::authorize method, which throws an
AuthorizationException if the action is not authorized, the error message provided
by the authorization response will be propagated to the HTTP response:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">authorize</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> The action is authorized...</span></div>

Customizing the HTTP Response Status

When an action is denied via a policy method, a 403 HTTP response is returned;
however, it can sometimes be useful to return an alternative HTTP status code. You may customize
the HTTP status code returned for a failed authorization check using the
denyWithStatus static constructor on the
Illuminate\Auth\Access\Response class:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Auth\Access\</span><span style="color: #FFCB8B;">Response</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Determine if the given post can be updated by the user.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">update</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">===</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #89DDFF;">->user_id</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">?</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allow</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">denyWithStatus</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">404</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Because hiding resources via a 404 response is such a common pattern for web
applications, the denyAsNotFound method is offered for convenience:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Auth\Access\</span><span style="color: #FFCB8B;">Response</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Determine if the given post can be updated by the user.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">update</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">===</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #89DDFF;">->user_id</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">?</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">allow</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Response</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">denyAsNotFound</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Methods Without Models

Some policy methods only receive an instance of the currently authenticated user. This situation
is most common when authorizing create actions. For example, if you are creating a
blog, you may wish to determine if a user is authorized to create any posts at all. In these
situations, your policy method should only expect to receive a user instance:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Determine if the given user can create posts.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">create</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">bool</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->role</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">==</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">writer</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Guest Users

By default, all gates and policies automatically return false if the incoming HTTP
request was not initiated by an authenticated user. However, you may allow these authorization
checks to pass through to your gates and policies by declaring an «optional» type-hint or
supplying a null default value for the user argument definition:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Policies;
 
use App\Models\Post;
use App\Models\User;
 
class PostPolicy
{
 /**
     * Determine if the given post can be updated by the user.
 */
 public function update(?User $user, Post $post): bool
    {
 return $user?->id === $post->user_id;
    }
}

Policy Filters

For certain users, you may wish to authorize all actions within a given policy. To accomplish
this, define a before method on the policy. The before method will be
executed before any other methods on the policy, giving you an opportunity to authorize the
action before the intended policy method is actually called. This feature is most commonly used
for authorizing application administrators to perform any action:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Perform pre-authorization checks.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">before</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$ability</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">bool</span><span style="color: #BFC7D5;">|</span><span style="color: #C792EA;">null</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isAdministrator</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">true</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">null</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

If you would like to deny all authorization checks for a particular type of user then you may
return false from the before method. If null is returned,
the authorization check will fall through to the policy method.

Authorizing Actions Using Policies

Via the User Model

The App\Models\User model that is included with your Laravel
application includes two helpful methods for authorizing actions: can and
cannot. The can and cannot methods receive the name of
the action you wish to authorize and the relevant model. For example, let’s
determine if a user is authorized to update a given App\Models\Post
model. Typically, this will be done within a controller method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
 
class PostController extends Controller
{
 /**
     * Update the given post.
 */
 public function update(Request $request, Post $post): RedirectResponse
    {
 if ($request->user()->cannot('update', $post)) {
 abort(403);
        }
 
 // Update the post...
 
 return redirect('/posts');
    }
}

If a policy is registered for the given model,
the can method will automatically call the appropriate policy and return the
boolean result. If no policy is registered for the model, the can
method will attempt to call the closure-based Gate matching the given action name.

Actions That Don’t Require Models

Remember, some actions may correspond to policy methods like create that do not
require a model instance. In these situations, you may pass a class name to the
can method. The class name will be used to determine which policy to use when
authorizing the action:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
 
class PostController extends Controller
{
 /**
     * Create a post.
 */
 public function store(Request $request): RedirectResponse
    {
 if ($request->user()->cannot('create', Post::class)) {
 abort(403);
        }
 
 // Create the post...
 
 return redirect('/posts');
    }
}

Via the Gate Facade

In addition to helpful methods provided to the App\Models\User model,
you can always authorize actions via the Gate facade’s authorize
method.

Like the can method, this method accepts the name of the action you wish to
authorize and the relevant model. If the action is not authorized, the
authorize method will throw an
Illuminate\Auth\Access\AuthorizationException exception which the Laravel exception
handler will automatically convert to an HTTP response with a 403 status code:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Gate;
 
class PostController extends Controller
{
 /**
     * Update the given blog post.
     *
     * @throws \Illuminate\Auth\Access\AuthorizationException
 */
 public function update(Request $request, Post $post): RedirectResponse
    {
 Gate::authorize('update', $post);
 
 // The current user can update the blog post...
 
 return redirect('/posts');
    }
}

Actions That Don’t Require Models

As previously discussed, some policy methods like create do not require a
model instance. In these situations, you should pass a class name to the
authorize method. The class name will be used to determine which policy to use when
authorizing the action:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">RedirectResponse</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Gate</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Create a new blog post.</span></div><div class="line"><span style="color: #697098;"> *</span></div><div class="line"><span style="color: #697098;"> * </span><span style="color: #C792EA;">@throws</span><span style="color: #697098;"> </span><span style="color: #697098;">\</span><span style="color: #697098;">Illuminate</span><span style="color: #697098;">\</span><span style="color: #697098;">Auth</span><span style="color: #697098;">\</span><span style="color: #697098;">Access</span><span style="color: #697098;">\</span><span style="color: #FFCB8B;">AuthorizationException</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">create</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">RedirectResponse</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">authorize</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The current user can create blog posts...</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">redirect</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/posts</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Via Middleware

Laravel includes a middleware that can authorize actions before the incoming request
even reaches your routes or controllers. By default, the
Illuminate\Auth\Middleware\Authorize middleware may be attached to a
route using the can middleware alias, which is
automatically registered by Laravel. Let’s explore an example of using the can
middleware to authorize that a user can update a post:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">put</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/post/{post}</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The current user may update the post...</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;"><code>middleware('can:update,post');

In this example, we’re passing the can middleware two arguments. The
first is the name of the action we wish to authorize and the second is the route
parameter we wish to pass to the policy method. In this case, since we are using implicit model binding, an
App\Models\Post model will be passed to the policy method. If the user
is not authorized to perform the given action, an HTTP response with a 403 status code will be
returned by the middleware.

For convenience, you may also attach the can middleware to your
route using the can method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">put</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/post/{post}</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The current user may update the post...</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">can</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Actions That Don’t Require Models

Again, some policy methods like create do not require a model instance.
In these situations, you may pass a class name to the middleware. The class name
will be used to determine which policy to use when authorizing the action:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The current user may create posts...</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;"><code>middleware('can:create,App\Models\Post');

Specifying the entire class name within a string middleware definition can become
cumbersome. For that reason, you may choose to attach the can
middleware to your route using the can method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/post</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The current user may create posts...</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">can</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">);</span></div>

Via Blade Templates

When writing Blade templates, you may wish to display a portion of the page only if the user is
authorized to perform a given action. For example, you may wish to show an update form for a
blog post only if the user can actually update the post. In this situation, you may use the
@can and @cannot directives:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">@can</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user can update the post... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@elsecan</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #82AAFF;">App</span><span style="color: #BFC7D5;">\</span><span style="color: #82AAFF;">Models</span><span style="color: #BFC7D5;">\</span><span style="color: #FFCB6B;">Post</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user can create new posts... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@else</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> ... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@endcan</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">@cannot</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user cannot update the post... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@elsecannot</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #82AAFF;">App</span><span style="color: #BFC7D5;">\</span><span style="color: #82AAFF;">Models</span><span style="color: #BFC7D5;">\</span><span style="color: #FFCB6B;">Post</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user cannot create new posts... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@endcannot</span></div>

These directives are convenient shortcuts for writing @if and @unless
statements. The @can and @cannot statements above are equivalent to
the following statements:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">@if </span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB6B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">can</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">))</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user can update the post... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@endif</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">@unless </span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB6B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">can</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">))</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user cannot update the post... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@endunless</span></div>

You may also determine if a user is authorized to perform any action from a given array of
actions. To accomplish this, use the @canany directive:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">@canany</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;"><code>view', 'delete'], $post)

Actions That Don’t Require Models

Like most of the other authorization methods, you may pass a class name to the @can
and @cannot directives if the action does not require a model
instance:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">@can</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #82AAFF;">App</span><span style="color: #BFC7D5;">\</span><span style="color: #82AAFF;">Models</span><span style="color: #BFC7D5;">\</span><span style="color: #FFCB6B;">Post</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user can create posts... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@endcan</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">@cannot</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">create</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #82AAFF;">App</span><span style="color: #BFC7D5;">\</span><span style="color: #82AAFF;">Models</span><span style="color: #BFC7D5;">\</span><span style="color: #FFCB6B;">Post</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> The current user can't create posts... </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #C792EA;">@endcannot</span></div>

Supplying Additional
Context

When authorizing actions using policies, you may pass an array as the second argument to the
various authorization functions and helpers. The first element in the array will be used to
determine which policy should be invoked, while the rest of the array elements are passed as
parameters to the policy method and can be used for additional context when making authorization
decisions. For example, consider the following PostPolicy method definition which
contains an additional $category parameter:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Determine if the given post can be updated by the user.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">update</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">int</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$category</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">bool</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">===</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #89DDFF;">->user_id</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">&&</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">canUpdateCategory</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$category</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

When attempting to determine if the authenticated user can update a given post, we can invoke
this policy method like so:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Update the given blog post.</span></div><div class="line"><span style="color: #697098;"> *</span></div><div class="line"><span style="color: #697098;"> * </span><span style="color: #C792EA;">@throws</span><span style="color: #697098;"> </span><span style="color: #697098;">\</span><span style="color: #697098;">Illuminate</span><span style="color: #697098;">\</span><span style="color: #697098;">Auth</span><span style="color: #697098;">\</span><span style="color: #697098;">Access</span><span style="color: #697098;">\</span><span style="color: #FFCB8B;">AuthorizationException</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">update</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Post</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$post</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">RedirectResponse</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Gate</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">authorize</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">update</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, [</span><span style="color: #BEC5D4;">$post</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->category</span><span style="color: #BFC7D5;">]);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The current user can update the blog post...</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">redirect</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/posts</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Authorization &
Inertia

Although authorization must always be handled on the server, it can often be convenient to
provide your frontend application with authorization data in order to properly render your
application’s UI. Laravel does not define a required convention for exposing authorization
information to an Inertia powered frontend.

However, if you are using one of Laravel’s Inertia-based starter
kits, your application already contains a HandleInertiaRequests
middleware. Within this middleware‘s share method, you
may return shared data that will be provided to all Inertia pages in your application. This
shared data can serve as a convenient location to define authorization information for the user:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>composer require laravel/cashier

After installing the package, publish Cashier’s migrations using the
vendor:publish Artisan command:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan vendor:publish --tag="cashier-migrations"

Then, migrate your database:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan migrate

Cashier’s migrations will add several columns to your users table. They
will also create a new subscriptions table to hold all of your customer’s
subscriptions and a subscription_items table for subscriptions with multiple
prices.

If you wish, you can also publish Cashier’s configuration file using the
vendor:publish Artisan command:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan vendor:publish --tag="cashier-config"

Lastly, to ensure Cashier properly handles all Stripe events, remember to configure Cashier’s webhook handling.

Configuration

Billable Model

Before using Cashier, add the Billable trait to your billable model
definition. Typically, this will be the App\Models\User model. This
trait provides various methods to allow you to perform common billing tasks, such as creating
subscriptions, applying coupons, and updating payment method information:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Billable</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB6B;">User</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">extends</span><span style="color: #BFC7D5;"> </span><span style="color: #A9C77D;">Authenticatable</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Billable</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Cashier assumes your billable model will be the App\Models\User class
that ships with Laravel. If you wish to change this you may specify a different
model via the useCustomerModel method. This method should typically be
called in the boot method of your AppServiceProvider class:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\Cashier\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Cashier</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">useCustomerModel</span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

API Keys

Next, you should configure your Stripe API keys in your application’s
.env file. You can retrieve your Stripe API keys from the Stripe control panel:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">STRIPE_KEY</span><span style="color: #BFC7D5;">=your-stripe-key</span></div><div class="line"><span style="color: #C792EA;">STRIPE_SECRET</span><span style="color: #BFC7D5;">=your-stripe-secret</span></div><div class="line"><span style="color: #C792EA;">STRIPE_WEBHOOK_SECRET</span><span style="color: #BFC7D5;">=your-stripe-webhook-secret</span></div>

Currency Configuration

The default Cashier currency is United States Dollars (USD). You can change the default currency
by setting the CASHIER_CURRENCY environment variable within your
application’s .env file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">CASHIER_CURRENCY</span><span style="color: #BFC7D5;">=eur</span></div>

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
NumberFormatter class to set the currency locale:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">CASHIER_CURRENCY_LOCALE</span><span style="color: #BFC7D5;">=nl_BE</span></div>

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 calculateTaxes method in the boot method of your
application’s App\Providers\AppServiceProvider class:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Cashier</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">calculateTaxes</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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 customer data synchronization and Tax ID methods offered by Cashier to accomplish this.

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 CASHIER_LOGGER environment
variable within your application’s .env file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">CASHIER_LOGGER</span><span style="color: #BFC7D5;">=stack</span></div>

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Subscription</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">as</span><span style="color: #BFC7D5;"> CashierSubscription;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB6B;">Subscription</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">extends</span><span style="color: #BFC7D5;"> </span><span style="color: #A9C77D;">CashierSubscription</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

After defining your model, you may instruct Cashier to use your custom
model via the Laravel\Cashier\Cashier class. Typically, you should
inform Cashier about your custom models in the boot method of your
application’s App\Providers\AppServiceProvider class:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\Cashier\</span><span style="color: #FFCB8B;">Subscription</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\Cashier\</span><span style="color: #FFCB8B;">SubscriptionItem</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Bootstrap any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">boot</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">useSubscriptionModel</span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">useSubscriptionItemModel</span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB8B;">SubscriptionItem</span><span style="color: #89DDFF;">::</span><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Quickstart

Selling Products

Offering product and subscription billing via your application can be intimidating. However,
thanks to Cashier and Stripe Checkout, you
can easily build modern, robust payment integrations.

To charge customers for non-recurring, single-charge products, we’ll utilize Cashier to direct
customers to Stripe Checkout, where they will provide their payment details and confirm their
purchase. Once the payment has been made via Checkout, the customer will be redirected to a
success URL of your choosing within your application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/checkout</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$stripePriceId</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_deluxe_album</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$quantity</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">checkout</span><span style="color: #BFC7D5;">([</span><span style="color: #BEC5D4;">$stripePriceId</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$quantity</span><span style="color: #BFC7D5;">], [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">success_url</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>route('checkout-success'),
 'cancel_url' => route('checkout-cancel'),
    ]);
})->name('checkout');
 
Route::view('/checkout/success', 'checkout.success')->name('checkout-success');
Route::view('/checkout/cancel', 'checkout.cancel')->name('checkout-cancel');

As you can see in the example above, we will utilize Cashier’s provided checkout
method to redirect the customer to Stripe Checkout for a given «price identifier». When using
Stripe, «prices» refer to defined prices
for specific products.

If necessary, the checkout method will automatically create a customer in Stripe and
connect that Stripe customer record to the corresponding user in your application’s
database. After completing the checkout session, the customer will be redirected to
a dedicated success or cancellation page where you can display an informational message to the
customer.

Providing Meta Data to Stripe Checkout

When selling products, it’s common to keep track of completed orders and purchased products via
Cart and Order models defined by your own application.
When redirecting customers to Stripe Checkout to complete a purchase, you may need to provide an
existing order identifier so that you can associate the completed purchase with the
corresponding order when the customer is redirected back to your application.

To accomplish this, you may provide an array of metadata to the
checkout method. Let’s imagine that a pending Order is created within
our application when a user begins the checkout process. Remember, the Cart and
Order models in this example are illustrative and not provided by
Cashier. You are free to implement these concepts based on the needs of your own application:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Cart</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Order</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/cart/{cart}/checkout</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #BFC7D5;">, </span><span style="color: #FFCB8B;">Cart</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$cart</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$order</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Order</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">cart_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$cart</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_ids</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$cart</span><span style="color: #89DDFF;">->price_ids</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">status</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">incomplete</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">    ]);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">checkout</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$order</span><span style="color: #89DDFF;">->price_ids</span><span style="color: #BFC7D5;">, [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">success_url</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>route('checkout-success').'?session_id={CHECKOUT_SESSION_ID}',
 'cancel_url' => route('checkout-cancel'),
 'metadata' => ['order_id' => $order->id],
    ]);
})->name('checkout');

As you can see in the example above, when a user begins the checkout process, we will provide all
of the cart / order’s associated Stripe price identifiers to the checkout method.
Of course, your application is responsible for associating these items with the «shopping cart»
or order as a customer adds them. We also provide the order’s ID to the Stripe Checkout session
via the metadata array. Finally, we have added the CHECKOUT_SESSION_ID
template variable to the Checkout success route. When Stripe redirects customers
back to your application, this template variable will automatically be populated with the
Checkout session ID.

Next, let’s build the Checkout success route. This is the route that
users will be redirected to after their purchase has been completed via Stripe Checkout. Within
this route, we can retrieve the Stripe Checkout session ID and the associated
Stripe Checkout instance in order to access our provided meta data and update our customer’s
order accordingly:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">Order</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Cashier</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/checkout/success</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$sessionId</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">session_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$sessionId</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">===</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">null</span><span style="color: #BFC7D5;">) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$session</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">stripe</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">->checkout->sessions-></span><span style="color: #82AAFF;">retrieve</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$sessionId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$session</span><span style="color: #89DDFF;">->payment_status</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">!==</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">paid</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$orderId</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$session</span><span style="color: #BFC7D5;">[</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">metadata</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">][</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">order_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">] </span><span style="color: #89DDFF;">??</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">null</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$order</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Order</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">findOrFail</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$orderId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$order</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">update</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">status</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">completed</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">]);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>view('checkout-success', ['order' => $order]);
})->name('checkout-success');

Please refer to Stripe’s documentation for more information on the data contained by the Checkout
session object.

Selling
Subscriptions

Offering product and subscription billing via your application can be intimidating. However,
thanks to Cashier and Stripe Checkout, you
can easily build modern, robust payment integrations.

To learn how to sell subscriptions using Cashier and Stripe Checkout, let’s consider the simple
scenario of a subscription service with a basic monthly (price_basic_monthly) and
yearly (price_basic_yearly) plan. These two prices could be grouped under a «Basic»
product (pro_basic) in our Stripe dashboard. In addition, our subscription service
might offer an Expert plan as pro_expert.

First, let’s discover how a customer can subscribe to our services. Of course, you can imagine
the customer might click a «subscribe» button for the Basic plan on our application’s pricing
page. This button or link should direct the user to a Laravel route which creates
the Stripe Checkout session for their chosen plan:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/subscription-checkout</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_basic_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">trialDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">allowPromotionCodes</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">checkout</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">success_url</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>route('your-success-route'),
 'cancel_url' => route('your-cancel-route'),
        ]);
});

As you can see in the example above, we will redirect the customer to a Stripe Checkout session
which will allow them to subscribe to our Basic plan. After a successful checkout or
cancellation, the customer will be redirected back to the URL we provided to the
checkout method. To know when their subscription has actually started (since some
payment methods require a few seconds to process), we’ll also need to configure Cashier’s webhook handling.

Now that customers can start subscriptions, we need to restrict certain portions of our
application so that only subscribed users can access them. Of course, we can always determine a
user’s current subscription status via the subscribed method provided by Cashier’s
Billable trait:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">@if </span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribed</span><span style="color: #BFC7D5;">())</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">p</span><span style="color: #89DDFF;">></span><span style="color: #BFC7D5;">You are subscribed.</span><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">p</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #C792EA;">@endif</span></div>

We can even easily determine if a user is subscribed to specific product or price:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">@if </span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribedToProduct</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">pro_basic</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">))</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">p</span><span style="color: #89DDFF;">></span><span style="color: #BFC7D5;">You are subscribed to our Basic product.</span><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">p</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #C792EA;">@endif</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">@if </span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribedToPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_basic_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">))</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">p</span><span style="color: #89DDFF;">></span><span style="color: #BFC7D5;">You are subscribed to our monthly Basic plan.</span><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">p</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #C792EA;">@endif</span></div>

Building a Subscribed Middleware

For convenience, you may wish to create a middleware
which determines if the incoming request is from a subscribed user. Once this
middleware has been defined, you may easily assign it to a route to
prevent users that are not subscribed from accessing the route:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
 
class Subscribed
{
 /**
     * Handle an incoming request.
 */
 public function handle(Request $request, Closure $next): Response
    {
 if (! $request->user()?->subscribed()) {
 // Redirect user to billing page and ask them to subscribe...
 return redirect('/billing');
        }
 
 return $next($request);
    }
}

Once the middleware has been defined, you may assign it to a route:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Http\Middleware\</span><span style="color: #FFCB8B;">Subscribed</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/dashboard</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">()</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">})</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;"><code>middleware([Subscribed::class]);

Allowing Customers to
Manage Their Billing Plan

Of course, customers may want to change their subscription plan to another product or «tier». The
easiest way to allow this is by directing customers to Stripe’s Customer Billing Portal, which
provides a hosted user interface that allows customers to download invoices, update their
payment method, and change subscription plans.

First, define a link or button within your application that directs users to a Laravel
route which we will utilize to initiate a Billing Portal session:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">a</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">href</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">{{</span><span style="color: #C3E88D;"> </span><span style="color: #82AAFF;"><code>route('billing') }}">

Next, let’s define the route that initiates a Stripe Customer Billing Portal session
and redirects the user to the Portal. The redirectToBillingPortal method accepts
the URL that users should be returned to when exiting the Portal:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/billing</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">redirectToBillingPortal</span><span style="color: #BFC7D5;">(</span><span style="color: #82AAFF;"><code>route('dashboard'));
})->middleware(['auth'])->name('billing');

Customers

Retrieving Customers

You can retrieve a customer by their Stripe ID using the Cashier::findBillable
method. This method will return an instance of the billable model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Cashier</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">findBillable</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$stripeId</span><span style="color: #BFC7D5;">);</span></div>

Creating Customers

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$stripeCustomer</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">createAsStripeCustomer</span><span style="color: #BFC7D5;">();</span></div>

Once the customer has been created in Stripe, you may begin a subscription at a later date. You
may provide an optional $options array to pass in any additional customer creation parameters that are
supported by the Stripe API:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$stripeCustomer</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">createAsStripeCustomer</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$options</span><span style="color: #BFC7D5;">);</span></div>

You may use the asStripeCustomer method if you want to return the Stripe customer
object for a billable model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$stripeCustomer</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">asStripeCustomer</span><span style="color: #BFC7D5;">();</span></div>

The createOrGetStripeCustomer method may be used if you would like to retrieve the
Stripe customer object for a given billable model but are not sure whether the
billable model is already a customer within Stripe. This method will create a new
customer in Stripe if one does not already exist:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$stripeCustomer</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">createOrGetStripeCustomer</span><span style="color: #BFC7D5;">();</span></div>

Updating Customers

Occasionally, you may wish to update the Stripe customer directly with additional information.
You may accomplish this using the updateStripeCustomer method. This method accepts
an array of customer update options
supported by the Stripe API:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$stripeCustomer</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">updateStripeCustomer</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$options</span><span style="color: #BFC7D5;">);</span></div>

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
balance method that is available on your billable model. The
balance method will return a formatted string representation of the balance in the
customer’s currency:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$balance</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">balance</span><span style="color: #BFC7D5;">();</span></div>

To credit a customer’s balance, you may provide a value to the creditBalance method.
If you wish, you may also provide a description:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">creditBalance</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">500</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">Premium customer top-up.</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Providing a value to the debitBalance method will debit the customer’s balance:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">debitBalance</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">300</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">Bad usage penalty.</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

The applyBalance method will create new customer balance transactions for the
customer. You may retrieve these transaction records using the balanceTransactions
method, which may be useful in order to provide a log of credits and debits for the customer to
review:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Retrieve all transactions...</span></div><div class="line"><span style="color: #BEC5D4;">$transactions</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">balanceTransactions</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">foreach</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$transactions</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">as</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$transaction</span><span style="color: #BFC7D5;">) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Transaction amount...</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$amount</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$transaction</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">amount</span><span style="color: #BFC7D5;">(); </span><span style="color: #697098;">//</span><span style="color: #697098;"> $2.31</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Retrieve the related invoice when available...</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$transaction</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoice</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Tax IDs

Cashier offers an easy way to manage a customer’s tax IDs. For example, the taxIds
method may be used to retrieve all of the tax IDs that are assigned to
a customer as a collection:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$taxIds</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">taxIds</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$taxId</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findTaxId</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">txi_belgium</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

You may create a new Tax ID by providing a valid type and
value to the createTaxId method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$taxId</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">createTaxId</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">eu_vat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">BE0123456789</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

The createTaxId method will immediately add the VAT ID to the customer’s account. Verification of VAT IDs
is also done by Stripe; however, this is an asynchronous process. You can be notified of
verification updates by subscribing to the customer.tax_id.updated webhook event
and inspecting the
VAT IDs verification parameter. For more information on handling webhooks,
please consult the documentation on defining webhook
handlers.

You may delete a tax ID using the deleteTaxId method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">deleteTaxId</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">txi_belgium</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 updated event. Then, within your
event listener, you may invoke the syncStripeCustomerDetails method on the
model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> Illuminate\Events\</span><span style="color: #FFCB8B;">queueable</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * The "booted" method of the <code>model.
 */
protected static function booted(): void
{
 static::updated(queueable(function (User $customer) {
 if ($customer->hasStripeId()) {
 $customer->syncStripeCustomerDetails();
 }
 }));
}

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
stripeName method to customize the attribute that should be considered the
customer’s «name» when Cashier syncs customer information to Stripe:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Get the customer name that should be synced to Stripe.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">stripeName</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;">|</span><span style="color: #C792EA;">null</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #FF5572;">$this</span><span style="color: #89DDFF;">->company_name</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Similarly, you may override the stripeEmail, stripePhone,
stripeAddress, and stripePreferredLocales methods. These methods will
sync information to their corresponding customer parameters when updating the Stripe customer object.
If you wish to take total control over the customer information sync process, you may override
the syncStripeCustomerDetails method.

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 redirectToBillingPortal method on the billable
model from a controller or route:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/billing-portal</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">redirectToBillingPortal</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

By default, when the user is finished managing their subscription, they will be able to return to
the home route of your application via a link within the Stripe
billing portal. You may provide a custom URL that the user should return to by passing the URL
as an argument to the redirectToBillingPortal method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/billing-portal</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">redirectToBillingPortal</span><span style="color: #BFC7D5;">(</span><span style="color: #82AAFF;"><code>route('billing'));
});

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$url</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">billingPortalUrl</span><span style="color: #BFC7D5;">(</span><span style="color: #82AAFF;"><code>route('billing'));

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 Billable trait includes the createSetupIntent method to
easily create a new Setup Intent. You should invoke this method from the route or
controller that will render the form which gathers your customer’s payment method
details:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>view('update-payment-method', [
 'intent' => $user->createSetupIntent()
]);

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">input</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">id</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">card-holder-name</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">type</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">text</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span></div><div class="line"> </div><div class="line"><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> Stripe Elements Placeholder </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">div</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">id</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">card-element</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span</span><span style="color: #FF5572;">div</span><span style="color: #89DDFF;">></span></div><div class="line"> </div><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">button</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">id</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">card-button</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">data-secret</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">{{ $intent->client_secret }}</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #BFC7D5;">    Update Payment Method</span></div><div class="line"><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">button</span><span style="color: #89DDFF;">></span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">src</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">https://js.stripe.com/v3/</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;">></span></div><div class="line"> </div><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">stripe</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Stripe</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">stripe-public-key</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">elements</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> stripe</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">elements</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">cardElement</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> elements</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;">    cardElement</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">mount</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">#card-element</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;">></span></div>

Next, the card can be verified and a secure «payment method identifier» can be retrieved from
Stripe using Stripe’s
confirmCardSetup method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">cardHolderName</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> document</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">getElementById</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card-holder-name</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">cardButton</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> document</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">getElementById</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card-button</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">clientSecret</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> cardButton</span><span style="color: #C792EA;">.</span><span style="color: #89DDFF;">dataset</span><span style="color: #C792EA;">.</span><span style="color: #89DDFF;">secret</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;">cardButton</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">addEventListener</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">click</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">async</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #7986E7;">e</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=></span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> { </span><span style="color: #82AAFF;">setupIntent</span><span style="color: #BFC7D5;">, </span><span style="color: #82AAFF;">error</span><span style="color: #BFC7D5;"> } </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">await</span><span style="color: #BFC7D5;"> stripe</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">confirmCardSetup</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;">        clientSecret, {</span></div><div class="line"><span style="color: #BFC7D5;">            payment_method: {</span></div><div class="line"><span style="color: #BFC7D5;">                card: cardElement,</span></div><div class="line"><span style="color: #BFC7D5;">                billing_details: { name: cardHolderName</span><span style="color: #C792EA;">.</span><span style="color: #89DDFF;">value</span><span style="color: #BFC7D5;"> }</span></div><div class="line"><span style="color: #BFC7D5;">            }</span></div><div class="line"><span style="color: #BFC7D5;">        }</span></div><div class="line"><span style="color: #BFC7D5;">    );</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (error) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Display "error.message" to the user...</span></div><div class="line"><span style="color: #BFC7D5;">    } </span><span style="color: #C792EA;">else</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The card has been verified successfully...</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

After the card has been verified by Stripe, you may pass the resulting
setupIntent.payment_method identifier to your Laravel application, where it can be
attached to the customer. The payment method can either be added as a new payment method or used to update the default payment method.
You can also immediately use the payment method identifier to create a new subscription.

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">input</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">id</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">card-holder-name</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">type</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">text</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span></div><div class="line"> </div><div class="line"><span style="color: #697098;"><!--</span></span><span style="color: #697098;"> Stripe Elements Placeholder </span><span style="color: #697098;">--></span></div><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">div</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">id</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">card-element</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span</span><span style="color: #FF5572;">div</span><span style="color: #89DDFF;">></span></div><div class="line"> </div><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">button</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">id</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">card-button</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #BFC7D5;">    Process Payment</span></div><div class="line"><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">button</span><span style="color: #89DDFF;">></span></div>

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">src</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">https://js.stripe.com/v3/</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">></span</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;">></span></div><div class="line"> </div><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">stripe</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Stripe</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">stripe-public-key</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">elements</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> stripe</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">elements</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">cardElement</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> elements</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;">    cardElement</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">mount</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">#card-element</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #89DDFF;"></span</span><span style="color: #FF5572;">script</span><span style="color: #89DDFF;">></span></div>

Next, the card can be verified and a secure «payment method identifier» can be retrieved from
Stripe using Stripe’s
createPaymentMethod method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">cardHolderName</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> document</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">getElementById</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card-holder-name</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">cardButton</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> document</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">getElementById</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card-button</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;">cardButton</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">addEventListener</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">click</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">async</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #7986E7;">e</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=></span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">const</span><span style="color: #BFC7D5;"> { </span><span style="color: #82AAFF;">paymentMethod</span><span style="color: #BFC7D5;">, </span><span style="color: #82AAFF;">error</span><span style="color: #BFC7D5;"> } </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">await</span><span style="color: #BFC7D5;"> stripe</span><span style="color: #C792EA;">.</span><span style="color: #82AAFF;">createPaymentMethod</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, cardElement, {</span></div><div class="line"><span style="color: #BFC7D5;">            billing_details: { name: cardHolderName</span><span style="color: #C792EA;">.</span><span style="color: #89DDFF;">value</span><span style="color: #BFC7D5;"> }</span></div><div class="line"><span style="color: #BFC7D5;">        }</span></div><div class="line"><span style="color: #BFC7D5;">    );</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (error) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> Display "error.message" to the user...</span></div><div class="line"><span style="color: #BFC7D5;">    } </span><span style="color: #C792EA;">else</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> The card has been verified successfully...</span></div><div class="line"><span style="color: #BFC7D5;">    }</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

If the card is verified successfully, you may pass the paymentMethod.id to your
Laravel application and process a single charge.

Retrieving Payment
Methods

The paymentMethods method on the billable model instance returns a
collection of Laravel\Cashier\PaymentMethod instances:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$paymentMethods</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">paymentMethods</span><span style="color: #BFC7D5;">();</span></div>

By default, this method will return payment methods of every type. To retrieve payment methods of
a specific type, you may pass the type as an argument to the method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$paymentMethods</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">paymentMethods</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">sepa_debit</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

To retrieve the customer’s default payment method, the defaultPaymentMethod method
may be used:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">defaultPaymentMethod</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findPaymentMethod</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethodId</span><span style="color: #BFC7D5;">);</span></div>

Payment Method Presence

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasDefaultPaymentMethod</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

You may use the hasPaymentMethod method to determine if a billable
model has at least one payment method attached to their account:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasPaymentMethod</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

This method will determine if the billable model has any payment method at all. To
determine if a payment method of a specific type exists for the model, you may pass
the type as an argument to the method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasPaymentMethod</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">sepa_debit</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Updating
the Default Payment Method

The updateDefaultPaymentMethod method may be used to update a customer’s default
payment method information. This method accepts a Stripe payment method identifier and will
assign the new payment method as the default billing payment method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">updateDefaultPaymentMethod</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">updateDefaultPaymentMethodFromStripe</span><span style="color: #BFC7D5;">();</span></div>

Adding Payment Methods

To add a new payment method, you may call the addPaymentMethod method on the
billable model, passing the payment method identifier:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addPaymentMethod</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

Deleting Payment Methods

To delete a payment method, you may call the delete method on the
Laravel\Cashier\PaymentMethod instance you wish to delete:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">delete</span><span style="color: #BFC7D5;">();</span></div>

The deletePaymentMethod method will delete a specific payment method from the
billable model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">deletePaymentMethod</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">pm_visa</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

The deletePaymentMethods method will delete all of the payment method information
for the billable model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">deletePaymentMethods</span><span style="color: #BFC7D5;">();</span></div>

By default, this method will delete payment methods of every type. To delete payment methods of a
specific type you can pass the type as an argument to the method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">deletePaymentMethods</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">sepa_debit</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 App\Models\User. Once you have retrieved the
model instance, you may use the newSubscription method to create the
model‘s subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/user/subscribe</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span></div><div class="line"><span style="color: #BFC7D5;">    )</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

The first argument passed to the newSubscription method should be the internal type
of the subscription. If your application only offers a single subscription, you might call this
default or primary. This subscription type is only for internal
application usage and is not meant to be shown to users. In addition, it should not contain
spaces and it should never be changed after creating the subscription. The second argument is
the specific price the user is subscribing to. This value should correspond to the price’s
identifier in Stripe.

The create method, which accepts a Stripe payment
method identifier or Stripe PaymentMethod object, will begin the
subscription as well as update your database with the billable model‘s
Stripe customer ID and other relevant billing information.

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">createAndSendInvoice</span><span style="color: #BFC7D5;">();</span></div>

The amount of time a customer has to pay their invoice before their subscription is canceled is
determined by the days_until_due option. By default, this is 30 days; however, you
may provide a specific value for this option if you wish:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">createAndSendInvoice</span><span style="color: #BFC7D5;">([], [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">days_until_due</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">30</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

Quantities

If you would like to set a specific quantity for the price
when creating the subscription, you should invoke the quantity method on the
subscription builder before creating the subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">quantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

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
create method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">, [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">email</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$email</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">], [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">metadata</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">note</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">Some extra information.</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">],</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

Coupons

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">withCoupon</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">code</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">withPromotionCode</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">promo_code_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

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 findPromotionCode method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Find a promotion code ID by its customer facing code...</span></div><div class="line"><span style="color: #BEC5D4;">$promotionCode</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findPromotionCode</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">SUMMERSALE</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Find an active promotion code ID by its customer facing code...</span></div><div class="line"><span style="color: #BEC5D4;">$promotionCode</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findActivePromotionCode</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">SUMMERSALE</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

In the example above, the returned $promotionCode object is an instance of
Laravel\Cashier\PromotionCode. This class decorates an underlying
Stripe\PromotionCode object. You can retrieve the coupon related to the promotion
code by invoking the coupon method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$coupon</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findPromotionCode</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">SUMMERSALE</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">coupon</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$coupon</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isPercentage</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$coupon</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">percentOff</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">.</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">%</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">; </span><span style="color: #697098;">//</span><span style="color: #697098;"> 21.5%</span></div><div class="line"><span style="color: #BFC7D5;">} </span><span style="color: #C792EA;">else</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$coupon</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">amountOff</span><span style="color: #BFC7D5;">(); </span><span style="color: #697098;">//</span><span style="color: #697098;"> $5.99</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$discount</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$billable</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">discount</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$discount</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">discount</span><span style="color: #BFC7D5;">();</span></div>

The returned Laravel\Cashier\Discount instances decorate an underlying
Stripe\Discount object instance. You may retrieve the coupon related to this
discount by invoking the coupon method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$coupon</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">discount</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">coupon</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$billable</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">applyCoupon</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">coupon_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BEC5D4;">$billable</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">applyPromotionCode</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">promotion_code_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">applyCoupon</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">coupon_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">applyPromotionCode</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">promotion_code_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 add method on the subscription builder:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">add</span><span style="color: #BFC7D5;">();</span></div>

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 type of default. To customize the
subscription type that is assigned to dashboard created subscriptions, define webhook event handlers.

In addition, you may only create one type of subscription via the Stripe dashboard. If your
application offers multiple subscriptions that use different types, 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 default subscriptions, only the
most recently added subscription will be used by Cashier even though both would be synced with
your application’s database.

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 subscribed method returns
true if the customer has an active subscription, even if the subscription is
currently within its trial period. The subscribed method accepts the type of the
subscription as its first argument:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribed</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
 
class EnsureUserIsSubscribed
{
 /**
     * Handle an incoming request.
     *
     * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
 */
 public function handle(Request $request, Closure $next): Response
    {
 if ($request->user() && ! $request->user()->subscribed('default')) {
 // This user is not a paying customer...
 return redirect('/billing');
        }
 
 return $next($request);
    }
}

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onTrial</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

The subscribedToProduct method may be used to determine if the user is subscribed to
a given product based on a given Stripe product’s identifier. In Stripe, products are
collections of prices. In this example, we will determine if the user’s default
subscription is actively subscribed to the application’s «premium» product. The given Stripe
product identifier should correspond to one of your product’s identifiers in the Stripe
dashboard:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribedToProduct</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">prod_premium</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

By passing an array to the subscribedToProduct method, you may determine if the
user’s default subscription is actively subscribed to the application’s «basic» or
«premium» product:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribedToProduct</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">prod_basic</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">prod_premium</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">], </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

The subscribedToPrice method may be used to determine if a customer’s subscription
corresponds to a given price ID:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscribedToPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_basic_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

The recurring method may be used to determine if the user is currently subscribed
and is no longer within their trial period:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">recurring</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Canceled
Subscription Status

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">canceled</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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 subscribed method still returns
true during this time:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onGracePeriod</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

To determine if the user has canceled their subscription and is no longer within their «grace
period», you may use the ended method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">ended</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Incomplete and
Past Due Status

If a subscription requires a secondary payment action after creation the subscription will be
marked as incomplete. Subscription statuses are stored in the
stripe_status column of Cashier’s subscriptions database
table.

Similarly, if a secondary payment action is required when swapping prices the subscription will
be marked as past_due. When your subscription is in either of these states it will
not be active until the customer has confirmed their payment. Determining if a subscription has
an incomplete payment may be accomplished using the hasIncompletePayment method on
the billable model or a subscription instance:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasIncompletePayment</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasIncompletePayment</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

When a subscription has an incomplete payment, you should direct the user to Cashier’s payment
confirmation page, passing the latestPayment identifier. You may use the
latestPayment method available on subscription instance to retrieve this
identifier:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">a</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">href</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">{{ <code>route('cashier.payment', $subscription->latestPayment()->id) }}">

If you would like the subscription to still be considered active when it’s in a
past_due or incomplete state, you may use the
keepPastDueSubscriptionsActive and keepIncompleteSubscriptionsActive
methods provided by Cashier. Typically, these methods should be called in the
register method of your App\Providers\AppServiceProvider:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Cashier</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * Register any application services.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">register</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">void</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">keepPastDueSubscriptionsActive</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Cashier</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">keepIncompleteSubscriptionsActive</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Get all active subscriptions...</span></div><div class="line"><span style="color: #BEC5D4;">$subscriptions</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">active</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Get all of the canceled subscriptions for a user...</span></div><div class="line"><span style="color: #BEC5D4;">$subscriptions</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscriptions</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">canceled</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">();</span></div>

A complete list of available scopes is available below:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">active</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">canceled</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">ended</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">incomplete</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">notCanceled</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">notOnGracePeriod</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">notOnTrial</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onGracePeriod</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onTrial</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">pastDue</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #FFCB8B;">Subscription</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">query</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">recurring</span><span style="color: #BFC7D5;">();</span></div>

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
swap method. When swapping prices, it is assumed that the user would like to
re-activate their subscription if it was previously canceled. The given price identifier should
correspond to a Stripe price identifier available in the Stripe dashboard:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_yearly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 skipTrial method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">skipTrial</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_yearly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swapAndInvoice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_yearly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Prorations

By default, Stripe prorates charges when swapping between prices. The noProrate
method may be used to update the subscription’s price without prorating the charges:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">noProrate</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_yearly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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

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 incrementQuantity and
decrementQuantity methods to easily increment or decrement your subscription
quantity:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">incrementQuantity</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Add five to the subscription's current quantity...</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">incrementQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">decrementQuantity</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Subtract five from the subscription's current quantity...</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">decrementQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">);</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">updateQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">);</span></div>

The noProrate method may be used to update the subscription’s quantity without
prorating the charges:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">noProrate</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">updateQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">);</span></div>

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

Quantities for Subscriptions With
Multiple Products

If your subscription is a subscription with
multiple products, 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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">incrementQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 subscription_items database table.

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/user/subscribe</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">    ])</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

In the example above, the customer will have two prices attached to their default
subscription. Both prices will be charged on their respective billing intervals. If necessary,
you may use the quantity method to indicate a specific quantity for each price:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">])</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">quantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

If you would like to add another price to an existing subscription, you may invoke the
subscription’s addPrice method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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
addPriceAndInvoice method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addPriceAndInvoice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

If you would like to add a price with a specific quantity, you can pass the quantity as the
second argument of the addPrice or addPriceAndInvoice methods:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">);</span></div>

You may remove prices from subscriptions using the removePrice method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">removePrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Swapping Prices

You may also change the prices attached to a subscription with multiple products. For example,
imagine a customer has a price_basic subscription with a price_chat
add-on product and you want to upgrade the customer from the price_basic to the
price_pro price:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_pro</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">]);</span></div>

When executing the example above, the underlying subscription item with the
price_basic is deleted and the one with the price_chat is preserved.
Additionally, a new subscription item for the price_pro is created.

You can also specify subscription item options by passing an array of key / value pairs to the
swap method. For example, you may need to specify the subscription price
quantities:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_pro</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">quantity</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">],</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

If you want to swap a single price on a subscription, you may do so using the swap
method on the subscription item itself. This approach is particularly useful if you would like
to preserve all of the existing metadata on the subscription’s other prices:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findItemOrFail</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_basic</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_pro</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 noProrate method onto your price operation:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">noProrate</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">removePrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Quantities

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">incrementQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">decrementQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">3</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">updateQuantity</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Subscription Items

When a subscription has multiple prices, it will have multiple subscription «items» stored in
your database‘s subscription_items table. You may access these via the
items relationship on the subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$subscriptionItem</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">->items-></span><span style="color: #82AAFF;">first</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Retrieve the Stripe price and quantity for a specific item...</span></div><div class="line"><span style="color: #BEC5D4;">$stripePrice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$subscriptionItem</span><span style="color: #89DDFF;">->stripe_price</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BEC5D4;">$quantity</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$subscriptionItem</span><span style="color: #89DDFF;">->quantity</span><span style="color: #BFC7D5;">;</span></div>

You can also retrieve a specific price using the findItemOrFail method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$subscriptionItem</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findItemOrFail</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_chat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

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 type of the subscription to the
newSubscription method. The type may be any string that represents the type of
subscription the user is initiating:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/swimming/subscribe</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">swimming</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">price</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_swimming_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

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 swimming subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">swimming</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">swap</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_swimming_yearly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Of course, you may also cancel the subscription entirely:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">swimming</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">cancel</span><span style="color: #BFC7D5;">();</span></div>

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 meteredPrice to add the metered price
ID to a customer subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/user/subscribe</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">meteredPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_metered</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

You may also start a metered subscription via Stripe Checkout:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$checkout</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Auth</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, [])</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">meteredPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_metered</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">checkout</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;"><code>view('your-checkout-view', [
 'checkout' => $checkout,
]);

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
reportUsage method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">reportUsage</span><span style="color: #BFC7D5;">();</span></div>

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">reportUsage</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">15</span><span style="color: #BFC7D5;">);</span></div>

If your application offers multiple prices on a single subscription, you will need to use the
reportUsageFor method to specify the metered price you want to report usage for:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">reportUsageFor</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_metered</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">15</span><span style="color: #BFC7D5;">);</span></div>

Sometimes, you may need to update usage which you have previously reported. To accomplish this,
you may pass a timestamp or a DateTimeInterface instance as the second parameter to
reportUsage. When doing so, Stripe will update the usage that was reported at that
given time. You can continue to update previous usage records as the given date and time is
still within the current billing period:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">reportUsage</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$timestamp</span><span style="color: #BFC7D5;">);</span></div>

Retrieving Usage Records

To retrieve a customer’s past usage, you may use a subscription instance’s
usageRecords method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$usageRecords</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">usageRecords</span><span style="color: #BFC7D5;">();</span></div>

If your application offers multiple prices on a single subscription, you may use the
usageRecordsFor method to specify the metered price that you wish to retrieve usage
records for:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$usageRecords</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">usageRecordsFor</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_metered</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

The usageRecords and usageRecordsFor methods return a Collection
instance containing an associative array of usage records. You may iterate over this array to
display a customer’s total usage:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;">@</span><span style="color: #C792EA;">foreach</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$usageRecords</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">as</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$usageRecord</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Period</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Starting</span><span style="color: #BFC7D5;">: {{ </span><span style="color: #BEC5D4;">$usageRecord</span><span style="color: #BFC7D5;">[</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">period</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">][</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">start</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">] }}</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Period</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Ending</span><span style="color: #BFC7D5;">: {{ </span><span style="color: #BEC5D4;">$usageRecord</span><span style="color: #BFC7D5;">[</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">period</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">][</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">end</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">] }}</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Total</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">Usage</span><span style="color: #BFC7D5;">: {{ </span><span style="color: #BEC5D4;">$usageRecord</span><span style="color: #BFC7D5;">[</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">total_usage</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">] }}</span></div><div class="line"><span style="color: #89DDFF;">@</span><span style="color: #C792EA;">endforeach</span></div>

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

To specify the tax rates a user pays on a subscription, you should implement the
taxRates method on your billable model and return an array containing
the Stripe tax rate IDs. You can define these tax rates in your Stripe dashboard:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * The tax rates that should apply to the customer's subscriptions.</span></div><div class="line"><span style="color: #697098;"> *</span></div><div class="line"><span style="color: #697098;"> * </span><span style="color: #C792EA;">@return</span><span style="color: #697098;"> </span><span style="color: #C792EA;">array</span><span style="color: #697098;"><</span><span style="color: #C792EA;">int</span><span style="color: #697098;">, string></span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">taxRates</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">array</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">txr_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">];</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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

If you’re offering subscriptions with multiple products, you may define different tax rates for
each price by implementing a priceTaxRates method on your billable
model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;"> * The tax rates that should apply to the customer's subscriptions.</span></div><div class="line"><span style="color: #697098;"> *</span></div><div class="line"><span style="color: #697098;"> * </span><span style="color: #C792EA;">@return</span><span style="color: #697098;"> </span><span style="color: #C792EA;">array</span><span style="color: #697098;"><</span><span style="color: #C792EA;">string</span><span style="color: #697098;">, array<int, string="">></int,></span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">priceTaxRates</span><span style="color: #D9F5DD;">()</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">array</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">txr_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">],</span></div><div class="line"><span style="color: #BFC7D5;">    ];</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Syncing Tax Rates

When changing the hard-coded tax rate IDs returned by the taxRates method, the tax
settings on any existing subscriptions for the user will remain the same. If you wish to update
the tax value for existing subscriptions with the new taxRates values, you should
call the syncTaxRates method on the user’s subscription instance:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">syncTaxRates</span><span style="color: #BFC7D5;">();</span></div>

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 priceTaxRates method discussed above.

Tax Exemption

Cashier also offers the isNotTaxExempt, isTaxExempt, and
reverseChargeApplies methods to determine if the customer is tax exempt. These
methods will call the Stripe API to determine a customer’s tax exemption status:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isTaxExempt</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">isNotTaxExempt</span><span style="color: #BFC7D5;">();</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">reverseChargeApplies</span><span style="color: #BFC7D5;">();</span></div>

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 anchorBillingCycleOn method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/user/subscribe</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$anchor</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">Carbon</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">parse</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">first day of next month</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">anchorBillingCycleOn</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$anchor</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">startOfDay</span><span style="color: #BFC7D5;">())</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

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

Cancelling Subscriptions

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">cancel</span><span style="color: #BFC7D5;">();</span></div>

When a subscription is canceled, Cashier will automatically set the ends_at column
in your subscriptions database table. This column is used to know when
the subscribed method should begin returning false.

For example, if a customer cancels a subscription on March 1st, but the subscription was not
scheduled to end until March 5th, the subscribed method will continue to return
true until March 5th. This is done because a user is typically allowed to continue
using an application until the end of their billing cycle.

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onGracePeriod</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">cancelNow</span><span style="color: #BFC7D5;">();</span></div>

If you wish to cancel a subscription immediately and invoice any remaining un-invoiced metered
usage or new / pending proration invoice items, call the cancelNowAndInvoice method
on the user’s subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">cancelNowAndInvoice</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">cancelAt</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">now</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;">);</span></div>

Finally, you should always cancel user subscriptions before deleting the associated user
model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">cancelNow</span><span style="color: #BFC7D5;">();</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">delete</span><span style="color: #BFC7D5;">();</span></div>

Resuming Subscriptions

If a customer has canceled their subscription and you wish to resume it, you may invoke the
resume method on the subscription. The customer must still be within their «grace
period» in order to resume a subscription:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">resume</span><span style="color: #BFC7D5;">();</span></div>

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 trialDays method when creating your
subscriptions:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/user/subscribe</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">trialDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

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 trialDays method, Cashier will overwrite any default trial
period configured for the price in Stripe.

The trialUntil method allows you to provide a DateTime instance that
specifies when the trial period should end:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Carbon\</span><span style="color: #FFCB8B;">Carbon</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">trialUntil</span><span style="color: #BFC7D5;">(</span><span style="color: #FFCB8B;">Carbon</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">now</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">))</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onTrial</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onTrial</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

You may use the endTrial method to immediately end a subscription trial:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">endTrial</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasExpiredTrial</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">hasExpiredTrial</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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 skipTrial() method.

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 trial_ends_at column on the user record to your desired
trial ending date. This is typically done during user registration:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">([</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">trial_ends_at</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">now</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">10</span><span style="color: #BFC7D5;">),</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onTrial</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> User is within their trial period...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">newSubscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_monthly</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">create</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

To retrieve the user’s trial ending date, you may use the trialEndsAt method. This
method will return a Carbon date instance if a user is on a trial or null if they
aren’t. You may also pass an optional subscription type parameter if you would like to get the
trial ending date for a specific subscription other than the default one:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onTrial</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$trialEndsAt</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">trialEndsAt</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">main</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">if</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">onGenericTrial</span><span style="color: #BFC7D5;">()) {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> User is within their "generic" trial period...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Extending Trials

The extendTrial method allows you to extend the trial period of a subscription after
the subscription has been created. If the trial has already expired and the customer is already
being billed for the subscription, you can still offer them an extended trial. The time spent
within the trial period will be deducted from the customer’s next invoice:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$subscription</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">find</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">1</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> End the trial 7 days from now...</span></div><div class="line"><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">extendTrial</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">now</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">addDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">7</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #697098;">//</span><span style="color: #697098;"> Add an additional 5 days to the trial...</span></div><div class="line"><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">extendTrial</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$subscription</span><span style="color: #89DDFF;">->trial_ends_at-></span><span style="color: #82AAFF;">addDays</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;">);</span></div>

Handling Stripe Webhooks

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 /stripe/webhook URL path. The full list of all webhooks you should
enable in the Stripe control panel are:

• customer.subscription.created
• customer.subscription.updated
• customer.subscription.deleted
• customer.updated
• customer.deleted
• payment_method.automatically_updated
• invoice.payment_action_required
• invoice.payment_succeeded

For convenience, Cashier includes a cashier:webhook Artisan command. This command
will create a webhook in Stripe that listens to all of the events required by Cashier:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan cashier:webhook

By default, the created webhook will point to the URL defined by the APP_URL
environment variable and the cashier.webhook route that
is included with Cashier. You may provide the --url option when invoking the
command if you would like to use a different URL:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan cashier:webhook --url "https://example.com/stripe/webhook"

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
--api-version option:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan cashier:webhook --api-version="2019-12-03"

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 --disabled option when
invoking the command:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BFC7D5;"><code>php artisan cashier:webhook --disabled

Webhooks and CSRF
Protection

Since Stripe webhooks need to bypass Laravel’s CSRF protection, you
should ensure that Laravel does not attempt to validate the CSRF token for incoming Stripe
webhooks. To accomplish this, you should exclude stripe/* from CSRF protection in
your application’s bootstrap/app.php file:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">withMiddleware</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Middleware</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$<code>middleware) {
 $middleware->validateCsrfTokens(except: [
 'stripe/*',
    ]);
})

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:

• Laravel\Cashier\Events\WebhookReceived
• Laravel\Cashier\Events\WebhookHandled

Both events contain the full payload of the Stripe webhook. For example, if you wish to handle
the invoice.payment_succeeded webhook, you may register a listener that will handle the event:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #D3423E;"><code>php</span
 
namespace App\Listeners;
 
use Laravel\Cashier\Events\WebhookReceived;
 
class StripeEventListener
{
 /**
     * Handle received Stripe webhooks.
 */
 public function handle(WebhookReceived $event): void
    {
 if ($event->payload['type'] === 'invoice.payment_succeeded') {
 // Handle the incoming event...
        }
    }
}

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 STRIPE_WEBHOOK_SECRET
environment variable is set in your application’s .env file. The
webhook secret may be retrieved from your Stripe account dashboard.

Single Charges

Simple Charge

If you would like to make a one-time charge against a customer, you may use the
charge method on a billable model instance. You will need to provide a payment method identifier as the
second argument to the charge method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/purchase</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$stripeCharge</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">charge</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">100</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">->paymentMethodId</span></div><div class="line"><span style="color: #BFC7D5;">    );</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

The charge method accepts an array as its third argument, allowing you to pass any
options you wish to the underlying Stripe charge creation. More information regarding the
options available to you when creating charges may be found in the Stripe documentation:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">charge</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">100</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">, [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">custom_option</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$value</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

You may also use the charge method without an underlying customer or user. To
accomplish this, invoke the charge method on a new instance of your application’s
billable model:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> App\Models\</span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$stripeCharge</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> (</span><span style="color: #89DDFF;">new</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB8B;">User</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">charge</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">100</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div>

The charge method will throw an exception if the charge fails. If the charge is
successful, an instance of Laravel\Cashier\Payment will be returned from the
method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">try</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$payment</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">charge</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">100</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$paymentMethod</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">} </span><span style="color: #C792EA;">catch</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB6B;">Exception</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$e</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">//</span><span style="color: #697098;"> ...</span></div><div class="line"><span style="color: #BFC7D5;">}</span></div>

Charge With Invoice

Sometimes you may need to make a one-time charge and offer a PDF invoice to your customer. The
invoicePrice method lets you do just that. For example, let’s invoice a customer
for five new shirts:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoicePrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_tshirt</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">);</span></div>

The invoice will be immediately charged against the user’s default payment method. The
invoicePrice method also accepts an array as its third argument. This array
contains the billing options for the invoice item. The fourth argument accepted by the method is
also an array which should contain the billing options for the invoice itself:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoicePrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_tshirt</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">, [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">discounts</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span></div><div class="line"><span style="color: #BFC7D5;">        [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">coupon</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">SUMMER21SALE</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">]</span></div><div class="line"><span style="color: #BFC7D5;">    ],</span></div><div class="line"><span style="color: #BFC7D5;">], [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default_tax_rates</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">txr_id</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">],</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

Similarly to invoicePrice, you may use the tabPrice method to create a
one-time charge for multiple items (up to 250 items per invoice) by adding them to the
customer’s «tab» and then invoicing the customer. For example, we may invoice a customer for
five shirts and two mugs:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">tabPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_tshirt</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">5</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">tabPrice</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_mug</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">2</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoice</span><span style="color: #BFC7D5;">();</span></div>

Alternatively, you may use the invoiceFor method to make a «one-off» charge against
the customer’s default payment method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoiceFor</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">One Time Fee</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #F78C6C;">500</span><span style="color: #BFC7D5;">);</span></div>

Although the invoiceFor method is available for you to use, it is recommended that
you use the invoicePrice and tabPrice methods with pre-defined prices.
By doing so, you will have access to better analytics and data within your Stripe dashboard
regarding your sales on a per-product basis.

Creating Payment Intents

You can create a new Stripe payment intent by invoking the pay method on a billable
model instance. Calling this method will create a payment intent that is wrapped in
a Laravel\Cashier\Payment instance:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/pay</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$payment</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">pay</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">amount</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;">    );</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$payment</span><span style="color: #89DDFF;">->client_secret</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

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 pay method, the default payment methods that are enabled within your
Stripe dashboard will be available to the customer. Alternatively, if you only want to allow for
some specific payment methods to be used, you may use the payWith method:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">post</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/pay</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$payment</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">payWith</span><span style="color: #BFC7D5;">(</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">amount</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">), [</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">card</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">bancontact</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">]</span></div><div class="line"><span style="color: #BFC7D5;">    );</span></div><div class="line"> </div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$payment</span><span style="color: #89DDFF;">->client_secret</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

Refunding Charges

If you need to refund a Stripe charge, you may use the refund method. This method
accepts the Stripe payment intent ID as its
first argument:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$payment</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">charge</span><span style="color: #BFC7D5;">(</span><span style="color: #F78C6C;">100</span><span style="color: #BFC7D5;">, </span><span style="color: #BEC5D4;">$paymentMethodId</span><span style="color: #BFC7D5;">);</span></div><div class="line"> </div><div class="line"><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">refund</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$payment</span><span style="color: #89DDFF;">->id</span><span style="color: #BFC7D5;">);</span></div>

Invoices

Retrieving Invoices

You may easily retrieve an array of a billable model‘s invoices using the
invoices method. The invoices method returns a collection of
Laravel\Cashier\Invoice instances:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoices</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoices</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoices</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">invoicesIncludingPending</span><span style="color: #BFC7D5;">();</span></div>

You may use the findInvoice method to retrieve a specific invoice by its ID:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">findInvoice</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$invoiceId</span><span style="color: #BFC7D5;">);</span></div>

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:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;"><</span><span style="color: #82AAFF;">table</span><span style="color: #C792EA;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">@</span><span style="color: #C792EA;">foreach</span><span style="color: #BFC7D5;"> (</span><span style="color: #BEC5D4;">$invoices</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">as</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;">)</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;"><</span><span style="color: #82AAFF;">tr</span><span style="color: #C792EA;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;"><</span><span style="color: #82AAFF;">td</span><span style="color: #C792EA;">></span><span style="color: #BFC7D5;">{{ </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">date</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">toFormattedDateString</span><span style="color: #BFC7D5;">() }}</span><span style="color: #C792EA;"><</span><span style="color: #89DDFF;">/</span><span style="color: #82AAFF;">td</span><span style="color: #C792EA;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;"><</span><span style="color: #82AAFF;">td</span><span style="color: #C792EA;">></span><span style="color: #BFC7D5;">{{ </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">total</span><span style="color: #BFC7D5;">() }}</span><span style="color: #C792EA;"><</span><span style="color: #89DDFF;">/</span><span style="color: #82AAFF;">td</span><span style="color: #C792EA;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;"><</span><span style="color: #82AAFF;">td</span><span style="color: #C792EA;">><</span><span style="color: #82AAFF;">a</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">href</span><span style="color: #C792EA;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">/user/invoice/{{ </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #89DDFF;">->id</span><span style="color: #C3E88D;"> }}</span><span style="color: #D9F5DD;">"</span><span style="color: #C792EA;">></span><span style="color: #82AAFF;">Download</span><span style="color: #C792EA;"><</span><span style="color: #89DDFF;">/</span><span style="color: #82AAFF;">a</span><span style="color: #C792EA;">><</span><span style="color: #89DDFF;">/</span><span style="color: #82AAFF;">td</span><span style="color: #C792EA;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;"><</span><span style="color: #89DDFF;">/</span><span style="color: #82AAFF;">tr</span><span style="color: #C792EA;">></span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">@</span><span style="color: #C792EA;">endforeach</span></div><div class="line"><span style="color: #C792EA;"><</span><span style="color: #89DDFF;">/</span><span style="color: #82AAFF;">table</span><span style="color: #C792EA;">></span></div>

Upcoming Invoices

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">upcomingInvoice</span><span style="color: #BFC7D5;">();</span></div>

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">upcomingInvoice</span><span style="color: #BFC7D5;">();</span></div>

Previewing Subscription Invoices

Using the previewInvoice method, you can preview an invoice before
making price changes. This will allow you to determine what your customer’s invoice will look
like when a given price change is made:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">pre<code>viewInvoice('price_yearly');

You may pass an array of prices to the previewInvoice method in order to
preview invoices with multiple new prices:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$user</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">subscription</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">default</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">)</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">pre<code>viewInvoice(['price_yearly', 'price_metered']);

Generating Invoice PDFs

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #82AAFF;"><code>composer require dompdf/dompdf

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

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/user/invoice/{invoice}</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">string</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$invoiceId</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">downloadInvoice</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$invoiceId</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

By default, all data on the invoice is derived from the customer and invoice data stored in
Stripe. The filename is based on your app.name config value. However,
you can customize some of this data by providing an array as the second argument to the
downloadInvoice method. This array allows you to customize information such as your
company and product details:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">downloadInvoice</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$invoiceId</span><span style="color: #BFC7D5;">, [</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">vendor</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">Your Company</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">product</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">Your Product</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">street</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">Main Str. 1</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">location</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">2000 Antwerp, Belgium</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">phone</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">+32 499 00 00 00</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">email</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;"><a class="__cf_email__" data-cfemail="4b22252d240b2e332a263b272e65282426" href="https://laravel.com/cdn-cgi/l/email-protection">[email protected]</a></span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">url</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">https://example.com</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">vendorVat</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">BE123456789</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">,</span></div><div class="line"><span style="color: #BFC7D5;">]);</span></div>

The downloadInvoice method also allows for a custom filename via its third argument.
This filename will automatically be suffixed with .pdf:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">downloadInvoice</span><span style="color: #BFC7D5;">(</span><span style="color: #BEC5D4;">$invoiceId</span><span style="color: #BFC7D5;">, [], </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">my-invoice</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div>

Custom Invoice Renderer

Cashier also makes it possible to use a custom invoice renderer. By default, Cashier uses the
DompdfInvoiceRenderer implementation, which utilizes the dompdf PHP library to generate Cashier’s
invoices. However, you may use any renderer you wish by implementing the
Laravel\Cashier\Contracts\InvoiceRenderer interface. For example, you may wish to
render an invoice PDF using an API call to a third-party PDF rendering service:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Support\Facades\</span><span style="color: #FFCB8B;">Http</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\Contracts\</span><span style="color: #FFCB8B;">InvoiceRenderer</span><span style="color: #BFC7D5;">;</span></div><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Laravel\Cashier\</span><span style="color: #FFCB8B;">Invoice</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #C792EA;">class</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB6B;">ApiInvoiceRenderer</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">implements</span><span style="color: #BFC7D5;"> </span><span style="color: #A9C77D;">InvoiceRenderer</span></div><div class="line"><span style="color: #BFC7D5;">{</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #697098;">/**</span></div><div class="line"><span style="color: #697098;">     * Render the given invoice and return the raw PDF bytes.</span></div><div class="line"><span style="color: #697098;"> </span><span style="color: #697098;">*/</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">public</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">render</span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Invoice</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">array</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$data</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> [], </span><span style="color: #C792EA;">array</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$options</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> []</span><span style="color: #D9F5DD;">)</span><span style="color: #89DDFF;">:</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">string</span></div><div class="line"><span style="color: #BFC7D5;">    {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$html</span><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">=</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$invoice</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;"><code>view($data)->render();
 
 return Http::get('https://example.com/html-to-pdf', ['html' => $html])->get()->body();
    }
}

Once you have implemented the invoice renderer contract, you should update the
cashier.invoices.renderer configuration value in your application’s
config/cashier.php configuration file. This configuration
value should be set to the class name of your custom renderer implementation.

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 checkout method on a billable model. The
checkout method will initiate a new Stripe Checkout session. By default, you’re
required to pass a Stripe Price ID:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/product-checkout</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">checkout</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_tshirt</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

If needed, you may also specify a product quantity:

<!-- Syntax highlighted by torchlight.dev --><div class="line"><span style="color: #C792EA;">use</span><span style="color: #BFC7D5;"> Illuminate\Http\</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;">;</span></div><div class="line"> </div><div class="line"><span style="color: #FFCB8B;">Route</span><span style="color: #89DDFF;">::</span><span style="color: #82AAFF;">get</span><span style="color: #BFC7D5;">(</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/product-checkout</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">, </span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Request</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class="line"><span style="color: #BFC7D5;"> </span><span style="color: #C792EA;">return</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$request</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">user</span><span style="color: #BFC7D5;">()</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">checkout</span><span style="color: #BFC7D5;">([</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">price_tshirt</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">=></span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">15</span><span style="color: #BFC7D5;">]);</span></div><div class="line"><span style="color: #BFC7D5;">});</span></div>

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 home route location, but you may specify custom callback URLs
using the success_url and cancel_url options: