Polar for Laravel

Seamlessly integrate Polar.sh subscriptions and payments into your Laravel application. This package provides an elegant way to handle subscriptions, manage recurring payments, and interact with Polar’s API. With built-in support for webhooks, subscription management, and a fluent API, you can focus on building your application while we handle the complexities of subscription billing.

Installation

Step 1: You can install the package via composer:

composer require danestves/laravel-polar

Step 2: Run :install:

php artisan polar:install

This will publish the config, migrations and views, and ask to run the migrations. Or publish and run the migrations individually:

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

php artisan vendor:publish --tag="polar-config"

php artisan vendor:publish --tag="polar-views"

php artisan migrate

This is the contents of the published config file:

<?php

return [
    /*
    |--------------------------------------------------------------------------
    | Polar Access Token
    |--------------------------------------------------------------------------
    |
    | The Polar access token is used to authenticate with the Polar API.
    | You can find your access token in the Polar dashboard > Settings
    | under the "Developers" section.
    |
    */
    'access_token' => env('POLAR_ACCESS_TOKEN'),

    /*
    |--------------------------------------------------------------------------
    | Polar Webhook Secret
    |--------------------------------------------------------------------------
    |
    | The Polar webhook secret is used to verify that the webhook requests
    | are coming from Polar. You can find your webhook secret in the Polar
    | dashboard > Settings > Webhooks on each registered webhook.
    |
    | We (the developers) recommend using a single webhook for all your
    | integrations. This way you can use the same secret for all your
    | integrations and you don't have to manage multiple webhooks.
    |
    */
    'webhook_secret' => env('POLAR_WEBHOOK_SECRET'),

    /*
    |--------------------------------------------------------------------------
    | Polar Url Path
    |--------------------------------------------------------------------------
    |
    | This is the base URI where routes from Polar will be served
    | from. The URL built into Polar is used by default; however,
    | you can modify this path as you see fit for your application.
    |
    */
    'path' => env('POLAR_PATH', 'polar'),

    /*
    |--------------------------------------------------------------------------
    | Default Redirect URL
    |--------------------------------------------------------------------------
    |
    | This is the default redirect URL that will be used when a customer
    | is redirected back to your application after completing a purchase
    | from a checkout session in your Polar account.
    |
    */
    'redirect_url' => null,

    /*
    |--------------------------------------------------------------------------
    | Currency Locale
    |--------------------------------------------------------------------------
    |
    | This is the default locale in which your money values are formatted in
    | for display. To utilize other locales besides the default "en" locale
    | verify you have to have the "intl" PHP extension installed on the system.
    |
    */
    'currency_locale' => env('POLAR_CURRENCY_LOCALE', 'en'),
];

Usage

Access Token

Configure your access token. Create a new token in the Polar Dashboard > Settings > Developers and paste it in the .env file.

https://sandbox.polar.sh/dashboard/ORG_SLUG/settings (Sandbox)
https://polar.sh/dashboard/ORG_SLUG/settings (Production)

POLAR_ACCESS_TOKEN="<your_access_token>"

Webhook Secret

Configure your webhook secret. Create a new webhook in the Polar Dashboard > Settings > Webhooks.

https://sandbox.polar.sh/dashboard/ORG_SLUG/settings/webhooks (Sandbox)
https://polar.sh/dashboard/ORG_SLUG/settings/webhooks (Production)

Configure the webhook for the following events that this pacckage supports:

order.created
order.updated
subscription.created
subscription.updated
subscription.active
subscription.canceled
subscription.revoked
benefit_grant.created
benefit_grant.updated
benefit_grant.revoked

POLAR_WEBHOOK_SECRET="<your_webhook_secret>"

Billable Trait

Let’s make sure everything’s ready for your customers to checkout smoothly. 🛒 First, we’ll need to set up a model to handle billing—don’t worry, it’s super simple! In most cases, this will be your app’s User model. Just add the Billable trait to your model like this (you’ll import it from the package first, of course):

use Danestves\LaravelPolar\Billable;

class User extends Authenticatable
{
    use Billable;
}

Now the user model will have access to the methods provided by the package. You can make any model billable by adding the trait to it, not just the User model.

Polar Script

Polar includes a JavaScript script that you can use to initialize the Polar Embedded Checkout. If you going to use this functionality, you can use the @polarEmbedScript directive to include the script in your views inside the <head> tag.

<head>
    ...

    @polarEmbedScript
</head>

Webhooks

This package includes a webhook handler that will handle the webhooks from Polar.

Webhooks & CSRF Protection

Incoming webhooks should not be affected by CSRF protection. To prevent this, add your webhook path to the except list of your App\Http\Middleware\VerifyCsrfToken middleware:

protected $except = [
    'polar/*',
];

Or if you’re using Laravel v11 and up, you should exclude polar/* in your application’s bootstrap/app.php file:

->withMiddleware(function (Middleware $middleware) {
    $middleware->validateCsrfTokens(except: [
        'polar/*',
    ]);
})

Commands

This package includes a list of commands that you can use to retrieve information about your Polar account.

Command	Description
`php artisan polar:products`	List all available products with their ids

Checkouts

Single Payments

To create a checkout to show only a single payment, pass a single items to the array of products when creating the checkout.

use Illuminate\Http\Request;

Route::get('/subscribe', function (Request $request) {
    return $request->user()->checkout(['product_id_123']);
});

If you want to show multiple products that the user can choose from, you can pass an array of product ids to the checkout method.

use Illuminate\Http\Request;

Route::get('/subscribe', function (Request $request) {
    return $request->user()->checkout(['product_id_123', 'product_id_456']);
});

This could be useful if you want to offer monthly, yearly, and lifetime plans for example.

[!NOTE] If you are requesting the checkout a lot of times we recommend you to cache the URL returned by the checkout method.

Custom Price

You can override the price of a product using the charge method.

use Illuminate\Http\Request;

Route::get('/subscribe', function (Request $request) {
    return $request->user()->charge(1000, ['product_id_123']);
});

Embedded Checkout

Instead of redirecting the user you can create the checkout link, pass it to the page and use our blade component:

use Illuminate\Http\Request;

Route::get('/billing', function (Request $request) {
    $checkout = $request->user()->checkout(['product_id_123']);

    return view('billing', ['checkout' => $checkout]);
});

Now we can use the button like this:

<x-polar-button :checkout="$checkout" />

The component accepts the normal props that a link element accepts. You can change the theme of the embedded checkout by using the following prop:

<x-polar-button :checkout="$checkout" data-polar-checkout-theme="dark" />

It defaults to light theme, so you only need to pass the prop if you want to change it.

Prefill Customer Information

You can override the user data using the following methods in your models provided by the Billable trait.

public function polarName(): ?string; // default: $model->name
public function polarEmail(): ?string; // default: $model->email

Redirects After Purchase

You can redirect the user to a custom page after the purchase using the withSuccessUrl method:

$request->user()->checkout('variant-id')
    ->withSuccessUrl(url('/success'));

You can also add the checkout_id={CHECKOUT_ID} query parameter to the URL to retrieve the checkout session id:

$request->user()->checkout('variant-id')
    ->withSuccessUrl(url('/success?checkout_id={CHECKOUT_ID}'));

Custom metadata and customer metadata

You can add custom metadata to the checkout session using the withMetadata method:

$request->user()->checkout('variant-id')
    ->withMetadata(['key' => 'value']);

You can also add customer metadata to the checkout session using the withCustomerMetadata method:

$request->user()->checkout('variant-id')
    ->withCustomerMetadata(['key' => 'value']);

These will then be available in the relevant webhooks for you.

Reserved Keywords

When working with custom data, this library has a few reserved terms.

billable_id
billable_type
subscription_type

Using any of these will result in an exception being thrown.

Customers

Customer Portal

Customers can update their personal information (e.g., name, email address) by accessing their self-service customer portal. To redirect customers to this portal, call the redirectToCustomerPortal() method on your billable model (e.g., the User model).

use Illuminate\Http\Request;

Route::get('/customer-portal', function (Request $request) {
    return $request->user()->redirectToCustomerPortal();
});

Optionally, you can obtain the signed customer portal URL directly:

$url = $user->customerPortalUrl();

Orders

Retrieving Orders

You can retrieve orders by using the orders relationship on the billable model:

<table>
    @foreach ($user->orders as $order)
        <td>{{ $order->ordered_at->toFormattedDateString() }}</td>
        <td>{{ $order->polar_id }}</td>
        <td>{{ $order->amount }}</td>
        <td>{{ $order->tax_amount }}</td>
        <td>{{ $order->refunded_amount }}</td>
        <td>{{ $order->refunded_tax_amount }}</td>
        <td>{{ $order->currency }}</td>
        <!-- Add more columns as needed -->
    @endforeach
</table>

Check order status

You can check the status of an order by using the status attribute:

$order->status;

Or you can use some of the helper methods offers by the Order model:

$order->paid();

Aside from that, you can run two other checks: refunded, and partially refunded. If the order is refunded, you can utilize the refunded_at timestamp:

@if ($order->refunded())
    Order {{ $order->polar_id }} was refunded on {{ $order->refunded_at->toFormattedDateString() }}
@endif

You may also see if an order was for a certain product:

if ($order->hasProduct('product_id_123')) {
    // ...
}

Or for an specific price:

if ($order->hasPrice('price_id_123')) {
    // ...
}

Furthermore, you can check if a consumer has purchased a specific product:

if ($user->hasPurchasedProduct('product_id_123')) {
    // ...
}

Or for an specific price:

if ($user->hasPurchasedPrice('price_id_123')) {
    // ...
}

Subscriptions

Creating Subscriptions

Starting a subscription is simple. For this, we require our product’s variant id. Copy the product id and start a new subscription checkout using your billable model:

use Illuminate\Http\Request;

Route::get('/subscribe', function (Request $request) {
    return $request->user()->subscribe('product_id_123');
});

When a customer completes their checkout, the incoming SubscriptionCreated event webhook connects it to your billable model in the database. You may then get the subscription from your billable model:

$subscription = $user->subscription();

Checking Subscription Status

Once a consumer has subscribed to your services, you can use a variety of methods to check on the status of their subscription. The most basic example is to check if a customer has a valid subscription.

if ($user->subscribed()) {
    // ...
}

You can utilize this in a variety of locations in your app, such as middleware, rules, and so on, to provide services. To determine whether an individual subscription is valid, you can use the valid method:

if ($user->subscription()->valid()) {
    // ...
}

This method, like the subscribed method, returns true if your membership is active, on trial, past due, or cancelled during its grace period. You may also check if a subscription is for a certain product:

if ($user->subscription()->hasProduct('product_id_123')) {
    // ...
}

Or for a certain price:

if ($user->subscription()->hasPrice('price_id_123')) {
    // ...
}

If you wish to check if a subscription is on a specific price while being valid, you can use:

if ($user->subscribedToPrice('price_id_123')) {
    // ...
}

Alternatively, if you use different subscription types, you can pass a type as an additional parameter:

if ($user->subscribed('swimming')) {
    // ...
}

if ($user->subscribedToPrice('price_id_123', 'swimming')) {
    // ...
}

Cancelled Status

To see if a user has cancelled their subscription, you can use the cancelled method:

if ($user->subscription()->cancelled()) {
    // ...
}

When they are in their grace period, you can utilize the onGracePeriod check.

if ($user->subscription()->onGracePeriod()) {
    // ...
}

Past Due Status

If a recurring payment fails, the subscription will become past due. This indicates that the subscription is still valid, but your customer’s payments will be retried in two weeks.

if ($user->subscription()->pastDue()) {
    // ...
}

Subscription Scopes

There are several subscription scopes available for querying subscriptions in specific states:

// Get all active subscriptions...
$subscriptions = Subscription::query()->active()->get();

// Get all of the cancelled subscriptions for a specific user...
$subscriptions = $user->subscriptions()->cancelled()->get();

Here’s all available scopes:

Subscription::query()->incomplete();
Subscription::query()->incompleteExpired();
Subscription::query()->onTrial();
Subscription::query()->active();
Subscription::query()->pastDue();
Subscription::query()->unpaid();
Subscription::query()->cancelled();

Changing Plans

When a consumer is on a monthly plan, they may desire to upgrade to a better plan, alter their payments to an annual plan, or drop to a lower-cost plan. In these cases, you can allow them to swap plans by giving a different product id to the swap method:

use App\Models\User;

$user = User::find(1);

$user->subscription()->swap('product_id_123');

This will change the customer’s subscription plan, however billing will not occur until the next payment cycle. If you want to immediately invoice the customer, you can use the swapAndInvoice method instead.

$user = User::find(1);

$user->subscription()->swapAndInvoice('product_id_123');

Multiple Subscriptions

In certain situations, you may wish to allow your consumer to subscribe to numerous subscription kinds. For example, a gym may provide a swimming and weight lifting subscription. You can let your customers subscribe to one or both. To handle the various subscriptions, you can offer a type of subscription as the second argument when creating a new one:

$user = User::find(1);

$checkout = $user->subscribe('product_id_123', 'swimming');

You can now always refer to this specific subscription type by passing the type argument when getting it:

$user = User::find(1);

// Retrieve the swimming subscription type...
$subscription = $user->subscription('swimming');

// Swap plans for the gym subscription type...
$user->subscription('gym')->swap('product_id_123');

// Cancel the swimming subscription...
$user->subscription('swimming')->cancel();

Cancelling Subscriptions

To cancel a subscription, call the cancel method.

$user = User::find(1);

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

This will cause your subscription to be cancelled. If you cancel your subscription in the middle of the cycle, it will enter a grace period, and the ends_at column will be updated. The customer will continue to have access to the services offered for the duration of the period. You may check the grace period by calling the onGracePeriod method:

if ($user->subscription()->onGracePeriod()) {
    // ...
}

Polar does not offer immediate cancellation. To resume a subscription while it is still in its grace period, use the resume method.

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

When a cancelled subscription approaches the end of its grace period, it becomes expired and cannot be resumed.

Handling Webhooks

Polar can send webhooks to your app, allowing you to react. By default, this package handles the majority of the work for you. If you have properly configured webhooks, it will listen for incoming events and update your database accordingly. We recommend activating all event kinds so you may easily upgrade in the future.

Webhook Events

Danestves\LaravelPolar\Events\BenefitGrantCreated
Danestves\LaravelPolar\Events\BenefitGrantUpdated
Danestves\LaravelPolar\Events\BenefitGrantRevoked
Danestves\LaravelPolar\Events\OrderCreated
Danestves\LaravelPolar\Events\OrderRefunded
Danestves\LaravelPolar\Events\SubscriptionActive
Danestves\LaravelPolar\Events\SubscriptionCanceled
Danestves\LaravelPolar\Events\SubscriptionCreated
Danestves\LaravelPolar\Events\SubscriptionRevoked
Danestves\LaravelPolar\Events\SubscriptionUpdated

Each of these events has a billable $model object and an event $payload. The subscription events also include the $subscription object. These can be accessed via the public properties. If you wish to respond to these events, you must establish listeners for them. For example, you may wish to react when a subscription is updated.

<?php

namespace App\Listeners;

use Danestves\LaravelPolar\Events\WebhookHandled;

class PolarEventListener
{
    /**
     * Handle received Polar webhooks.
     */
    public function handle(WebhookHandled $event): void
    {
        if ($event->payload['type'] === 'subscription.updated') {
            // Handle the incoming event...
        }
    }
}

The Polar documentation includes an example payload. Laravel v11 and up will automatically discover the listener. If you’re using Laravel v10 or lower, you should configure it in your app’s EventServiceProvider:

<?php

namespace App\Providers;

use App\Listeners\PolarEventListener;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Danestves\LaravelPolar\Events\WebhookHandled;

class EventServiceProvider extends ServiceProvider
{
    protected $listen = [
        WebhookHandled::class => [
            PolarEventListener::class,
        ],
    ];
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

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

Bootup

Features

Integrate

Merchant of Record (MoR)

​Polar for Laravel

​Installation

​Usage

​Access Token

​Webhook Secret

​Billable Trait

​Polar Script

​Webhooks

​Webhooks & CSRF Protection

​Commands

​Checkouts

​Single Payments

​Custom Price

​Embedded Checkout

​Prefill Customer Information

​Redirects After Purchase

​Custom metadata and customer metadata

​Reserved Keywords

​Customers

​Customer Portal

​Orders

​Retrieving Orders

​Check order status

​Subscriptions

​Creating Subscriptions

​Checking Subscription Status

​Cancelled Status

​Past Due Status

​Subscription Scopes

​Changing Plans

​Multiple Subscriptions

​Cancelling Subscriptions

​Handling Webhooks

​Webhook Events

​Testing

​Changelog

​License