Skip to content
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待

Laravel Cashier (Paddle)

简介

WARNING

本文档适用于 Cashier Paddle 2.x 与 Paddle Billing 的集成。如果你仍在使用 Paddle Classic,则应使用 Cashier Paddle 1.x

Laravel Cashier PaddlePaddle 的订阅计费服务提供了一个富有表现力、流畅的接口。它处理了几乎所有你不想编写的样板订阅计费代码。除了基本的订阅管理,Cashier 还可以处理:订阅转换、订阅“数量”、订阅暂停、取消宽限期等。

在深入使用 Cashier Paddle 之前,我们建议你也查阅 Paddle 的概念指南API 文档

升级 Cashier

升级到新版本的 Cashier 时,务必仔细查阅升级指南

安装

首先,使用 Composer 包管理器安装 Paddle 的 Cashier 包:

shell
composer require laravel/cashier-paddle

接下来,你应该使用 vendor:publish Artisan 命令发布 Cashier 的迁移文件:

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

然后,你应该运行应用程序的数据库迁移。Cashier 的迁移将创建一个新的 customers 表。此外,还将创建新的 subscriptionssubscription_items 表来存储所有客户的订阅。最后,将创建一个新的 transactions 表来存储与你客户关联的所有 Paddle 交易:

shell
php artisan migrate

WARNING

为确保 Cashier 正确处理所有 Paddle 事件,请记得设置 Cashier 的 webhook 处理

Paddle 沙箱环境

在本地和预发布环境开发期间,你应该注册一个 Paddle 沙箱账户。此账户将为你提供一个沙箱环境,用于测试和开发你的应用程序,而无需进行实际付款。你可以使用 Paddle 的测试卡号来模拟各种支付场景。

当使用 Paddle 沙箱环境时,你应该在应用程序的 .env 文件中将 PADDLE_SANDBOX 环境变量设置为 true

ini
PADDLE_SANDBOX=true

完成应用程序开发后,你可以申请一个 Paddle 商户账户。在应用程序投入生产之前,Paddle 需要批准你的应用程序域名。

配置

可计费模型

在使用 Cashier 之前,必须将 Billable trait 添加到你的用户模型定义中。此 trait 提供了各种方法,允许你执行常见的计费任务,例如创建订阅和更新支付方式信息:

php
use Laravel\Paddle\Billable;

class User extends Authenticatable
{
    use Billable;
}

如果你有不是用户的计费实体,你也可以将该 trait 添加到这些类中:

php
use Illuminate\Database\Eloquent\Model;
use Laravel\Paddle\Billable;

class Team extends Model
{
    use Billable;
}

API 密钥

接下来,你应该在应用程序的 .env 文件中配置你的 Paddle 密钥。你可以从 Paddle 控制面板中检索你的 Paddle API 密钥:

ini
PADDLE_CLIENT_SIDE_TOKEN=你的-paddle-客户端令牌
PADDLE_API_KEY=你的-paddle-api-密钥
PADDLE_RETAIN_KEY=你的-paddle-retain-密钥
PADDLE_WEBHOOK_SECRET="你的-paddle-webhook-密钥"
PADDLE_SANDBOX=true

当你使用 Paddle 沙箱环境时,应将 PADDLE_SANDBOX 环境变量设置为 true。如果你将应用程序部署到生产环境并使用 Paddle 的正式商户环境,则应将 PADDLE_SANDBOX 变量设置为 false

PADDLE_RETAIN_KEY 是可选的,仅当你在使用 Paddle 的 Retain 功能时才应设置。

Paddle JS

Paddle 依赖于自己的 JavaScript 库来启动 Paddle 结账小部件。你可以通过在应用程序布局的 </head> 结束标签前放置 @paddleJS Blade 指令来加载 JavaScript 库:

blade
<head>
    ...

    @paddleJS
</head>

货币配置

你可以指定在发票上格式化货币值显示时要使用的区域设置。Cashier 内部使用 PHP 的 NumberFormatter来设置货币区域:

ini
CASHIER_CURRENCY_LOCALE=nl_BE

WARNING

要使用除 en 以外的区域,请确保在服务器上安装并配置了 ext-intl PHP 扩展。

覆盖默认模型

你可以自由扩展 Cashier 内部使用的模型,方法是定义自己的模型并扩展相应的 Cashier 模型:

php
use Laravel\Paddle\Subscription as CashierSubscription;

class Subscription extends CashierSubscription
{
    // ...
}

定义模型后,你可以通过 Laravel\Paddle\Cashier 类指示 Cashier 使用你的自定义模型。通常,你应该在应用程序的 App\Providers\AppServiceProvider 类的 boot 方法中告知 Cashier 你的自定义模型:

php
use App\Models\Cashier\Subscription;
use App\Models\Cashier\Transaction;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useTransactionModel(Transaction::class);
}

快速入门

销售产品

NOTE

在使用 Paddle Checkout 之前,你应该在 Paddle 仪表板中定义具有固定价格的产品。此外,你应该配置 Paddle 的 webhook 处理

通过你的应用程序提供产品和订阅计费可能会令人生畏。但是,借助 Cashier 和 Paddle 的覆盖式结账,你可以轻松构建现代、强大的支付集成。

要向客户收取非经常性的一次性产品费用,我们将利用 Cashier 通过 Paddle 覆盖式结账向客户收费,客户将在其中提供付款详细信息并确认购买。一旦通过覆盖式结账完成付款,客户将被重定向到你应用程序中选择的成功 URL:

php
use Illuminate\Http\Request;

Route::get('/buy', function (Request $request) {
    $checkout = $request->user()->checkout('pri_deluxe_album')
        ->returnTo(route('dashboard'));

    return view('buy', ['checkout' => $checkout]);
})->name('checkout');

如上面的示例所示,我们将利用 Cashier 提供的 checkout 方法创建一个结账对象,以向客户显示给定“价格标识符”的 Paddle 覆盖式结账。使用 Paddle 时,“价格”指的是特定产品的定义价格

如有必要,checkout 方法将自动在 Paddle 中创建客户,并将该 Paddle 客户记录连接到应用程序数据库中的相应用户。完成结账会话后,客户将被重定向到一个专用的成功页面,你可以在其中向客户显示信息性消息。

buy 视图中,我们将包含一个按钮来显示覆盖式结账。paddle-button Blade 组件随 Cashier Paddle 一起提供;但是,你也可以手动渲染覆盖式结账

html
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
    购买产品
</x-paddle-button>

向 Paddle Checkout 提供元数据

销售产品时,通常会通过你自己的应用程序定义的 CartOrder 模型来跟踪已完成订单和已购买的产品。当将客户重定向到 Paddle 覆盖式结账以完成购买时,你可能需要提供一个现有的订单标识符,以便在客户被重定向回你的应用程序时,可以将完成的购买与相应的订单关联起来。

为此,你可以向 checkout 方法提供一个自定义数据数组。假设当用户开始结账流程时,我们的应用程序中会创建一个待处理的 Order。请记住,此示例中的 CartOrder 模型仅用于说明,并非由 Cashier 提供。你可以根据自己应用程序的需要自由实现这些概念:

php
use App\Models\Cart;
use App\Models\Order;
use Illuminate\Http\Request;

Route::get('/cart/{cart}/checkout', function (Request $request, Cart $cart) {
    $order = Order::create([
        'cart_id' => $cart->id,
        'price_ids' => $cart->price_ids,
        'status' => 'incomplete',
    ]);

    $checkout = $request->user()->checkout($order->price_ids)
        ->customData(['order_id' => $order->id]);

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

如上面的示例所示,当用户开始结账流程时,我们将购物车/订单关联的所有 Paddle 价格标识符提供给 checkout 方法。当然,你的应用程序负责在客户添加这些项目时将它们与“购物车”或订单关联起来。我们还通过 customData 方法将订单的 ID 提供给 Paddle 覆盖式结账。

当然,你可能希望在客户完成结账流程后将订单标记为“已完成”。为此,你可以监听 Paddle 分发的并由 Cashier 通过事件触发的 webhook,以将订单信息存储在你的数据库中。

首先,监听 Cashier 分发的 TransactionCompleted 事件。通常,你应该在应用程序的 AppServiceProviderboot 方法中注册事件监听器:

php
use App\Listeners\CompleteOrder;
use Illuminate\Support\Facades\Event;
use Laravel\Paddle\Events\TransactionCompleted;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    Event::listen(TransactionCompleted::class, CompleteOrder::class);
}

在此示例中,CompleteOrder 监听器可能如下所示:

php
namespace App\Listeners;

use App\Models\Order;
use Laravel\Paddle\Cashier;
use Laravel\Paddle\Events\TransactionCompleted;

class CompleteOrder
{
    /**
     * 处理传入的 Cashier webhook 事件。
     */
    public function handle(TransactionCompleted $event): void
    {
        $orderId = $event->payload['data']['custom_data']['order_id'] ?? null;

        $order = Order::findOrFail($orderId);

        $order->update(['status' => 'completed']);
    }
}

请参阅 Paddle 的文档,了解有关 transaction.completed 事件包含的数据的更多信息。

销售订阅

NOTE

在使用 Paddle Checkout 之前,你应该在 Paddle 仪表板中定义具有固定价格的产品。此外,你应该配置 Paddle 的 webhook 处理

通过你的应用程序提供产品和订阅计费可能会令人生畏。但是,借助 Cashier 和 Paddle 的覆盖式结账,你可以轻松构建现代、强大的支付集成。

要了解如何使用 Cashier 和 Paddle 覆盖式结账销售订阅,让我们考虑一个简单的订阅服务场景,该服务提供月度(price_basic_monthly)和年度(price_basic_yearly)基础计划。这两个价格可以在我们的 Paddle 仪表板中归入一个“基础”产品(pro_basic)。此外,我们的订阅服务可能提供“专家”计划 pro_expert

首先,让我们了解客户如何订阅我们的服务。当然,你可以想象客户可能会在我们应用程序的定价页面上点击基础计划的“订阅”按钮。此按钮将为他们选择的计划调用 Paddle 覆盖式结账。首先,我们通过 checkout 方法启动一个结账会话:

php
use Illuminate\Http\Request;

Route::get('/subscribe', function (Request $request) {
    $checkout = $request->user()->checkout('price_basic_monthly')
        ->returnTo(route('dashboard'));

    return view('subscribe', ['checkout' => $checkout]);
})->name('subscribe');

subscribe 视图中,我们将包含一个按钮来显示覆盖式结账。paddle-button Blade 组件随 Cashier Paddle 一起提供;但是,你也可以手动渲染覆盖式结账

html
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
    订阅
</x-paddle-button>

现在,当点击订阅按钮时,客户将能够输入其付款详细信息并开始订阅。要知道他们的订阅何时真正开始(因为某些支付方式需要几秒钟来处理),你还应该配置 Cashier 的 webhook 处理

现在客户可以开始订阅了,我们需要限制应用程序的某些部分,以便只有订阅用户才能访问它们。当然,我们始终可以通过 Cashier 的 Billable trait 提供的 subscribed 方法来确定用户的当前订阅状态:

blade
@if ($user->subscribed())
    <p>您已订阅。</p>
@endif

我们甚至可以轻松确定用户是否订阅了特定产品或价格:

blade
@if ($user->subscribedToProduct('pro_basic'))
    <p>您已订阅我们的基础产品。</p>
@endif

@if ($user->subscribedToPrice('price_basic_monthly'))
    <p>您已订阅我们的月度基础计划。</p>
@endif

构建一个订阅中间件

为方便起见,你可能希望创建一个中间件,用于判断传入请求是否来自已订阅用户。定义此中间件后,你可以轻松地将其分配给路由,以防止未订阅的用户访问该路由:

php
<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

class Subscribed
{
    /**
     * 处理传入的请求。
     */
    public function handle(Request $request, Closure $next): Response
    {
        if (! $request->user()?->subscribed()) {
            // 将用户重定向到账单页面并要求他们订阅...
            return redirect('/subscribe');
        }

        return $next($request);
    }
}

定义中间件后,你可以将其分配给路由:

php
use App\Http\Middleware\Subscribed;

Route::get('/dashboard', function () {
    // ...
})->middleware([Subscribed::class]);

允许客户管理其账单计划

当然,客户可能希望将其订阅计划更改为另一个产品或“层级”。在我们上面的例子中,我们希望允许客户将其计划从月度订阅更改为年度订阅。为此,你需要实现一个类似按钮的东西,引导至以下路由:

php
use Illuminate\Http\Request;

Route::put('/subscription/{price}/swap', function (Request $request, $price) {
    $user->subscription()->swap($price); // 本例中 "$price" 为 "price_basic_yearly"

    return redirect()->route('dashboard');
})->name('subscription.swap');

除了更换计划,你还需要允许客户取消订阅。类似于更换计划,提供一个按钮引导至以下路由:

php
use Illuminate\Http\Request;

Route::put('/subscription/cancel', function (Request $request, $price) {
    $user->subscription()->cancel();

    return redirect()->route('dashboard');
})->name('subscription.cancel');

现在你的订阅将在其计费周期结束时取消。

NOTE

只要你配置了 Cashier 的 webhook 处理,Cashier 就会通过检查来自 Paddle 的传入 webhook 自动保持应用程序中与 Cashier 相关的数据库表的同步。因此,例如,当你通过 Paddle 仪表板取消客户的订阅时,Cashier 将接收到相应的 webhook 并在你的应用程序数据库中将该订阅标记为“已取消”。

结账会话

大多数向客户收费的操作都是通过 Paddle 的覆盖式结账小部件或利用内联结账的“结账”执行的。

在使用 Paddle 处理结账支付之前,你应在你的 Paddle 结账设置仪表板中定义应用程序的默认支付链接

覆盖式结账

在显示覆盖式结账小部件之前,你必须使用 Cashier 生成一个结账会话。结账会话将告知结账小部件应执行的计费操作:

php
use Illuminate\Http\Request;

Route::get('/buy', function (Request $request) {
    $checkout = $user->checkout('pri_34567')
        ->returnTo(route('dashboard'));

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

Cashier 包含一个 paddle-button Blade 组件。你可以将结账会话作为“属性”传递给此组件。然后,点击此按钮时,将显示 Paddle 的结账小部件:

html
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
    订阅
</x-paddle-button>

默认情况下,这将使用 Paddle 的默认样式显示小部件。你可以通过向组件添加 Paddle 支持的属性(如 data-theme='light')来自定义小部件:

html
<x-paddle-button :checkout="$checkout" class="px-8 py-4" data-theme="light">
    订阅
</x-paddle-button>

Paddle 结账小部件是异步的。一旦用户在小部件中创建了订阅,Paddle 将向你的应用程序发送一个 webhook,以便你可以在应用程序的数据库中正确更新订阅状态。因此,正确设置 webhooks 以适应 Paddle 的状态变更非常重要。

WARNING

订阅状态变更后,接收相应 webhook 的延迟通常很小,但你应在应用程序中考虑到这一点,因为用户的订阅可能在完成结账后不会立即可用。

手动渲染覆盖式结账

你也可以不使用 Laravel 的内置 Blade 组件手动渲染覆盖式结账。首先,按照前面的示例生成结账会话:

php
use Illuminate\Http\Request;

Route::get('/buy', function (Request $request) {
    $checkout = $user->checkout('pri_34567')
        ->returnTo(route('dashboard'));

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

接下来,你可以使用 Paddle.js 初始化结账。在此示例中,我们将创建一个被分配了 paddle_button 类的链接。Paddle.js 将检测到此类,并在点击链接时显示覆盖式结账:

blade
<?php
$items = $checkout->getItems();
$customer = $checkout->getCustomer();
$custom = $checkout->getCustomData();
?>

<a
    href='#!'
    class='paddle_button'
    data-items='{!! json_encode($items) !!}'
    @if ($customer) data-customer-id='{{ $customer->paddle_id }}' @endif
    @if ($custom) data-custom-data='{{ json_encode($custom) }}' @endif
    @if ($returnUrl = $checkout->getReturnUrl()) data-success-url='{{ $returnUrl }}' @endif
>
    购买产品
</a>

内联结账

如果你不想使用 Paddle 的“覆盖式”结账小部件,Paddle 还提供了在小部件内联显示的选项。虽然此方法不允许你调整结账的任何 HTML 字段,但它允许你将小部件嵌入到你的应用程序中。

为了让你轻松上手内联结账,Cashier 包含一个 paddle-checkout Blade 组件。首先,你应该生成一个结账会话

php
use Illuminate\Http\Request;

Route::get('/buy', function (Request $request) {
    $checkout = $user->checkout('pri_34567')
        ->returnTo(route('dashboard'));

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

然后,你可以将结账会话传递给组件的 checkout 属性:

blade
<x-paddle-checkout :checkout="$checkout" class="w-full" />

要调整内联结账组件的高度,你可以将 height 属性传递给 Blade 组件:

blade
<x-paddle-checkout :checkout="$checkout" class="w-full" height="500" />

有关内联结账自定义选项的更多详细信息,请查阅 Paddle 的内联结账指南可用结账设置

手动渲染内联结账

你也可以不使用 Laravel 的内置 Blade 组件手动渲染内联结账。首先,按照前面的示例生成结账会话:

php
use Illuminate\Http\Request;

Route::get('/buy', function (Request $request) {
    $checkout = $user->checkout('pri_34567')
        ->returnTo(route('dashboard'));

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

接下来,你可以使用 Paddle.js 初始化结账。在此示例中,我们将使用 Alpine.js 来演示;但是,你可以根据你的前端栈自由修改此示例:

blade
<?php
$options = $checkout->options();

$options['settings']['frameTarget'] = 'paddle-checkout';
$options['settings']['frameInitialHeight'] = 366;
?>

<div class="paddle-checkout" x-data="{}" x-init="
    Paddle.Checkout.open(@json($options));
">
</div>

访客结账

有时,你可能需要为不需要在你的应用程序中拥有账户的用户创建结账会话。为此,你可以使用 guest 方法:

php
use Illuminate\Http\Request;
use Laravel\Paddle\Checkout;

Route::get('/buy', function (Request $request) {
    $checkout = Checkout::guest(['pri_34567'])
        ->returnTo(route('home'));

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

然后,你可以将结账会话提供给 Paddle 按钮内联结账 Blade 组件。

价格预览

Paddle 允许你按货币自定义价格,本质上允许你为不同国家/地区配置不同的价格。Cashier Paddle 允许你使用 previewPrices 方法检索所有这些价格。此方法接受你想要检索价格的价格 ID:

php
use Laravel\Paddle\Cashier;

$prices = Cashier::previewPrices(['pri_123', 'pri_456']);

货币将根据请求的 IP 地址确定;但是,你可以选择提供一个特定的国家/地区来检索价格:

php
use Laravel\Paddle\Cashier;

$prices = Cashier::previewPrices(['pri_123', 'pri_456'], ['address' => [
    'country_code' => 'BE',
    'postal_code' => '1234',
]]);

检索价格后,你可以根据需要显示它们:

blade
<ul>
    @foreach ($prices as $price)
        <li>{{ $price->product['name'] }} - {{ $price->total() }}</li>
    @endforeach
</ul>

你也可以单独显示小计价格和税额:

blade
<ul>
    @foreach ($prices as $price)
        <li>{{ $price->product['name'] }} - {{ $price->subtotal() }} (+ {{ $price->tax() }} 税)</li>
    @endforeach
</ul>

有关更多信息,请查看 Paddle 关于价格预览的 API 文档

客户价格预览

如果用户已经是客户,并且你希望显示适用于该客户的价格,你可以直接从客户实例检索价格:

php
use App\Models\User;

$prices = User::find(1)->previewPrices(['pri_123', 'pri_456']);

在内部,Cashier 将使用用户的客户 ID 以其货币检索价格。因此,例如,居住在美国的用户将以美元显示价格,而比利时的用户将以欧元显示价格。如果找不到匹配的货币,将使用产品的默认货币。你可以在 Paddle 控制面板中自定义产品或订阅计划的所有价格。

折扣

你也可以选择显示折扣后的价格。调用 previewPrices 方法时,通过 discount_id 选项提供折扣 ID:

php
use Laravel\Paddle\Cashier;

$prices = Cashier::previewPrices(['pri_123', 'pri_456'], [
    'discount_id' => 'dsc_123'
]);

然后,显示计算出的价格:

blade
<ul>
    @foreach ($prices as $price)
        <li>{{ $price->product['name'] }} - {{ $price->total() }}</li>
    @endforeach
</ul>

客户

客户默认值

Cashier 允许你在创建结账会话时为你的客户定义一些有用的默认值。设置这些默认值可以预先填写客户的电子邮件地址和姓名,以便他们可以立即进入结账小部件的支付部分。你可以通过在可计费模型上覆盖以下方法来设置这些默认值:

php
/**
 * 获取要与 Paddle 关联的客户名称。
 */
public function paddleName(): string|null
{
    return $this->name;
}

/**
 * 获取要与 Paddle 关联的客户电子邮件地址。
 */
public function paddleEmail(): string|null
{
    return $this->email;
}

这些默认值将用于 Cashier 中生成结账会话的每个操作。

检索客户

你可以使用 Cashier::findBillable 方法通过其 Paddle 客户 ID 检索客户。此方法将返回可计费模型的实例:

php
use Laravel\Paddle\Cashier;

$user = Cashier::findBillable($customerId);

创建客户

有时,你可能希望在不开始订阅的情况下创建 Paddle 客户。你可以使用 createAsCustomer 方法来实现:

php
$customer = $user->createAsCustomer();

将返回一个 Laravel\Paddle\Customer 实例。一旦在 Paddle 中创建了客户,你可以稍后开始订阅。你可以提供一个可选的 $options 数组,以传入任何额外的 Paddle API 支持的客户创建参数

php
$customer = $user->createAsCustomer($options);

订阅

创建订阅

要创建订阅,首先从数据库中检索你的可计费模型的实例,通常是 App\Models\User 的实例。检索到模型实例后,你可以使用 subscribe 方法来创建模型的结账会话:

php
use Illuminate\Http\Request;

Route::get('/user/subscribe', function (Request $request) {
    $checkout = $request->user()->subscribe($premium = 'pri_123', 'default')
        ->returnTo(route('home'));

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

传递给 subscribe 方法的第一个参数是用户订阅的特定价格。此值应对应于 Paddle 中价格的标识符。returnTo 方法接受一个 URL,你的用户在成功完成结账后将重定向到该 URL。传递给 subscribe 方法的第二个参数应该是订阅的内部“类型”。如果你的应用程序只提供单个订阅,你可以称之为 defaultprimary。此订阅类型仅用于内部应用程序使用,不打算向用户显示。此外,它不应包含空格,并且在创建订阅后不应更改。

你也可以使用 customData 方法提供一个关于订阅的自定义元数据数组:

php
$checkout = $request->user()->subscribe($premium = 'pri_123', 'default')
    ->customData(['key' => 'value'])
    ->returnTo(route('home'));

一旦创建了订阅结账会话,可以将结账会话提供给 Cashier Paddle 附带的 paddle-button Blade 组件

blade
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
    订阅
</x-paddle-button>

用户完成结账后,Paddle 将分发一个 subscription_created webhook。Cashier 将接收此 webhook 并为你的客户设置订阅。为了确保你的应用程序正确接收和处理所有 webhook,请确保你已正确设置 webhook 处理

检查订阅状态

一旦用户订阅了你的应用程序,你可以使用各种便捷方法检查其订阅状态。首先,如果用户有有效的订阅,即使订阅当前处于试用期,subscribed 方法也会返回 true

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

如果你的应用程序提供多个订阅,你可以在调用 subscribed 方法时指定订阅:

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

subscribed 方法也是路由中间件的一个很好的候选者,允许你根据用户的订阅状态过滤对路由和控制器的访问:

php
<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

class EnsureUserIsSubscribed
{
    /**
     * 处理传入的请求。
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        if ($request->user() && ! $request->user()->subscribed()) {
            // 此用户不是付费客户...
            return redirect('/billing');
        }

        return $next($request);
    }
}

如果你想确定用户是否仍在试用期内,可以使用 onTrial 方法。此方法可用于确定你是否应向用户显示他们仍在试用期的警告:

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

subscribedToPrice 方法可用于根据给定的 Paddle 价格 ID 确定用户是否订阅了给定计划。在此示例中,我们将确定用户的 default 订阅是否有效订阅了月度价格:

php
if ($user->subscribedToPrice($monthly = 'pri_123', 'default')) {
    // ...
}

recurring 方法可用于确定用户当前是否处于有效订阅状态,并且不再处于试用期或宽限期:

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

已取消订阅状态

要确定用户曾经是有效的订阅者但已取消订阅,你可以使用 canceled 方法:

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

你还可以确定用户是否已取消订阅,但仍处于“宽限期”,直到订阅完全到期。例如,如果用户在 3 月 5 日取消了一个原定于 3 月 10 日到期的订阅,则该用户在 3 月 10 日之前处于“宽限期”。此外,在此期间 subscribed 方法仍将返回 true

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

逾期状态

如果订阅的付款失败,它将被标记为 past_due。当你的订阅处于此状态时,它将不会处于活动状态,直到客户更新其支付信息。你可以使用订阅实例上的 pastDue 方法确定订阅是否逾期:

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

当订阅逾期时,你应指示用户更新其支付信息

如果你希望在订阅处于 past_due 状态时仍将其视为有效,可以使用 Cashier 提供的 keepPastDueSubscriptionsActive 方法。通常,此方法应在你的 AppServiceProviderregister 方法中调用:

php
use Laravel\Paddle\Cashier;

/**
 * 注册任何应用程序服务。
 */
public function register(): void
{
    Cashier::keepPastDueSubscriptionsActive();
}

WARNING

当订阅处于 past_due 状态时,在支付信息更新之前无法更改它。因此,当订阅处于 past_due 状态时,swapupdateQuantity 方法将抛出异常。

订阅作用域

大多数订阅状态也可以作为查询作用域使用,以便你可以轻松查询数据库中处于给定状态的订阅:

php
// 获取所有有效订阅...
$subscriptions = Subscription::query()->valid()->get();

// 获取用户的所有已取消订阅...
$subscriptions = $user->subscriptions()->canceled()->get();

以下列出了可用的作用域:

php
Subscription::query()->valid();
Subscription::query()->onTrial();
Subscription::query()->expiredTrial();
Subscription::query()->notOnTrial();
Subscription::query()->active();
Subscription::query()->recurring();
Subscription::query()->pastDue();
Subscription::query()->paused();
Subscription::query()->notPaused();
Subscription::query()->onPausedGracePeriod();
Subscription::query()->notOnPausedGracePeriod();
Subscription::query()->canceled();
Subscription::query()->notCanceled();
Subscription::query()->onGracePeriod();
Subscription::query()->notOnGracePeriod();

订阅单次扣费

订阅单次扣费允许你在订阅基础上向订阅者收取一次性费用。在调用 charge 方法时,你必须提供一个或多个价格 ID:

php
// 扣费单个价格...
$response = $user->subscription()->charge('pri_123');

// 一次扣费多个价格...
$response = $user->subscription()->charge(['pri_123', 'pri_456']);

charge 方法实际上不会在订阅的下一个计费间隔之前向客户收费。如果你想立即向客户收费,可以使用 chargeAndInvoice 方法:

php
$response = $user->subscription()->chargeAndInvoice('pri_123');

更新支付信息

Paddle 始终为每个订阅保存一种支付方式。如果你想更新订阅的默认支付方式,你应该使用订阅模型上的 redirectToUpdatePaymentMethod 方法将客户重定向到 Paddle 托管的支付方式更新页面:

php
use Illuminate\Http\Request;

Route::get('/update-payment-method', function (Request $request) {
    $user = $request->user();

    return $user->subscription()->redirectToUpdatePaymentMethod();
});

当用户完成信息更新后,Paddle 将分发一个 subscription_updated webhook,并且订阅详细信息将在你的应用程序数据库中更新。

变更套餐

用户订阅你的应用程序后,他们可能偶尔想要更改为新的订阅计划。要更新用户的订阅计划,你应该将 Paddle 价格标识符传递给订阅的 swap 方法:

php
use App\Models\User;

$user = User::find(1);

$user->subscription()->swap($premium = 'pri_456');

如果你想更换套餐并立即向用户开票,而不是等待下一个计费周期,可以使用 swapAndInvoice 方法:

php
$user = User::find(1);

$user->subscription()->swapAndInvoice($premium = 'pri_456');

按比例分配

默认情况下,Paddle 在更换套餐时会按比例分配费用。noProrate 方法可用于在不按比例分配费用的情况下更新订阅:

php
$user->subscription('default')->noProrate()->swap($premium = 'pri_456');

如果你想禁用按比例分配并立即向客户开票,可以将 swapAndInvoice 方法与 noProrate 结合使用:

php
$user->subscription('default')->noProrate()->swapAndInvoice($premium = 'pri_456');

或者,为了不为订阅更改向客户收费,你可以使用 doNotBill 方法:

php
$user->subscription('default')->doNotBill()->swap($premium = 'pri_456');

有关 Paddle 按比例分配政策的更多信息,请查阅 Paddle 的按比例分配文档

订阅数量

有时订阅会受到“数量”的影响。例如,一个项目管理应用程序可能每个项目每月收费 10 美元。要轻松增加或减少订阅的数量,请使用 incrementQuantitydecrementQuantity 方法:

php
$user = User::find(1);

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

// 给订阅的当前数量加五...
$user->subscription()->incrementQuantity(5);

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

// 给订阅的当前数量减五...
$user->subscription()->decrementQuantity(5);

或者,你可以使用 updateQuantity 方法设置特定数量:

php
$user->subscription()->updateQuantity(10);

noProrate 方法可用于在不按比例分配费用的情况下更新订阅的数量:

php
$user->subscription()->noProrate()->updateQuantity(10);

多产品订阅的数量

如果你的订阅是多产品订阅,则应将要增加或减少数量的价格的 ID 作为第二个参数传递给 increment / decrement 方法:

php
$user->subscription()->incrementQuantity(1, 'price_chat');

多产品订阅

多产品订阅允许你将多个计费产品分配给单个订阅。例如,假设你正在构建一个客户服务“帮助台”应用程序,其基础订阅价格为每月 10 美元,但提供每月额外 15 美元的实时聊天附加产品。

在创建订阅结账会话时,你可以通过向 subscribe 方法的第一个参数传递一个价格数组来为给定订阅指定多个产品:

php
use Illuminate\Http\Request;

Route::post('/user/subscribe', function (Request $request) {
    $checkout = $request->user()->subscribe([
        'price_monthly',
        'price_chat',
    ]);

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

在上面的示例中,客户将有两个价格附加到其 default 订阅。两个价格将在各自相应的计费间隔内收取费用。如果需要,你可以传递一个关联的键/值对数组来为每个价格指定特定数量:

php
$user = User::find(1);

$checkout = $user->subscribe('default', ['price_monthly', 'price_chat' => 5]);

如果你想向现有订阅添加另一个价格,必须使用订阅的 swap 方法。在调用 swap 方法时,你还应包含订阅的当前价格和数量:

php
$user = User::find(1);

$user->subscription()->swap(['price_chat', 'price_original' => 2]);

上面的示例将添加新价格,但客户将在下一个计费周期才会被收费。如果你想立即向客户收费,可以使用 swapAndInvoice 方法:

php
$user->subscription()->swapAndInvoice(['price_chat', 'price_original' => 2]);

你可以使用 swap 方法从订阅中移除价格,并省略要移除的价格:

php
$user->subscription()->swap(['price_original' => 2]);

WARNING

你不能移除订阅上的最后一个价格。相反,你应该直接取消订阅。

多订阅

Paddle 允许你的客户同时拥有多个订阅。例如,你可能经营一家健身房,提供游泳订阅和举重订阅,并且每个订阅可能有不同的定价。当然,客户应该能够订阅其中一个或两个计划。

当你的应用程序创建订阅时,你可以向 subscribe 方法提供订阅的类型作为第二个参数。该类型可以是表示用户发起的订阅类型的任何字符串:

php
use Illuminate\Http\Request;

Route::post('/swimming/subscribe', function (Request $request) {
    $checkout = $request->user()->subscribe($swimmingMonthly = 'pri_123', 'swimming');

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

在此示例中,我们为客户发起了一个月度游泳订阅。但是,他们可能稍后想要转换为年度订阅。在调整客户的订阅时,我们可以简单地转换 swimming 订阅上的价格:

php
$user->subscription('swimming')->swap($swimmingYearly = 'pri_456');

当然,你也可以完全取消订阅:

php
$user->subscription('swimming')->cancel();

暂停订阅

要暂停订阅,请调用用户订阅上的 pause 方法:

php
$user->subscription()->pause();

当订阅被暂停时,Cashier 将自动在你的数据库中设置 paused_at 列。此列用于确定 paused 方法何时应开始返回 true。例如,如果客户在 3 月 1 日暂停订阅,但订阅原定于 3 月 5 日才续费,paused 方法将一直返回 false 直到 3 月 5 日。这是因为通常允许用户在计费周期结束前继续使用应用程序。

默认情况下,暂停发生在下一个计费间隔,以便客户可以使用他们已支付期间的剩余时间。如果你想立即暂停订阅,可以使用 pauseNow 方法:

php
$user->subscription()->pauseNow();

使用 pauseUntil 方法,你可以将订阅暂停到特定的时间点:

php
$user->subscription()->pauseUntil(now()->plus(months: 1));

或者,你可以使用 pauseNowUntil 方法立即将订阅暂停到给定的时间点:

php
$user->subscription()->pauseNowUntil(now()->plus(months: 1));

你可以使用 onPausedGracePeriod 方法确定用户是否已暂停订阅但仍处于“宽限期”:

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

要恢复暂停的订阅,你可以在订阅上调用 resume 方法:

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

WARNING

订阅暂停期间无法修改。如果你想更换到不同的计划或更新数量,你必须先恢复订阅。

取消订阅

要取消订阅,请调用用户订阅上的 cancel 方法:

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

当订阅被取消时,Cashier 将自动在你的数据库中设置 ends_at 列。此列用于确定 subscribed 方法何时应开始返回 false。例如,如果客户在 3 月 1 日取消订阅,但订阅原定于 3 月 5 日才结束,subscribed 方法将一直返回 true 直到 3 月 5 日。这样做是因为通常允许用户在计费周期结束前继续使用应用程序。

你可以使用 onGracePeriod 方法确定用户是否已取消订阅但仍处于“宽限期”:

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

如果你想立即取消订阅,可以在订阅上调用 cancelNow 方法:

php
$user->subscription()->cancelNow();

要停止处于宽限期的订阅取消,你可以调用 stopCancelation 方法:

php
$user->subscription()->stopCancelation();

WARNING

Paddle 的订阅取消后无法恢复。如果你的客户希望恢复其订阅,他们必须创建新订阅。

订阅试用期

预先提供支付方式

如果你想向客户提供试用期,但同时提前收集支付方式信息,你应该在 Paddle 仪表板中为你客户订阅的价格设置一个试用时间。然后,正常启动结账会话:

php
use Illuminate\Http\Request;

Route::get('/user/subscribe', function (Request $request) {
    $checkout = $request->user()
        ->subscribe('pri_monthly')
        ->returnTo(route('home'));

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

当你的应用程序收到 subscription_created 事件时,Cashier 将在应用程序的数据库中设置订阅记录的试用期结束日期,并指示 Paddle 在此日期之后才开始向客户收费。

WARNING

如果客户的订阅在试用期结束日期前未取消,他们将在试用期到期后立即被收费,因此你应确保通知用户其试用期结束日期。

你可以使用用户实例的 onTrial 方法来确定用户是否处于试用期内:

php
if ($user->onTrial()) {
    // ...
}

要确定现有试用期是否已过期,你可以使用 hasExpiredTrial 方法:

php
if ($user->hasExpiredTrial()) {
    // ...
}

要确定用户是否处于特定订阅类型的试用期,你可以将类型提供给 onTrialhasExpiredTrial 方法:

php
if ($user->onTrial('default')) {
    // ...
}

if ($user->hasExpiredTrial('default')) {
    // ...
}

无需预先提供支付方式

如果你想在不预先收集用户支付方式信息的情况下提供试用期,可以在附加到你的用户的客户记录上设置 trial_ends_at 列为你希望的试用期结束日期。这通常在用户注册期间完成:

php
use App\Models\User;

$user = User::create([
    // ...
]);

$user->createAsCustomer([
    'trial_ends_at' => now()->plus(days: 10)
]);

Cashier 将这种类型的试用称为“通用试用”,因为它不附加到任何现有订阅。如果当前日期未超过 trial_ends_at 的值,User 实例上的 onTrial 方法将返回 true

php
if ($user->onTrial()) {
    // 用户处于试用期内...
}

一旦你准备好为用户创建实际订阅,可以像往常一样使用 subscribe 方法:

php
use Illuminate\Http\Request;

Route::get('/user/subscribe', function (Request $request) {
    $checkout = $request->user()
        ->subscribe('pri_monthly')
        ->returnTo(route('home'));

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

要检索用户的试用期结束日期,可以使用 trialEndsAt 方法。如果用户处于试用期,此方法将返回一个 Carbon 日期实例;如果不处于试用期,则返回 null。如果你希望获取除默认订阅之外的特定订阅的试用期结束日期,还可以传递一个可选的订阅类型参数:

php
if ($user->onTrial('default')) {
    $trialEndsAt = $user->trialEndsAt();
}

如果你特别想知道用户是否处于“通用”试用期且尚未创建实际订阅,可以使用 onGenericTrial 方法:

php
if ($user->onGenericTrial()) {
    // 用户处于“通用”试用期内...
}

延长或激活试用期

你可以通过调用 extendTrial 方法并指定试用期应结束的时间点来延长订阅的现有试用期:

php
$user->subscription()->extendTrial(now()->plus(days: 5));

或者,你可以通过调用订阅上的 activate 方法来立即激活订阅,从而结束其试用期:

php
$user->subscription()->activate();

处理 Paddle Webhooks

Paddle 可以通过 webhook 通知你的应用程序各种事件。默认情况下,Cashier 服务提供器会注册一个指向 Cashier webhook 控制器的路由。此控制器将处理所有传入的 webhook 请求。

默认情况下,此控制器将自动处理因失败扣款次数过多而取消订阅、订阅更新和支付方式更改;但是,我们很快就会发现,你可以扩展此控制器以处理任何你喜欢的 Paddle webhook 事件。

为确保你的应用程序能够处理 Paddle webhooks,请务必在 Paddle 控制面板中配置 webhook URL。默认情况下,Cashier 的 webhook 控制器响应 /paddle/webhook URL 路径。你应该在 Paddle 控制面板中启用的所有 webhook 的完整列表是:

  • Customer Updated
  • Transaction Completed
  • Transaction Updated
  • Subscription Created
  • Subscription Updated
  • Subscription Paused
  • Subscription Canceled

WARNING

确保使用 Cashier 附带的 webhook 签名验证中间件保护传入请求。

Webhooks 和 CSRF 保护

由于 Paddle webhooks 需要绕过 Laravel 的 CSRF 保护,你应该确保 Laravel 不会尝试验证传入的 Paddle webhooks 的 CSRF 令牌。为此,你应该在你的应用程序的 bootstrap/app.php 文件中将 paddle/* 从 CSRF 保护中排除:

php
->withMiddleware(function (Middleware $middleware): void {
    $middleware->preventRequestForgery(except: [
        'paddle/*',
    ]);
})

Webhooks 和本地开发

为了让 Paddle 能够在本地开发期间向你的应用程序发送 webhook,你需要通过站点共享服务(如 NgrokExpose)暴露你的应用程序。如果你正在使用 Laravel Sail 在本地开发应用程序,可以使用 Sail 的站点共享命令

定义 Webhook 事件处理器

Cashier 自动处理因失败扣款导致的订阅取消和其他常见的 Paddle webhooks。但是,如果你有其他想要处理的 webhook 事件,可以通过监听 Cashier 分发的以下事件来实现:

  • Laravel\Paddle\Events\WebhookReceived
  • Laravel\Paddle\Events\WebhookHandled

这两个事件都包含 Paddle webhook 的完整负载。例如,如果你想处理 transaction.billed webhook,可以注册一个监听器来处理该事件:

php
<?php

namespace App\Listeners;

use Laravel\Paddle\Events\WebhookReceived;

class PaddleEventListener
{
    /**
     * 处理接收到的 Paddle webhooks。
     */
    public function handle(WebhookReceived $event): void
    {
        if ($event->payload['event_type'] === 'transaction.billed') {
            // 处理传入的事件...
        }
    }
}

Cashier 还会发出专门针对接收到的 webhook 类型的事件。除了来自 Paddle 的完整负载外,它们还包含用于处理 webhook 的相关模型,例如可计费模型、订阅或收据:

  • Laravel\Paddle\Events\CustomerUpdated
  • Laravel\Paddle\Events\TransactionCompleted
  • Laravel\Paddle\Events\TransactionUpdated
  • Laravel\Paddle\Events\SubscriptionCreated
  • Laravel\Paddle\Events\SubscriptionUpdated
  • Laravel\Paddle\Events\SubscriptionPaused
  • Laravel\Paddle\Events\SubscriptionCanceled

你也可以通过在你的应用程序的 .env 文件中定义 CASHIER_WEBHOOK 环境变量来覆盖默认的内置 webhook 路由。此值应该是你的 webhook 路由的完整 URL,并且需要与你在 Paddle 控制面板中设置的 URL 匹配:

ini
CASHIER_WEBHOOK=https://example.com/my-paddle-webhook-url

验证 Webhook 签名

为了保护你的 webhooks,你可以使用 Paddle 的 webhook 签名。为方便起见,Cashier 自动包含一个中间件,用于验证传入的 Paddle webhook 请求是否有效。

要启用 webhook 验证,请确保在你的应用程序的 .env 文件中定义了 PADDLE_WEBHOOK_SECRET 环境变量。webhook 密钥可以从你的 Paddle 账户仪表板中检索。

单次扣费

产品扣费

如果你想为客户发起产品购买,可以使用可计费模型实例上的 checkout 方法为购买生成一个结账会话。checkout 方法接受一个或多个价格 ID。如果需要,可以使用关联数组来提供所购买产品的数量:

php
use Illuminate\Http\Request;

Route::get('/buy', function (Request $request) {
    $checkout = $request->user()->checkout(['pri_tshirt', 'pri_socks' => 5]);

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

生成结账会话后,你可以使用 Cashier 提供的 paddle-button Blade 组件允许用户查看 Paddle 结账小部件并完成购买:

blade
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
    购买
</x-paddle-button>

结账会话有一个 customData 方法,允许你向底层交易创建传递任何你希望的自定义数据。请查阅 Paddle 文档以了解有关传递自定义数据时可用选项的更多信息:

php
$checkout = $user->checkout('pri_tshirt')
    ->customData([
        'custom_option' => $value,
    ]);

退款交易

退款交易会将退款金额返回到客户在购买时使用的支付方式。如果你需要退款 Paddle 购买,可以在 Cashier\Paddle\Transaction 模型上使用 refund 方法。此方法接受一个原因作为第一个参数,以及一个或多个要退款的价格 ID(可选金额)作为关联数组。你可以使用 transactions 方法检索给定可计费模型的交易。

例如,假设我们想为价格 pri_123pri_456 退款特定交易。我们想全额退款 pri_123,但只退款两美元给 pri_456

php
use App\Models\User;

$user = User::find(1);

$transaction = $user->transactions()->first();

$response = $transaction->refund('误扣费', [
    'pri_123', // 全额退款此价格...
    'pri_456' => 200, // 仅部分退款此价格...
]);

上面的示例退款了交易中的特定行项目。如果你想退款整个交易,只需提供一个原因:

php
$response = $transaction->refund('误扣费');

有关退款的更多信息,请查阅 Paddle 的退款文档

WARNING

退款必须始终在完全处理前得到 Paddle 的批准。

贷记交易

就像退款一样,你也可以贷记交易。贷记交易会将资金添加到客户的余额中,以便用于未来的购买。贷记交易只能针对手动收取的交易进行,而不能针对自动收取的交易(如订阅),因为 Paddle 会自动处理订阅贷记:

php
$transaction = $user->transactions()->first();

// 全额贷记特定行项目...
$response = $transaction->credit('补偿', 'pri_123');

有关更多信息,请参阅 Paddle 关于贷记的文档

WARNING

贷记只能应用于手动收取的交易。自动收取的交易由 Paddle 自己进行贷记。

交易

你可以通过 transactions 属性轻松检索可计费模型的交易数组:

php
use App\Models\User;

$user = User::find(1);

$transactions = $user->transactions;

交易代表你的产品和购买的付款,并附有发票。只有完成的交易才会存储在你的应用程序数据库中。

在列出客户的交易时,你可以使用交易实例的方法来显示相关的支付信息。例如,你可能希望在表格中列出每笔交易,允许用户轻松下载任何发票:

html
<table>
    @foreach ($transactions as $transaction)
        <tr>
            <td>{{ $transaction->billed_at->toFormattedDateString() }}</td>
            <td>{{ $transaction->total() }}</td>
            <td>{{ $transaction->tax() }}</td>
            <td><a href="{{ route('download-invoice', $transaction->id) }}" target="_blank">下载</a></td>
        </tr>
    @endforeach
</table>

download-invoice 路由可能如下所示:

php
use Illuminate\Http\Request;
use Laravel\Paddle\Transaction;

Route::get('/download-invoice/{transaction}', function (Request $request, Transaction $transaction) {
    return $transaction->redirectToInvoicePdf();
})->name('download-invoice');

历史与即将到来的支付

你可以使用 lastPaymentnextPayment 方法检索和显示客户对于定期订阅的过去或即将到来的支付:

php
use App\Models\User;

$user = User::find(1);

$subscription = $user->subscription();

$lastPayment = $subscription->lastPayment();
$nextPayment = $subscription->nextPayment();

这两种方法都将返回一个 Laravel\Paddle\Payment 实例;但是,当交易尚未通过 webhook 同步时,lastPayment 将返回 null,而当计费周期结束时(例如订阅已取消),nextPayment 将返回 null

blade
下次付款:{{ $nextPayment->amount() }},应于 {{ $nextPayment->date()->format('d/m/Y') }} 支付

测试

在测试期间,你应该手动测试你的计费流程,以确保你的集成按预期工作。

对于自动化测试,包括在 CI 环境中执行的测试,你可以使用 Laravel 的 HTTP 客户端来伪造对 Paddle 的 HTTP 调用。虽然这不会测试来自 Paddle 的实际响应,但它提供了一种无需实际调用 Paddle API 即可测试应用程序的方法。