Laravel Cashier (Paddle)
介绍
本文档适用于 Cashier Paddle 2.x 与 Paddle Billing 的集成。如果您仍在使用 Paddle Classic,请使用 Cashier Paddle 1.x。
Laravel Cashier Paddle 提供了一个表达性、流畅的接口,用于 Paddle 的订阅计费服务。它处理几乎所有您所担心的样板订阅计费代码。除了基本的订阅管理,Cashier 还可以处理:交换订阅、订阅“数量”、订阅暂停、取消宽限期等。
在深入了解 Cashier Paddle 之前,我们建议您也查看 Paddle 的 概念指南 和 API 文档。
升级 Cashier
在升级到新版本的 Cashier 时,重要的是您要仔细查看 升级指南。
安装
首先,使用 Composer 包管理器安装 Paddle 的 Cashier 包:
composer require laravel/cashier-paddle
接下来,您应该使用 vendor:publish
Artisan 命令发布 Cashier 迁移文件:
php artisan vendor:publish --tag="cashier-migrations"
然后,您应该运行应用程序的数据库迁移。Cashier 迁移将创建一个新的 customers
表。此外,将创建新的 subscriptions
和 subscription_items
表来存储您客户的所有订阅。最后,将创建一个新的 transactions
表来存储与您客户相关的所有 Paddle 交易:
php artisan migrate
为确保 Cashier 正确处理所有 Paddle 事件,请记得 设置 Cashier 的 webhook 处理。
Paddle 沙盒
在本地和暂存开发期间,您应该 注册一个 Paddle 沙盒账户。该账户将为您提供一个沙盒环境,以便在不进行实际付款的情况下测试和开发您的应用程序。您可以使用 Paddle 的 测试卡号 来模拟各种支付场景。
在使用 Paddle 沙盒环境时,您应该在应用程序的 .env
文件中将 PADDLE_SANDBOX
环境变量设置为 true
:
PADDLE_SANDBOX=true
完成应用程序开发后,您可以 申请 Paddle 供应商账户。在将应用程序投入生产之前,Paddle 需要批准您应用程序的域名。
配置
可计费模型
在使用 Cashier 之前,您必须将 Billable
特性添加到用户模型定义中。该特性提供了各种方法,使您能够执行常见的计费任务,例如创建订阅和更新支付方式信息:
use Laravel\Paddle\Billable;
class User extends Authenticatable
{
use Billable;
}
如果您有不是用户的可计费实体,您也可以将该特性添加到这些类中:
use Illuminate\Database\Eloquent\Model;
use Laravel\Paddle\Billable;
class Team extends Model
{
use Billable;
}
API 密钥
接下来,您应该在应用程序的 .env
文件中配置您的 Paddle 密钥。您可以从 Paddle 控制面板中检索您的 Paddle API 密钥:
PADDLE_CLIENT_SIDE_TOKEN=your-paddle-client-side-token
PADDLE_API_KEY=your-paddle-api-key
PADDLE_RETAIN_KEY=your-paddle-retain-key
PADDLE_WEBHOOK_SECRET="your-paddle-webhook-secret"
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 库:
<head>
...
@paddleJS
</head>
货币配置
您可以指定用于格式化发票上货币值的区域设置。内部,Cashier 利用 PHP 的 NumberFormatter
类 来设置货币区域:
CASHIER_CURRENCY_LOCALE=nl_BE
为了使用 en
以外的区域设置,请确保在您的服务器上安装并配置 ext-intl
PHP 扩展。
覆盖默认模型
您可以通过定义自己的模型并扩展相应的 Cashier 模型来自由扩展 Cashier 内部使用的模型:
use Laravel\Paddle\Subscription as CashierSubscription;
class Subscription extends CashierSubscription
{
// ...
}
定义模型后,您可以通过 Laravel\Paddle\Cashier
类指示 Cashier 使用您的自定义模型。通常,您应该在应用程序的 App\Providers\AppServiceProvider
类的 boot
方法中告知 Cashier 有关您的自定义模型的信息:
use App\Models\Cashier\Subscription;
use App\Models\Cashier\Transaction;
/**
* 启动任何应用程序服务。
*/
public function boot(): void
{
Cashier::useSubscriptionModel(Subscription::class);
Cashier::useTransactionModel(Transaction::class);
}
快速入门
销售产品
在使用 Paddle 结账之前,您应该在 Paddle 仪表板中定义具有固定价格的产品。此外,您应该 配置 Paddle 的 webhook 处理。
通过您的应用程序提供产品和订阅计费可能会让人感到害怕。然而,感谢 Cashier 和 Paddle 的结账覆盖,您可以轻松构建现代、强大的支付集成。
要为非定期的单次收费产品向客户收费,我们将利用 Cashier 使用 Paddle 的结账覆盖,客户将在其中提供他们的支付详细信息并确认他们的购买。一旦通过结账覆盖完成付款,客户将被重定向到您选择的成功 URL:
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 附带的;但是,您也可以 手动渲染覆盖结账:
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
购买产品
</x-paddle-button>
向 Paddle 结账提供元数据
在销售产品时,通常需要通过您自己定义的 Cart
和 Order
模型跟踪已完成的订单和购买的产品。当将客户重定向到 Paddle 的结账覆盖以完成购买时,您可能需要提供现有订单标识符,以便在客户重定向回您的应用程序时将已完成的购买与相应的订单关联。
为此,您可以向 checkout
方法提供一个自定义数据数组。假设在用户开始结账过程时,在我们的应用程序中创建了一个待处理的 Order
。请记住,示例中的 Cart
和 Order
模型是说明性的,并不是 Cashier 提供的。您可以根据自己应用程序的需求自由实现这些概念:
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 发送的 webhook,并通过 Cashier 提升事件来存储订单信息到您的数据库。
要开始,监听 Cashier 发送的 TransactionCompleted
事件。通常,您应该在应用程序的 AppServiceProvider
的 boot
方法中注册事件监听器:
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
监听器可能看起来如下:
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']);
}
}
有关 transaction.completed
事件中包含的数据的更多信息,请参阅 Paddle 的文档 数据。
销售订阅
在使用 Paddle 结账之前,您应该在 Paddle 仪表板中定义具有固定价格的产品。此外,您应该 配置 Paddle 的 webhook 处理。
通过您的应用程序提供产品和订阅计费可能会让人感到害怕。然而,感谢 Cashier 和 Paddle 的结账覆盖,您可以轻松构建现代、强大的支付集成。
要了解如何使用 Cashier 和 Paddle 的结账覆盖销售订阅,让我们考虑一个简单的场景,即具有基本月度(price_basic_monthly
)和年度(price_basic_yearly
)计划的订阅服务。这两个价格可以在我们的 Paddle 仪表板中归类为“基本”产品(pro_basic
)。此外,我们的订阅服务可能还提供专家计划,标识为 pro_expert
。
首先,让我们发现客户如何订阅我们的服务。当然,您可以想象客户可能会在我们应用程序的定价页面上点击“订阅”按钮。该按钮将调用其选择的计划的 Paddle 结账覆盖。要开始,让我们通过 checkout
方法启动结账会话:
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 附带的;但是,您也可以 手动渲染覆盖结账:
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
订阅
</x-paddle-button>
现在,当点击订阅按钮时,客户将能够输入他们的支付详细信息并启动他们的订阅。要知道他们的订阅何时实际开始(因为某些支付方式需要几秒钟来处理),您还应该 配置 Cashier 的 webhook 处理。
现在客户可以开始订阅,我们需要限制应用程序的某些部分,以便只有订阅用户可以访问它们。当然,我们可以通过 Cashier 的 Billable
特性提供的 subscribed
方法轻松确定用户的当前订阅状态:
@if ($user->subscribed())
<p>您已订阅。</p>
@endif
我们甚至可以轻松确定用户是否订阅了特定产品或价格:
@if ($user->subscribedToProduct('pro_basic'))
<p>您已订阅我们的基本产品。</p>
@endif
@if ($user->subscribedToPrice('price_basic_monthly'))
<p>您已订阅我们的月度基本计划。</p>
@endif
构建订阅中间件
为了方便,您可能希望创建一个 中间件,以确定传入请求是否来自已订阅的用户。定义此中间件后,您可以轻松将其分配给路由,以防止未订阅的用户访问该路由:
<?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);
}
}
定义中间件后,您可以将其分配给路由:
use App\Http\Middleware\Subscribed;
Route::get('/dashboard', function () {
// ...
})->middleware([Subscribed::class]);
允许客户管理他们的计费计划
当然,客户可能希望将他们的订阅计划更改为另一个产品或“层”。在上面的示例中,我们希望允许客户将他们的计划从月度订阅更改为年度订阅。为此,您需要实现一个按钮,指向以下路由:
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');
除了交换计划,您还需要允许客户取消他们的订阅。与交换计划一样,提供一个按钮,指向以下路由:
use Illuminate\Http\Request;
Route::put('/subscription/cancel', function (Request $request, $price) {
$user->subscription()->cancel();
return redirect()->route('dashboard');
})->name('subscription.cancel');
现在,您的订阅将在其计费周期结束时被取消。
只要您已配置 Cashier 的 webhook 处理,Cashier 将通过检查来自 Paddle 的传入 webhook 自动保持您应用程序的 Cashier 相关数据库表的同步。因此,例如,当您通过 Paddle 的仪表板取消客户的订阅时,Cashier 将收到相应的 webhook,并在您应用程序的数据库中将订阅标记为“已取消”。
结账会话
大多数向客户收费的操作都是通过 Paddle 的 结账覆盖小部件 或通过使用 内联结账 来执行的。
在使用 Paddle 处理结账支付之前,您应该在 Paddle 结账设置仪表板中定义您应用程序的 默认支付链接。
覆盖结账
在显示结账覆盖小部件之前,您必须使用 Cashier 生成一个结账会话。结账会话将通知结账小部件应执行的计费操作:
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 组件。您可以将结账会话作为“prop”传递给此组件。然后,当单击此按钮时,Paddle 的结账小部件将显示:
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
订阅
</x-paddle-button>
默认情况下,这将使用 Paddle 的默认样式显示小部件。您可以通过向组件添加 Paddle 支持的属性 来自定义小部件,例如 data-theme='light'
属性:
<x-paddle-button :checkout="$checkout" class="px-8 py-4" data-theme="light">
订阅
</x-paddle-button>
Paddle 结账小部件是异步的。一旦用户在小部件中创建了订阅,Paddle 将向您的应用程序发送一个 webhook,以便您可以在应用程序的数据库中正确更新订阅状态。因此,您必须正确 设置 webhook 以适应来自 Paddle 的状态更改。
在订阅状态更改后,接收相应 webhook 的延迟通常是最小的,但您应该在应用程序中考虑这一点,认为用户的订阅在完成结账后可能不会立即可用。
手动渲染覆盖结账
您还可以在不使用 Laravel 内置 Blade 组件的情况下手动渲染覆盖结账。要开始,请生成结账会话 如前面的示例所示:
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 将检测此类并在单击链接时显示覆盖结账:
<?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 组件。要开始,您应该 生成结账会话:
use Illuminate\Http\Request;
Route::get('/buy', function (Request $request) {
$checkout = $user->checkout('pri_34567')
->returnTo(route('dashboard'));
return view('billing', ['checkout' => $checkout]);
});
然后,您可以将结账会话传递给组件的 checkout
属性:
<x-paddle-checkout :checkout="$checkout" class="w-full" />
要调整内联结账组件的高度,您可以将 height
属性传递给 Blade 组件:
<x-paddle-checkout :checkout="$checkout" class="w-full" height="500" />
请查阅 Paddle 的 内联结账指南 和 可用的结账设置 以获取有关内联结账自定义选项的更多详细信息。
手动渲染内联结账
您还可以在不使用 Laravel 内置 Blade 组件的情况下手动渲染内联结账。要开始,请生成结账会话 如前面的示例所示:
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 演示此操作;但是,您可以根据自己的前端堆栈修改此示例:
<?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
方法:
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:
use Laravel\Paddle\Cashier;
$prices = Cashier::previewPrices(['pri_123', 'pri_456']);
货币将根据请求的 IP 地址确定;但是,您可以选择提供特定国家以检索价格:
use Laravel\Paddle\Cashier;
$prices = Cashier::previewPrices(['pri_123', 'pri_456'], ['address' => [
'country_code' => 'BE',
'postal_code' => '1234',
]]);
检索到价格后,您可以根据自己的意愿显示它们:
<ul>
@foreach ($prices as $price)
<li>{{ $price->product['name'] }} - {{ $price->total() }}</li>
@endforeach
</ul>
您还可以单独显示小计价格和税额:
<ul>
@foreach ($prices as $price)
<li>{{ $price->product['name'] }} - {{ $price->subtotal() }} (+ {{ $price->tax() }} 税)</li>
@endforeach
</ul>
有关更多信息,请 查看 Paddle 的 API 文档关于价格预览。
客户价格预览
如果用户已经是客户,并且您希望显示适用于该客户的价格,您可以通过直接从客户实例检索价格来实现:
use App\Models\User;
$prices = User::find(1)->previewPrices(['pri_123', 'pri_456']);
在内部,Cashier 将使用用户的客户 ID 来检索其货币的价格。因此,例如,居住在美国的用户将看到以美元计价的价格,而居住在比利时的用户将看到以欧元计价的价格。如果找不到匹配的货币,将使用产品的默认货币。您可以在 Paddle 控制面板中自定义产品或订阅计划的所有价格。
折扣
您还可以选择在折扣后显示价格。当调用 previewPrices
方法时,您通过 discount_id
选项提供折扣 ID:
use Laravel\Paddle\Cashier;
$prices = Cashier::previewPrices(['pri_123', 'pri_456'], [
'discount_id' => 'dsc_123'
]);
然后,显示计算后的价格:
<ul>
@foreach ($prices as $price)
<li>{{ $price->product['name'] }} - {{ $price->total() }}</li>
@endforeach
</ul>
客户
客户默认值
Cashier 允许您在创建结账会话时为客户定义一些有用的默认值。设置这些默认值允许您预填充客户的电子邮件地址和姓名,以便他们可以立即进入结账小部件的支付部分。您可以通过重写以下方法在可计费模型上设置这些默认值:
/**
* 获取与 Paddle 关联的客户姓名。
*/
public function paddleName(): string|null
{
return $this->name;
}
/**
* 获取与 Paddle 关联的客户电子邮件地址。
*/
public function paddleEmail(): string|null
{
return $this->email;
}
这些默认值将用于 Cashier 生成的每个 结账会话 的操作。
检索客户
您可以使用 Cashier::findBillable
方法通过其 Paddle 客户 ID 检索客户。此方法将返回可计费模型的实例:
use Laravel\Paddle\Cashier;
$user = Cashier::findBillable($customerId);
创建客户
有时,您可能希望在不开始订阅的情况下创建 Paddle 客户。您可以使用 createAsCustomer
方法来实现:
$customer = $user->createAsCustomer();
将返回 Laravel\Paddle\Customer
的实例。客户在 Paddle 中创建后,您可以在稍后开始订阅。您可以提供一个可选的 $options
数组,以传递任何其他 Paddle API 支持的客户创建参数:
$customer = $user->createAsCustomer($options);
订阅
创建订阅
要创建订阅,首先从数据库中检索可计费模型的实例,通常是 App\Models\User
的实例。一旦您检索到模型实例,您可以使用 subscribe
方法创建模型的结账会话:
use Illuminate\Http\Request;
Route::get('/user/subscribe', function (Request $request) {
$checkout = $request->user()->subscribe($premium = 12345, 'default')
->returnTo(route('home'));
return view('billing', ['checkout' => $checkout]);
});
传递给 subscribe
方法的第一个参数是用户订阅的特定价格。此值应对应于 Paddle 中价格的标识符。returnTo
方法接受用户在成功完成结账后将被重定向到的 URL。传递给 subscribe
方法的第二个参数应为订阅的内部“类型”。如果您的应用程序只提供单个订阅,您可以将其称为 default
或 primary
。此订阅类型仅供内部应用程序使用,不应显示给用户。此外,它不应包含空格,并且在创建订阅后永远不应更改。
您还可以使用 customData
方法提供有关订阅的自定义元数据数组:
$checkout = $request->user()->subscribe($premium = 12345, 'default')
->customData(['key' => 'value'])
->returnTo(route('home'));
一旦创建了订阅结账会话,结账会话可以提供给 Cashier Paddle 附带的 paddle-button
Blade 组件:
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
订阅
</x-paddle-button>
在用户完成结账后,Paddle 将发送一个 subscription_created
webhook。Cashier 将接收此 webhook 并为您的客户设置订阅。为了确保所有 webhook 都被正确接收和处理,请确保您已正确 设置 webhook 处理。
检查订阅状态
一旦用户订阅了您的应用程序,您可以使用多种方便的方法检查他们的订阅状态。首先,subscribed
方法返回 true
,如果用户有有效的订阅,即使订阅当前在试用期内:
if ($user->subscribed()) {
// ...
}
如果您的应用程序提供多个订阅,您可以在调用 subscribed
方法时指定订阅:
if ($user->subscribed('default')) {
// ...
}
subscribed
方法也非常适合用作 路由中间件,允许您根据用户的订阅状态过滤对路由和控制器的访问:
<?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
方法。此方法对于确定是否应向用户显示警告,表明他们仍在试用期内非常有用:
if ($user->subscription()->onTrial()) {
// ...
}
subscribedToPrice
方法可用于确定用户是否订阅了基于给定 Paddle 价格 ID 的特定计划。在此示例中,我们将确定用户的 default
订阅是否积极订阅了每月价格:
if ($user->subscribedToPrice($monthly = 'pri_123', 'default')) {
// ...
}
recurring
方法可用于确定用户是否当前处于活动订阅中,并且不再在试用期或宽限期内:
if ($user->subscription()->recurring()) {
// ...
}
取消的订阅状态
要确定用户是否曾经是活跃的订阅者但已取消其订阅,您可以使用 canceled
方法:
if ($user->subscription()->canceled()) {
// ...
}
您还可以确定用户是否已取消其订阅,但仍在“宽限期”内,直到订阅完全到期。例如,如果用户在 3 月 5 日取消了原定于 3 月 10 日到期的订阅,则用户在 3 月 10 日之前处于“宽限期”。此外,subscribed
方法在此期间仍将返回 true
:
if ($user->subscription()->onGracePeriod()) {
// ...
}
逾期状态
如果订阅的付款失败,它将被标记为 past_due
。当您的订阅处于此状态时,它将不再处于活动状态,直到客户更新其付款信息。您可以使用订阅实例上的 pastDue
方法确定订阅是否逾期:
if ($user->subscription()->pastDue()) {
// ...
}
当订阅逾期时,您应该指示用户 更新其付款信息。
如果您希望在 past_due
状态下仍将订阅视为有效,您可以使用 Cashier 提供的 keepPastDueSubscriptionsActive
方法。通常,此方法应在 AppServiceProvider
的 register
方法中调用:
use Laravel\Paddle\Cashier;
/**
* 注册任何应用程序服务。
*/
public function register(): void
{
Cashier::keepPastDueSubscriptionsActive();
}
当订阅处于 past_due
状态时,无法更改它,直到更新付款信息。因此,当订阅处于 past_due
状态时,swap
和 updateQuantity
方法将抛出异常。
订阅范围
大多数订阅状态也可用作查询范围,以便您可以轻松查询数据库中处于给定状态的订阅:
// 获取所有有效的订阅...
$subscriptions = Subscription::query()->valid()->get();
// 获取用户的所有已取消订阅...
$subscriptions = $user->subscriptions()->canceled()->get();
可用范围的完整列表如下:
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:
// 收取单个价格...
$response = $user->subscription()->charge('pri_123');
// 同时收取多个价格...
$response = $user->subscription()->charge(['pri_123', 'pri_456']);
charge
方法不会在其订阅的下一个计费周期之前实际向客户收费。如果您希望立即向客户收费,可以使用 chargeAndInvoice
方法:
$response = $user->subscription()->chargeAndInvoice('pri_123');
更新支付信息
Paddle 始终为每个订阅保存一种支付方式。如果您想更新订阅的默认支付方式,您应该使用订阅模型上的 redirectToUpdatePaymentMethod
方法将客户重定向到 Paddle 的托管支付方式更新页面:
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
方法:
use App\Models\User;
$user = User::find(1);
$user->subscription()->swap($premium = 'pri_456');
如果您希望立即向用户开具发票而不是等待他们的下一个计费周期,可以使用 swapAndInvoice
方法:
$user = User::find(1);
$user->subscription()->swapAndInvoice($premium = 'pri_456');
按比例分配
默认情况下,Paddle 在更改计划时会按比例分配费用。可以使用 noProrate
方法在不按比例分配费用的情况下更新订阅:
$user->subscription('default')->noProrate()->swap($premium = 'pri_456');
如果您希望禁用按比例分配并立即向客户开具发票,可以结合使用 swapAndInvoice
方法和 noProrate
:
$user->subscription('default')->noProrate()->swapAndInvoice($premium = 'pri_456');
或者,为了不向客户收取订阅变更的费用,您可以使用 doNotBill
方法:
$user->subscription('default')->doNotBill()->swap($premium = 'pri_456');
有关 Paddle 的按比例分配政策的更多信息,请查阅 Paddle 的 按比例分配文档。
订阅数量
有时,订阅会受到“数量”的影响。例如,一个项目管理应用程序可能会按每个项目每月收取 $10 的费用。要轻松增加或减少订阅的数量,请使用 incrementQuantity
和 decrementQuantity
方法:
$user = User::find(1);
$user->subscription()->incrementQuantity();
// 将五个添加到订阅的当前数量...
$user->subscription()->incrementQuantity(5);
$user->subscription()->decrementQuantity();
// 从订阅的当前数量中减去五个...
$user->subscription()->decrementQuantity(5);
或者,您可以使用 updateQuantity
方法设置特定数量:
$user->subscription()->updateQuantity(10);
可以使用 noProrate
方法在不按比例分配费用的情况下更新订阅的数量:
$user->subscription()->noProrate()->updateQuantity(10);
多产品订阅的数量
如果您的订阅是 多产品订阅,您应该将希望增加或减少数量的价格的 ID 作为第二个参数传递给增量/减量方法:
$user->subscription()->incrementQuantity(1, 'price_chat');
多产品订阅
多产品订阅 允许您将多个计费产品分配给单个订阅。例如,假设您正在构建一个客户服务“帮助台”应用程序,其基本订阅价格为每月 $10,但提供一个额外的实时聊天附加产品,价格为每月 $15。
在创建订阅结账会话时,您可以通过将价格数组作为第一个参数传递给 subscribe
方法来为给定订阅指定多个产品:
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
订阅。两个价格将在各自的计费周期内收取。如果需要,您可以传递一个关联数组的键/值对,以指示每个价格的特定数量:
$user = User::find(1);
$checkout = $user->subscribe('default', ['price_monthly', 'price_chat' => 5]);
如果您希望向现有订阅添加另一个价格,您必须使用订阅的 swap
方法。在调用 swap
方法时,您还应该包括订阅的当前价格和数量:
$user = User::find(1);
$user->subscription()->swap(['price_chat', 'price_original' => 2]);
上面的示例将添加新价格,但客户将在下一个计费周期之前不会被收取费用。如果您希望立即向客户收费,可以使用 swapAndInvoice
方法:
$user->subscription()->swapAndInvoice(['price_chat', 'price_original' => 2]);
您可以使用 swap
方法通过省略要删除的价格来从订阅中删除价格:
$user->subscription()->swap(['price_original' => 2]);
您不能从订阅中删除最后一个价格。相反,您应该简单地取消订阅。
多个订阅
Paddle 允许您的客户同时拥有多个订阅。例如,您可能经营一个健身房,提供游泳订阅和举重订阅,每个订阅可能有不同的定价。当然,客户应该能够订阅其中一个或两个计划。
当您的应用程序创建订阅时,您可以将订阅的类型作为第二个参数提供给 subscribe
方法。类型可以是任何表示用户正在发起的订阅类型的字符串:
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
订阅上交换价格:
$user->subscription('swimming')->swap($swimmingYearly = 'pri_456');
当然,您也可以完全取消订阅:
$user->subscription('swimming')->cancel();
暂停订阅
要暂停订阅,请在用户的订阅上调用 pause
方法:
$user->subscription()->pause();
当订阅被暂停时,Cashier 将自动在您的数据库中设置 paused_at
列。此列用于确定何时 paused
方法应开始返回 true
。例如,如果客户在 3 月 1 日暂停订阅,但订阅计划在 3 月 5 日之前不会再次发生,则 paused
方法将继续返回 false
,直到 3 月 5 日。这是因为用户通常被允许在他们的计费周期结束之前继续使用应用程序。
默认情况下,暂停发生在下一个计费周期,因此客户可以使用他们已支付的剩余时间。如果您希望立即暂停订阅,可以使用 pauseNow
方法:
$user->subscription()->pauseNow();
使用 pauseUntil
方法,您可以将订阅暂停到特定的时间点:
$user->subscription()->pauseUntil(now()->addMonth());
或者,您可以使用 pauseNowUntil
方法立即暂停订阅,直到给定的时间点:
$user->subscription()->pauseNowUntil(now()->addMonth());
您可以使用 onPausedGracePeriod
方法确定用户是否已暂停其订阅但仍在“宽限期”内:
if ($user->subscription()->onPausedGracePeriod()) {
// ...
}
要恢复暂停的订阅,您可以在订阅上调用 resume
方法:
$user->subscription()->resume();
在暂停期间,无法修改订阅。如果您想交换到不同的计划或更新数量,必须先恢复订阅。
取消订阅
要取消订阅,请在用户的订阅上调用 cancel
方法:
$user->subscription()->cancel();
当订阅被取消时,Cashier 将自动在您的数据库中设置 ends_at
列。此列用于确定何时 subscribed
方法应开始返回 false
。例如,如果客户在 3 月 1 日取消订阅,但订阅计划在 3 月 5 日之前不会结束,则 subscribed
方法将继续返回 true
,直到 3 月 5 日。这是因为用户通常被允许在他们的计费周期结束之前继续使用应用程序。
您可以使用 onGracePeriod
方法确定用户是否已取消其订阅但仍在“宽限期”内:
if ($user->subscription()->onGracePeriod()) {
// ...
}
如果您希望立即取消订阅,可以在订阅上调用 cancelNow
方法:
$user->subscription()->cancelNow();
要停止在宽限期内取消的订阅,您可以调用 stopCancelation
方法:
$user->subscription()->stopCancelation();
Paddle 的订阅在取消后无法恢复。如果您的客户希望恢复其订阅,他们必须创建一个新订阅。
订阅试用
预先收集支付方式的试用
如果您希望在仍然收集支付方式信息的情况下为客户提供试用期,您应该在 Paddle 控制面板上为客户订阅的价格设置试用时间。然后,像往常一样启动结账会话:
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 在此日期之后不开始向客户收费。
如果客户的订阅在试用结束日期之前未被取消,他们将在试用期结束后立即被收费,因此您应该确保通知用户他们的试用结束日期。
您可以使用用户实例的 onTrial
方法或订阅实例的 onTrial
方法来确定用户是否在试用期内。以下两个示例是等效的:
if ($user->onTrial()) {
// ...
}
if ($user->subscription()->onTrial()) {
// ...
}
要确定现有试用是否已过期,您可以使用 hasExpiredTrial
方法:
if ($user->hasExpiredTrial()) {
// ...
}
if ($user->subscription()->hasExpiredTrial()) {
// ...
}
要确定用户是否在特定订阅类型的试用期内,您可以将类型提供给 onTrial
或 hasExpiredTrial
方法:
if ($user->onTrial('default')) {
// ...
}
if ($user->hasExpiredTrial('default')) {
// ...
}
无需预先收集支付方式的试用
如果您希望在不收集用户支付方式信息的情况下提供试用期,您可以将与用户关联的客户记录上的 trial_ends_at
列设置为所需的试用结束日期。这通常在用户注册期间完成:
use App\Models\User;
$user = User::create([
// ...
]);
$user->createAsCustomer([
'trial_ends_at' => now()->addDays(10)
]);
Cashier 将这种类型的试用称为“通用试用”,因为它不附加到任何现有订阅上。如果当前日期未超过 trial_ends_at
的值,则 User
实例上的 onTrial
方法将返回 true
:
if ($user->onTrial()) {
// 用户在试用期内...
}
一旦您准备好为用户创建实际订阅,您可以像往常一样使用 subscribe
方法:
use Illuminate\Http\Request;
Route::get('/user/subscribe', function (Request $request) {
$checkout = $user->subscribe('pri_monthly')
->returnTo(route('home'));
return view('billing', ['checkout' => $checkout]);
});
要检索用户的试用结束日期,您可以使用 trialEndsAt
方法。如果用户在试用期内,则该方法将返回一个 Carbon 日期实例;如果不在试用期内,则返回 null
。如果您希望获取特定订阅的试用结束日期,可以传递一个可选的订阅类型参数:
if ($user->onTrial('default')) {
$trialEndsAt = $user->trialEndsAt();
}
如果您希望知道用户是否在“通用”试用期内且尚未创建实际订阅,可以使用 onGenericTrial
方法:
if ($user->onGenericTrial()) {
// 用户在他们的“通用”试用期内...
}
延长或激活试用
您可以通过调用 extendTrial
方法并指定试用结束的时间点来延长现有的试用期:
$user->subscription()->extendTrial(now()->addDays(5));
或者,您可以通过调用订阅上的 activate
方法立即激活订阅,结束其试用期:
$user->subscription()->activate();
处理 Paddle Webhooks
Paddle 可以通过 webhooks 通知您的应用程序各种事件。默认情况下,Cashier 服务提供者注册一个指向 Cashier 的 webhook 控制器的路由。该控制器将处理所有传入的 webhook 请求。
默认情况下,该控制器将自动处理因过多失败收费而取消的订阅、订阅更新和支付方式更改的请求;然而,正如我们将很快发现的,您可以扩展此控制器以处理您喜欢的任何 Paddle webhook 事件。
要确保您的应用程序能够处理 Paddle webhooks,请确保在 Paddle 控制面板中 配置 webhook URL。默认情况下,Cashier 的 webhook 控制器响应 /paddle/webhook
URL 路径。您应该在 Paddle 控制面板中启用的所有 webhook 的完整列表包括:
- 客户更新
- 交易完成
- 交易更新
- 订阅创建
- 订阅更新
- 订阅暂停
- 订阅取消
确保使用 Cashier 附带的 webhook 签名验证 中间件保护传入请求。
Webhooks 和 CSRF 保护
由于 Paddle webhooks 需要绕过 Laravel 的 CSRF 保护,您应该确保 Laravel 不会尝试验证传入 Paddle webhooks 的 CSRF 令牌。为此,您应该在应用程序的 bootstrap/app.php
文件中将 paddle/*
排除在 CSRF 保护之外:
->withMiddleware(function (Middleware $middleware) {
$middleware->validateCsrfTokens(except: [
'paddle/*',
]);
})
Webhooks 和本地开发
为了使 Paddle 能够在本地开发期间向您的应用程序发送 webhooks,您需要通过 Ngrok 或 Expose 等网站共享服务来公开您的应用程序。如果您使用 Laravel Sail 在本地开发应用程序,可以使用 Sail 的 网站共享命令。
定义 Webhook 事件处理程序
Cashier 自动处理因失败收费而取消的订阅和其他常见的 Paddle webhooks。然而,如果您有其他 webhook 事件希望处理,可以通过监听 Cashier 派发的以下事件来实现:
Laravel\Paddle\Events\WebhookReceived
Laravel\Paddle\Events\WebhookHandled
这两个事件都包含 Paddle webhook 的完整有效负载。例如,如果您希望处理 transaction.billed
webhook,您可以注册一个 监听器 来处理该事件:
<?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 匹配:
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。如果需要,可以使用关联数组提供所购买产品的数量:
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 结账小部件并完成购买:
<x-paddle-button :checkout="$checkout" class="px-8 py-4">
购买
</x-paddle-button>
结账会话具有 customData
方法,允许您传递任何自定义数据到基础交易创建中。请查阅 Paddle 文档 了解在传递自定义数据时可用的选项:
$checkout = $user->checkout('pri_tshirt')
->customData([
'custom_option' => $value,
]);
退款交易
退款交易将把退款金额退还给客户在购买时使用的支付方式。如果您需要退款 Paddle 购买,可以在 Cashier\Paddle\Transaction
模型上使用 refund
方法。此方法接受一个理由作为第一个参数,一个或多个价格 ID 以可选金额的关联数组退款。您可以使用 transactions
方法检索给定可计费模型的交易。
例如,假设我们想要退款特定交易的价格 pri_123
和 pri_456
。我们想要全额退款 pri_123
,但只对 pri_456
退款两美元:
use App\Models\User;
$user = User::find(1);
$transaction = $user->transactions()->first();
$response = $transaction->refund('误收费', [
'pri_123', // 全额退款此价格...
'pri_456' => 200, // 仅部分退款此价格...
]);
上面的示例退款了交易中的特定行项目。如果您想要退款整个交易,只需提供一个理由:
$response = $transaction->refund('误收费');
有关退款的更多信息,请查阅 Paddle 的退款文档。
退款必须始终经过 Paddle 的批准才能完全处理。
信用交易
与退款类似,您还可以信用交易。信用交易将资金添加到客户的余额中,以便用于未来的购买。信用交易只能针对手动收集的交易进行,而不能针对自动收集的交易(如订阅),因为 Paddle 会自动处理订阅信用:
$transaction = $user->transactions()->first();
// 全额信用特定行项目...
$response = $transaction->credit('补偿', 'pri_123');
有关更多信息,请参阅 Paddle 的信用文档。
信用只能应用于手动收集的交易。自动收集的交易由 Paddle 自行信用。
交易
您可以通过 transactions
属性轻松检索可计费模型的交易数组:
use App\Models\User;
$user = User::find(1);
$transactions = $user->transactions;
交易代表您产品和购买的付款,并附有发票。只有完成的交易才会存储在您的应用程序数据库中。
在列出客户的交易时,您可以使用交易实例的方法显示相关的付款信息。例如,您可能希望在表格中列出每个交易,允许用户轻松下载任何发票:
<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
路由可能如下所示:
use Illuminate\Http\Request;
use Laravel\Paddle\Transaction;
Route::get('/download-invoice/{transaction}', function (Request $request, Transaction $transaction) {
return $transaction->redirectToInvoicePdf();
})->name('download-invoice');
过去和即将到来的付款
您可以使用 lastPayment
和 nextPayment
方法检索和显示客户的过去或即将到来的定期订阅付款:
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
:
下一个付款:{{ $nextPayment->amount() }} 到期于 {{ $nextPayment->date()->format('d/m/Y') }}
测试
在测试时,您应该手动测试您的计费流程,以确保您的集成按预期工作。
对于自动化测试,包括在 CI 环境中执行的测试,您可以使用 Laravel 的 HTTP 客户端 来伪造对 Paddle 的 HTTP 调用。尽管这并不测试 Paddle 的实际响应,但它确实提供了一种在不实际调用 Paddle API 的情况下测试您的应用程序的方法。