README

⚠️ I'm unsure about the future of this package. I might be abandoning it, so please consider using Laravel Cashier (Paddle).

Laravel Paddle

This package provides an integration with Paddle.com for Laravel. Read the blogpost about the introduction of the package!

Features

Super easy wrapper around the Paddle.com API
Built-in support for Webhooks and Event handling
Blade directive to use Paddle.js in your front-end
Support for Paddle Sandbox

Sponsor Us

❤️ We proudly support the community by developing Laravel packages and giving them away for free. If this package saves you time or if you're relying on it professionally, please consider sponsoring the maintenance and development and check out our latest premium package: Inertia Table. Keeping track of issues and pull requests takes time, but we're happy to help!

Installation

Only the master branch and version 2.0 of this package are compatible with Laravel 8.0 and higher. If you're still using an older version of Laravel (or PHP < 7.3), please use the chart below to find out which version you should use. Mind that older versions are no longer supported.

You can install the package via composer:

composer require protonemedia/laravel-paddle

Configuration

Publish the config file:

php artisan vendor:publish --provider="ProtoneMedia\LaravelPaddle\PaddleServiceProvider" --tag=config

Set your Vendor ID and Code and the Public Key settings in your .env file or in the config/paddle.php file. The Public Key is used to verify incoming webhooks from Paddle.

PADDLE_SANDBOX=false
PADDLE_VENDOR_ID=123
PADDLE_VENDOR_AUTH_CODE=456
PADDLE_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----
...
-----END PUBLIC KEY-----"

Paddle Sandbox

As of version 2.2.0, this package supports the Paddle Sandbox environment. To use this environment, set the sandbox_environment configuration key to true. This will configure the API URLs, as well as the Paddle JavaScript library. If you've published the Blade View while using a previous version of this package, make sure you republish the view:

php artisan vendor:publish --provider="ProtoneMedia\LaravelPaddle\PaddleServiceProvider" --tag=views

Usage

The API calls are available with the Paddle facade. Check out the the documentation to learn all about the Paddle API. You can build your API calls fluently or you could simply pass an array which holds the data. This package has some basic validation rules for the given data and this might result in an InvalidDataException if your data is invalid. Whenever an API call fails it will throw a PaddleApiException.

// Fluent:
$paddleResponse = Paddle::product()
    ->generatePayLink()
    ->productId($paddlePlanId)
    ->customerEmail($team->owner->email)
    ->passthrough(['team_id' => $team->id])
    ->send();

// Array with payload:
$payload = [
    'product_id' => $paddlePlanId,
    'customer_email' => $team->owner->email,
    'passthrough' => ['team_id' => $team->id],
];

$paddleResponse = Paddle::product()
    ->generatePayLink($payload)
    ->send();

return Redirect::to($paddleResponse['url']);

Available API calls

// alerts
Paddle::alert()->getWebhookHistory();

// checkouts
Paddle::checkout()->getOrderDetails();
Paddle::checkout()->getUserHistory();
Paddle::checkout()->getPrices();

// products
Paddle::product()->listCoupons();
Paddle::product()->createCoupon();
Paddle::product()->updateCoupon();
Paddle::product()->deleteCoupon();

Paddle::product()->listProducts();
Paddle::product()->generateLicense();
Paddle::product()->generatePayLink();
Paddle::product()->listTransactions($entity, $id);

// subscriptions
Paddle::subscription()->listPlans();
Paddle::subscription()->createPlan();

Paddle::subscription()->listUsers();
Paddle::subscription()->updateUser();
Paddle::subscription()->previewUpdate();
Paddle::subscription()->cancelUser();

Paddle::subscription()->listModifiers();
Paddle::subscription()->createModifier();
Paddle::subscription()->deleteModifier();

Paddle::subscription()->listPayments();
Paddle::subscription()->reschedulePayment();
Paddle::subscription()->createOneOffCharge($subscriptionId);

Webhooks and Laravel Events

You can configure your webhook URI in the paddle.php config file. Update your webhook settings at Paddle accordingly. By default the URI is paddle/webhook. This means that the webhook calls will be posted to https://your-domain.com/paddle/webhook.

Every webhook will be mapped to an Event and contains the payload of the webhook. For example when the Subscription Created webhook is called, the request is verified and a SubscriptionCreated event will be fired.

Events:

ProtoneMedia\LaravelPaddle\Events\HighRiskTransactionCreated
ProtoneMedia\LaravelPaddle\Events\HighRiskTransactionUpdated
ProtoneMedia\LaravelPaddle\Events\LockerProcessed
ProtoneMedia\LaravelPaddle\Events\NewAudienceMember
ProtoneMedia\LaravelPaddle\Events\PaymentDisputeClosed
ProtoneMedia\LaravelPaddle\Events\PaymentDisputeCreated
ProtoneMedia\LaravelPaddle\Events\PaymentRefunded
ProtoneMedia\LaravelPaddle\Events\PaymentSucceeded
ProtoneMedia\LaravelPaddle\Events\SubscriptionCancelled
ProtoneMedia\LaravelPaddle\Events\SubscriptionCreated
ProtoneMedia\LaravelPaddle\Events\SubscriptionPaymentFailed
ProtoneMedia\LaravelPaddle\Events\SubscriptionPaymentRefunded
ProtoneMedia\LaravelPaddle\Events\SubscriptionPaymentSucceeded
ProtoneMedia\LaravelPaddle\Events\SubscriptionUpdated
ProtoneMedia\LaravelPaddle\Events\TransferCreated
ProtoneMedia\LaravelPaddle\Events\TransferPaid
ProtoneMedia\LaravelPaddle\Events\UpdateAudienceMember

Some webhooks, like the Fulfillment Webhook, don't have an alert_name key. Those webhooks will be mapped to a ProtoneMedia\LaravelPaddle\Events\GenericWebhook event.

When you register a listener to handle the event, the payload is easily accessible. You also have access to the original HTTP request.

<?php

namespace App\Listeners;

use ProtoneMedia\LaravelPaddle\Events\SubscriptionCreated;

class CreateSubscriptionModel
{
    public function handle(SubscriptionCreated $event)
    {
        $status = $event->status;

        $nextBillDate = $event->next_bill_date;

        // or

        $webhookData = $event->all();

        //

        $request = $event->getRequest();
    }
}

Blade directive

This directive imports the Paddle JavaScript library and configures it with your Vendor ID.

<body>
    {{-- your app --}}

    @paddle
</body>

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Other Laravel packages

Inertia Table: The Ultimate Table for Inertia.js with built-in Query Builder.
Laravel Blade On Demand: Laravel package to compile Blade templates in memory.
Laravel Cross Eloquent Search: Laravel package to search through multiple Eloquent models.
Laravel Eloquent Scope as Select: Stop duplicating your Eloquent query scopes and constraints in PHP. This package lets you re-use your query scopes and constraints by adding them as a subquery.
Laravel FFMpeg: This package provides an integration with FFmpeg for Laravel. The storage of the files is handled by Laravel's Filesystem.
Laravel MinIO Testing Tools: Run your tests against a MinIO S3 server.
Laravel Mixins: A collection of Laravel goodies.
Laravel Task Runner: Write Shell scripts like Blade Components and run them locally or on a remote server.
Laravel Verify New Email: This package adds support for verifying new email addresses: when a user updates its email address, it won't replace the old one until the new one is verified.
Laravel XSS Protection: Laravel Middleware to protect your app against Cross-site scripting (XSS). It sanitizes request input, and it can sanatize Blade echo statements.

Security

If you discover any security related issues, please email pascal@protone.media instead of using the issue tracker.

Credits

License

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

protonemedia / laravel-paddle

Maintainers

Details