Laradoc

Appearance

Laravel Cashier (Stripe) ​

簡介 ​

Laravel Cashier Stripe 提供了一個富有表達力、流暢的介面，用於 Stripe 的訂閱計費服務。它處理了您懼怕編寫的幾乎所有訂閱計費樣板程式碼。除了基本的訂閱管理，Cashier 還可以處理優惠券、更換訂閱、訂閱「數量」、取消寬限期，甚至產生發票 PDF。

升級 Cashier ​

升級到新版 Cashier 時，仔細審閱升級指南非常重要。

⚠️ 警告

為防止破壞性變更，Cashier 使用固定 Stripe API 版本。Cashier 16 使用 Stripe API 版本 2025-06-30.basil。Stripe API 版本將在次要版本中更新，以利用新的 Stripe 功能和改進。

安裝 ​

首先，使用 Composer 套件管理器安裝 Cashier for Stripe 套件：

shell
composer require laravel/cashier

安裝套件後，使用 vendor:publish Artisan 命令發布 Cashier 的資料庫遷移：

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

然後，遷移您的資料庫：

shell
php artisan migrate

Cashier 的資料庫遷移會為您的 users 資料表增加多個欄位。它們還會建立一個新的 subscriptions 資料表來儲存您客戶的所有訂閱，以及一個 subscription_items 資料表用於有多個價格的訂閱。

如果您願意，您也可以使用 vendor:publish Artisan 命令發布 Cashier 的設定檔：

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

最後，為確保 Cashier 能正確處理所有 Stripe 事件，請記得設定 Cashier 的 webhook 處理。

⚠️ 警告

Stripe 建議用於儲存 Stripe 識別碼的任何欄位都應區分大小寫。因此，您應該確保使用 MySQL 時，stripe_id 欄位的欄位定序設為 utf8_bin。更多資訊請參閱 Stripe 文件。

設定 ​

可計費模型 ​

使用 Cashier 之前，請在您的可計費模型定義中加入 Billable Trait。通常，這會是 App\Models\User 模型。此 Trait 提供了多種方法，讓您可以執行常見的計費任務，例如建立訂閱、套用優惠券和更新付款方式資訊：

php
use Laravel\Cashier\Billable;

class User extends Authenticatable
{
    use Billable;
}

Cashier 假設您的可計費模型會是 Laravel 附帶的 App\Models\User 類別。如果您想更改此設定，可以透過 useCustomerModel 方法指定不同的模型。此方法通常應在您的 AppServiceProvider 類別的 boot 方法中呼叫：

php
use App\Models\Cashier\User;
use Laravel\Cashier\Cashier;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Cashier::useCustomerModel(User::class);
}

⚠️ 警告

如果您使用 Laravel 提供的 App\Models\User 模型以外的模型，您需要發布並修改Cashier 的資料庫遷移以符合您替代模型的資料表名稱。

API 金鑰 ​

接下來，您應該在應用程式的 .env 檔案中設定您的 Stripe API 金鑰。您可以從 Stripe 控制面板中取得您的 Stripe API 金鑰：

ini
STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret
STRIPE_WEBHOOK_SECRET=your-stripe-webhook-secret

⚠️ 警告

您應該確保 STRIPE_WEBHOOK_SECRET 環境變數已定義在您應用程式的 .env 檔案中，因為此變數用於確保傳入的 Webhook 確實來自 Stripe。

貨幣設定 ​

Cashier 的預設貨幣是美元 (USD)。您可以透過設定應用程式 .env 檔案中的 CASHIER_CURRENCY 環境變數來更改預設貨幣：

ini
CASHIER_CURRENCY=eur

除了設定 Cashier 的貨幣外，您還可以指定一個語言環境 (locale) 用於在發票上顯示貨幣值時的格式化。在內部，Cashier 利用 PHP 的 NumberFormatter 類別來設定貨幣語言環境 (locale)：

ini
CASHIER_CURRENCY_LOCALE=nl_BE

⚠️ 警告

為了使用 en 以外的語言環境 (locale)，請確保您的伺服器已安裝並設定 ext-intl PHP 擴充功能。

稅金設定 ​

由於 Stripe Tax，能夠自動計算所有由 Stripe 產生的發票的稅金。您可以透過在應用程式 App\Providers\AppServiceProvider 類別的 boot 方法中呼叫 calculateTaxes 方法來啟用自動稅金計算：

php
use Laravel\Cashier\Cashier;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Cashier::calculateTaxes();
}

一旦啟用稅金計算，任何新的訂閱和任何一次性產生的發票都會自動計算稅金。

為了使此功能正常運作，您客戶的帳單詳細資料，例如客戶的姓名、地址和稅號，需要同步到 Stripe。您可以使用 Cashier 提供的客戶資料同步和稅號方法來完成此操作。

日誌 ​

Cashier 允許您指定日誌通道，用於記錄嚴重的 Stripe 錯誤時。您可以透過在應用程式 .env 檔案中定義 CASHIER_LOGGER 環境變數來指定日誌通道：

ini
CASHIER_LOGGER=stack

透過 API 呼叫 Stripe 產生的例外將透過您應用程式的預設日誌通道進行記錄。

使用自訂模型 ​

您可以自由擴展 Cashier 內部使用的模型，透過定義您自己的模型並擴展相應的 Cashier 模型：

php
use Laravel\Cashier\Subscription as CashierSubscription;

class Subscription extends CashierSubscription
{
    // ...
}

定義您的模型後，您可以透過 Laravel\Cashier\Cashier 類別指示 Cashier 使用您的自訂模型。通常，您應該在應用程式 App\Providers\AppServiceProvider 類別的 boot 方法中告知 Cashier 您的自訂模型：

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

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);
}

快速入門 ​

銷售產品 ​

📌 備註

在利用 Stripe Checkout 之前，您應該在 Stripe 控制台中定義具有固定價格的 Products。此外，您還應該設定 Cashier 的 webhook 處理。

透過您的應用程式提供產品和訂閱計費可能令人望而生畏。然而，多虧了 Cashier 和 Stripe Checkout，您可以輕鬆建構現代、強大的支付整合。

為了向客戶收取非週期性、單次費用產品的費用，我們將利用 Cashier 將客戶引導至 Stripe Checkout，在那裡他們將提供支付詳細資訊並確認購買。一旦透過 Checkout 完成支付，客戶將被重新導向到您在應用程式中選擇的成功 URL：

php
use Illuminate\Http\Request;

Route::get('/checkout', function (Request $request) {
    $stripePriceId = 'price_deluxe_album';

    $quantity = 1;

    return $request->user()->checkout([$stripePriceId => $quantity], [
        'success_url' => 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');

正如您在上述範例中看到的，我們將利用 Cashier 提供的 checkout 方法，將客戶重新導向到 Stripe Checkout 以進行給定的「價格識別碼」。當使用 Stripe 時，「價格」指的是為特定產品定義的價格。

如有必要，該 checkout 方法將自動在 Stripe 中建立一個客戶，並將該 Stripe 客戶記錄連接到您的應用程式資料庫中對應的使用者。完成結帳環節後，客戶將被重新導向到專用的成功或取消頁面，您可以在其中向客戶顯示一條資訊性訊息。

提供中繼資料到 Stripe Checkout ​

銷售產品時，通常會透過您自己應用程式定義的 Cart 和 Order 模型來追蹤已完成的訂單和已購買的產品。將客戶重新導向到 Stripe Checkout 以完成購買時，您可能需要提供一個現有的訂單識別碼，以便在客戶被重新導向回您的應用程式時，您可以將完成的購買與對應的訂單關聯起來。

為此，您可以向 checkout 方法提供一個 metadata 陣列。讓我們想像一下，當使用者開始結帳流程時，我們的應用程式中會建立一個待處理的 Order。請記住，此範例中的 Cart 和 Order 模型僅為說明用途，並非由 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',
    ]);

    return $request->user()->checkout($order->price_ids, [
        'success_url' => route('checkout-success').'?session_id={CHECKOUT_SESSION_ID}',
        'cancel_url' => route('checkout-cancel'),
        'metadata' => ['order_id' => $order->id],
    ]);
})->name('checkout');

正如您在上述範例中看到的，當使用者開始結帳流程時，我們將購物車/訂單所有相關的 Stripe 價格識別碼提供給 checkout 方法。當然，您的應用程式負責在客戶新增這些項目時，將其與「購物車」或訂單關聯起來。我們還透過 metadata 陣列將訂單 ID 提供給 Stripe Checkout 環節。最後，我們已將 CHECKOUT_SESSION_ID 範本變數新增到結帳成功路由中。當 Stripe 將客戶重新導向回您的應用程式時，此範本變數將自動填入 Checkout 環節 ID。

接著，讓我們建構結帳成功路由。這是使用者透過 Stripe Checkout 完成購買後將被重新導向的路由。在此路由中，我們可以取得 Stripe Checkout 環節 ID 和相關的 Stripe Checkout 實例，以便存取我們提供的中繼資料並相應地更新客戶的訂單：

php
use App\Models\Order;
use Illuminate\Http\Request;
use Laravel\Cashier\Cashier;

Route::get('/checkout/success', function (Request $request) {
    $sessionId = $request->get('session_id');

    if ($sessionId === null) {
        return;
    }

    $session = Cashier::stripe()->checkout->sessions->retrieve($sessionId);

    if ($session->payment_status !== 'paid') {
        return;
    }

    $orderId = $session['metadata']['order_id'] ?? null;

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

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

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

請參閱 Stripe 的文件，以取得更多關於Checkout 環節物件所包含資料的資訊。

銷售訂閱 ​

📌 備註

在使用 Stripe Checkout 之前，您應該在 Stripe Dashboard 中定義好固定價格的 Products。此外，您應該要設定 Cashier 的 webhook 處理。

透過應用程式提供產品和訂閱計費可能令人望而生畏。然而，多虧了 Cashier 和 Stripe Checkout，您可以輕鬆建構現代化且穩健的支付整合。

若要學習如何使用 Cashier 和 Stripe Checkout 銷售訂閱，讓我們考慮一個簡單情境：訂閱服務提供基本月費方案 (price_basic_monthly) 和年費方案 (price_basic_yearly)。這兩種價格可以在我們的 Stripe Dashboard 中歸類為一個「基本」產品 (pro_basic)。此外，我們的訂閱服務可能還會提供一個「專家」方案 (pro_expert)。

首先，讓我們了解客戶如何訂閱我們的服務。當然，您可以想像客戶可能會在我們應用程式的定價頁面上點擊基本方案的「訂閱」按鈕。此按鈕或連結應該將使用者導向一個 Laravel 路由，該路由會為他們選擇的方案建立 Stripe Checkout Session：

php
use Illuminate\Http\Request;

Route::get('/subscription-checkout', function (Request $request) {
    return $request->user()
        ->newSubscription('default', 'price_basic_monthly')
        ->trialDays(5)
        ->allowPromotionCodes()
        ->checkout([
            'success_url' => route('your-success-route'),
            'cancel_url' => route('your-cancel-route'),
        ]);
});

如您在上述範例中所示，我們將客戶導向一個 Stripe Checkout Session，該 Session 將允許他們訂閱我們的基本方案。在成功結帳或取消之後，客戶將被導向回我們提供給 checkout 方法的 URL。為了知道他們的訂閱何時真正開始（因為某些付款方式需要幾秒鐘才能處理），我們還需要設定 Cashier 的 webhook 處理。

現在客戶可以開始訂閱了，我們需要限制應用程式的某些部分，以便只有訂閱使用者才能存取這些部分。當然，我們始終可以透過 Cashier 的 Billable Trait 提供的 subscribed 方法來判斷使用者的當前訂閱狀態：

blade
@if ($user->subscribed())
    <p>You are subscribed.</p>
@endif

我們甚至可以輕鬆判斷使用者是否訂閱了特定的產品或價格：

blade
@if ($user->subscribedToProduct('pro_basic'))
    <p>You are subscribed to our Basic product.</p>
@endif

@if ($user->subscribedToPrice('price_basic_monthly'))
    <p>You are subscribed to our monthly Basic plan.</p>
@endif

建立訂閱中介層 ​

為方便起見，您可能希望建立一個中介層，它用於判斷傳入的請求是否來自訂閱使用者。一旦定義了此中介層，您可以輕鬆地將其分配給路由，以防止未訂閱的使用者存取該路由：

php
<?php

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);
    }
}

一旦中介層已定義，您可以將其分配給路由：

php
use App\Http\Middleware\Subscribed;

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

允許客戶管理其帳務方案 ​

當然，客戶可能希望將其訂閱方案變更為其他產品或「級別」。最簡單的方法是將客戶導向 Stripe 的 客戶帳務入口網站，它提供了一個託管的使用者介面，允許客戶下載發票、更新付款方式和變更訂閱方案。

首先，在您的應用程式中定義一個連結或按鈕，將使用者導向 Laravel 路由，我們將使用此路由來啟動帳務入口網站 Session：

blade
<a href="{{ route('billing') }}">
    Billing
</a>

接下來，讓我們定義一個啟動 Stripe 客戶帳務入口網站 Session 並將使用者導向該入口網站的路由。redirectToBillingPortal 方法接受使用者離開入口網站時應返回的 URL：

php
use Illuminate\Http\Request;

Route::get('/billing', function (Request $request) {
    return $request->user()->redirectToBillingPortal(route('dashboard'));
})->middleware(['auth'])->name('billing');

📌 備註

只要您已設定 Cashier 的 webhook 處理，Cashier 就會透過檢查來自 Stripe 的傳入 webhook，自動使您應用程式中與 Cashier 相關的資料庫表格保持同步。例如，當使用者透過 Stripe 的客戶帳務入口網站取消訂閱時，Cashier 將會收到相應的 webhook，並在您應用程式的資料庫中將訂閱標記為「已取消」。

客戶 ​

取得客戶 ​

您可以使用 Cashier::findBillable 方法透過客戶的 Stripe ID 來取得客戶。此方法將會回傳可計費模型的實例：

php
use Laravel\Cashier\Cashier;

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

建立客戶 ​

有時，您可能希望在不開始訂閱的情況下建立 Stripe 客戶。您可以使用 createAsStripeCustomer 方法來完成此操作：

php
$stripeCustomer = $user->createAsStripeCustomer();

一旦客戶在 Stripe 中建立，您可以在稍後的日期開始訂閱。您可以提供一個選用的 $options 陣列，以傳遞任何額外 Stripe API 支援的客戶建立參數：

php
$stripeCustomer = $user->createAsStripeCustomer($options);

如果您希望回傳可計費模型的 Stripe 客戶物件，可以使用 asStripeCustomer 方法：

php
$stripeCustomer = $user->asStripeCustomer();

如果您希望取得給定可計費模型的 Stripe 客戶物件，但不確定該可計費模型是否已是 Stripe 中的客戶，則可以使用 createOrGetStripeCustomer 方法。如果 Stripe 中不存在該客戶，此方法將會建立一個新客戶：

php
$stripeCustomer = $user->createOrGetStripeCustomer();

更新客戶 ​

有時，您可能希望直接使用額外資訊更新 Stripe 客戶。您可以使用 updateStripeCustomer 方法來完成此操作。此方法接受一個 Stripe API 支援的客戶更新選項陣列：

php
$stripeCustomer = $user->updateStripeCustomer($options);

餘額 ​

Stripe 允許您對客戶的「餘額」進行儲值或扣款。之後，此餘額將會在新的發票上進行儲值或扣款。要檢查客戶的總餘額，您可以使用可計費模型上可用的 balance 方法。balance 方法將會回傳客戶貨幣中格式化的餘額字串表示：

php
$balance = $user->balance();

要對客戶餘額進行儲值，您可以向 creditBalance 方法提供一個值。如果您願意，您也可以提供一個描述：

php
$user->creditBalance(500, 'Premium customer top-up.');

向 debitBalance 方法提供一個值將會從客戶餘額中扣款：

php
$user->debitBalance(300, 'Bad usage penalty.');

applyBalance 方法將會為客戶建立新的客戶餘額交易。您可以使用 balanceTransactions 方法來取得這些交易記錄，這對於提供客戶儲值與扣款記錄以供審閱可能會很有用：

php
// Retrieve all transactions...
$transactions = $user->balanceTransactions();

foreach ($transactions as $transaction) {
    // Transaction amount...
    $amount = $transaction->amount(); // $2.31

    // Retrieve the related invoice when available...
    $invoice = $transaction->invoice();
}

稅號 ​

Cashier 提供了一種管理客戶稅號的簡單方法。例如，taxIds 方法可用於取得分配給客戶的所有 稅號作為集合：

php
$taxIds = $user->taxIds();

您也可以透過其識別碼來取得客戶的特定稅號：

php
$taxId = $user->findTaxId('txi_belgium');

您可以透過向 createTaxId 方法提供一個有效的 類型和值來建立一個新的稅號：

php
$taxId = $user->createTaxId('eu_vat', 'BE0123456789');

createTaxId 方法將會立即將 VAT ID 新增到客戶帳戶中。VAT 稅號的驗證也由 Stripe 處理；然而，這是一個非同步程序。您可以透過訂閱 customer.tax_id.updated webhook 事件並檢查 VAT 稅號的 verification 參數來收到驗證更新通知。有關處理 webhook 的更多資訊，請參閱 定義 webhook 處理器的文件。

您可以使用 deleteTaxId 方法來刪除稅號：

php
$user->deleteTaxId('txi_belgium');

將客戶資料與 Stripe 同步 ​

通常，當您的應用程式使用者更新其姓名、電子郵件地址或其他也由 Stripe 儲存的資訊時，您應該通知 Stripe 這些更新。這樣一來，Stripe 中的資訊副本將與您的應用程式中的資訊保持同步。

為了實現自動化，您可以為您的可計費模型定義一個事件監聽器，該監聽器會響應模型的 updated 事件。然後，在您的事件監聽器中，您可以在模型上呼叫 syncStripeCustomerDetails 方法：

php
use App\Models\User;
use function Illuminate\Events\queueable;

/**
 * The "booted" method of the model.
 */
protected static function booted(): void
{
    static::updated(queueable(function (User $customer) {
        if ($customer->hasStripeId()) {
            $customer->syncStripeCustomerDetails();
        }
    }));
}

現在，每當您的客戶模型更新時，其資訊將與 Stripe 同步。為方便起見，Cashier 將在客戶初次建立時自動將客戶資訊與 Stripe 同步。

您可以透過覆寫 Cashier 提供的各種方法，來自訂用於將客戶資訊同步到 Stripe 的欄位。例如，您可以覆寫 stripeName 方法，以自訂當 Cashier 將客戶資訊同步到 Stripe 時，應被視為客戶「姓名」的屬性：

php
/**
 * Get the customer name that should be synced to Stripe.
 */
public function stripeName(): string|null
{
    return $this->company_name;
}

同樣地，您可以覆寫 stripeEmail、stripePhone (最長 20 個字元)、stripeAddress 和 stripePreferredLocales 方法。這些方法將在 更新 Stripe 客戶物件時，將資訊同步到其對應的客戶參數。如果您希望完全掌控客戶資訊同步流程，您可以覆寫 syncStripeCustomerDetails 方法。

帳務入口網站 ​

Stripe 提供 設定帳務入口網站的簡單方法，以便您的客戶可以管理他們的訂閱、付款方式並查看他們的帳務歷史。您可以透過從控制器或路由中呼叫可計費模型上的 redirectToBillingPortal 方法，將您的使用者重新導向到帳務入口網站：

php
use Illuminate\Http\Request;

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

預設情況下，當使用者完成訂閱管理後，他們將能夠透過 Stripe 帳務入口網站中的連結返回您應用程式的 home 路由位置。您可以透過將 URL 作為參數傳遞給 redirectToBillingPortal 方法，來提供使用者應返回的自訂 URL：

php
use Illuminate\Http\Request;

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

如果您希望產生帳務入口網站的 URL，而不產生 HTTP 重新導向回應，您可以呼叫 billingPortalUrl 方法：

php
$url = $request->user()->billingPortalUrl(route('billing'));

付款方式 ​

儲存付款方式 ​

為建立訂閱或使用 Stripe 進行「一次性」收費，您需要儲存付款方式並從 Stripe 取得其識別碼。實現此目的的方法因您計劃將付款方式用於訂閱還是單次收費而異，因此我們將在下方分別探討。

用於訂閱的付款方式 ​

當儲存客戶的信用卡資訊供未來訂閱使用時，必須使用 Stripe 的「Setup Intents」API 來安全地收集客戶的付款方式詳細資訊。「Setup Intent」向 Stripe 表明了向客戶的付款方式收費的意圖。Cashier 的 Billable trait 包含了 createSetupIntent 方法，可輕鬆建立新的 Setup Intent。您應該從將渲染表單以收集客戶付款方式詳細資訊的路由或控制器中呼叫此方法：

php
return view('update-payment-method', [
    'intent' => $user->createSetupIntent()
]);

建立 Setup Intent 並將其傳遞給視圖後，您應該將其 secret 附加到將收集付款方式的元素。例如，請參考這個「更新付款方式」表單：

html
<input id="card-holder-name" type="text">

<!-- Stripe Elements Placeholder -->
<div id="card-element"></div>

<button id="card-button" data-secret="{{ $intent->client_secret }}">
    Update Payment Method
</button>

接著，可以使用 Stripe.js 函式庫將一個 Stripe Element 附加到表單，並安全地收集客戶的付款詳細資訊：

html
<script src="https://js.stripe.com/v3/"></script>

<script>
    const stripe = Stripe('stripe-public-key');

    const elements = stripe.elements();
    const cardElement = elements.create('card');

    cardElement.mount('#card-element');
</script>

然後，可以使用 Stripe 的 confirmCardSetup 方法來驗證卡片並從 Stripe 取得一個安全的「付款方式識別碼」：

js
const cardHolderName = document.getElementById('card-holder-name');
const cardButton = document.getElementById('card-button');
const clientSecret = cardButton.dataset.secret;

cardButton.addEventListener('click', async (e) => {
    const { setupIntent, error } = await stripe.confirmCardSetup(
        clientSecret, {
            payment_method: {
                card: cardElement,
                billing_details: { name: cardHolderName.value }
            }
        }
    );

    if (error) {
        // Display "error.message" to the user...
    } else {
        // The card has been verified successfully...
    }
});

在 Stripe 驗證卡片後，您可以將產生的 setupIntent.payment_method 識別碼傳遞給您的 Laravel 應用程式，並將其附加到客戶。此付款方式可以作為新的付款方式新增，或用於更新預設付款方式。您也可以立即使用此付款方式識別碼來建立新的訂閱。

📌 備註

如果您想了解更多關於 Setup Intents 和收集客戶付款詳細資訊的資訊，請參考 Stripe 提供的此概覽。

用於單次費用的付款方式 ​

當然，當對客戶的付款方式進行單次收費時，我們只需要使用一個付款方式識別碼一次。由於 Stripe 的限制，您不能使用客戶儲存的預設付款方式進行單次收費。您必須允許客戶使用 Stripe.js 函式庫輸入其付款方式詳細資訊。例如，請考慮以下表單：

html
<input id="card-holder-name" type="text">

<!-- Stripe Elements Placeholder -->
<div id="card-element"></div>

<button id="card-button">
    Process Payment
</button>

定義此類表單後，可以使用 Stripe.js 函式庫將一個 Stripe Element 附加到表單，並安全地收集客戶的付款詳細資訊：

html
<script src="https://js.stripe.com/v3/"></script>

<script>
    const stripe = Stripe('stripe-public-key');

    const elements = stripe.elements();
    const cardElement = elements.create('card');

    cardElement.mount('#card-element');
</script>

接著，可以使用 Stripe 的 createPaymentMethod 方法來驗證卡片並從 Stripe 取得一個安全的「付款方式識別碼」：

js
const cardHolderName = document.getElementById('card-holder-name');
const cardButton = document.getElementById('card-button');

cardButton.addEventListener('click', async (e) => {
    const { paymentMethod, error } = await stripe.createPaymentMethod(
        'card', cardElement, {
            billing_details: { name: cardHolderName.value }
        }
    );

    if (error) {
        // Display "error.message" to the user...
    } else {
        // The card has been verified successfully...
    }
});

如果卡片驗證成功，您可以將 paymentMethod.id 傳遞給您的 Laravel 應用程式並處理單次收費。

取得付款方式 ​

paymentMethods 方法在可計費模型實例上回傳 Laravel\Cashier\PaymentMethod 實例的集合：

php
$paymentMethods = $user->paymentMethods();

預設情況下，此方法會回傳所有類型的付款方式。若要取得特定類型的付款方式，您可以將 type 作為參數傳遞給該方法：

php
$paymentMethods = $user->paymentMethods('sepa_debit');

若要取得客戶的預設付款方式，可以使用 defaultPaymentMethod 方法：

php
$paymentMethod = $user->defaultPaymentMethod();

您可以使用 findPaymentMethod 方法來取得附加到可計費模型的特定付款方式：

php
$paymentMethod = $user->findPaymentMethod($paymentMethodId);

付款方式是否存在 ​

若要判斷可計費模型是否在其帳戶中附加了預設付款方式，請呼叫 hasDefaultPaymentMethod 方法：

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

您可以使用 hasPaymentMethod 方法來判斷可計費模型是否至少附加了一個付款方式到其帳戶：

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

此方法將判斷可計費模型是否擁有任何付款方式。若要判斷模型是否存在特定類型的付款方式，您可以將 type 作為參數傳遞給該方法：

php
if ($user->hasPaymentMethod('sepa_debit')) {
    // ...
}

更新預設付款方式 ​

updateDefaultPaymentMethod 方法可用於更新客戶的預設付款方式資訊。此方法接受一個 Stripe 付款方式識別碼，並會將新的付款方式指定為預設的帳單付款方式：

php
$user->updateDefaultPaymentMethod($paymentMethod);

若要將您的預設付款方式資訊與客戶在 Stripe 中的預設付款方式資訊同步，您可以使用 updateDefaultPaymentMethodFromStripe 方法：

php
$user->updateDefaultPaymentMethodFromStripe();

⚠️ 警告

客戶的預設付款方式僅可用於開立發票和建立新的訂閱。由於 Stripe 施加的限制，它不能用於單次收費。

新增付款方式 ​

若要新增付款方式，您可以在可計費模型上呼叫 addPaymentMethod 方法，並傳入付款方式識別碼：

php
$user->addPaymentMethod($paymentMethod);

📌 備註

若要瞭解如何取得付款方式識別碼，請查閱付款方式儲存的文件。

刪除付款方式 ​

若要刪除付款方式，您可以呼叫您想刪除的 Laravel\Cashier\PaymentMethod 實例上的 delete 方法：

php
$paymentMethod->delete();

deletePaymentMethod 方法將會從可計費模型中刪除指定的付款方式：

php
$user->deletePaymentMethod('pm_visa');

deletePaymentMethods 方法將會刪除可計費模型的所有付款方式資訊：

php
$user->deletePaymentMethods();

預設情況下，此方法會刪除所有類型的付款方式。若要刪除特定類型的付款方式，您可以將 type 作為引數傳遞給該方法：

php
$user->deletePaymentMethods('sepa_debit');

⚠️ 警告

如果使用者有啟用中的訂閱，您的應用程式不應允許他們刪除其預設付款方式。

訂閱 ​

訂閱提供了一種為客戶設定定期付款的方式。由 Cashier 管理的 Stripe 訂閱支援多種訂閱價格、訂閱數量、試用期等。

建立訂閱 ​

要建立訂閱，首先請取得您的可計費模型實例，通常會是 App\Models\User 的實例。取得模型實例後，您可以使用 newSubscription 方法來建立模型的訂閱：

php
use Illuminate\Http\Request;

Route::post('/user/subscribe', function (Request $request) {
    $request->user()->newSubscription(
        'default', 'price_monthly'
    )->create($request->paymentMethodId);

    // ...
});

傳遞給 newSubscription 方法的第一個參數應該是訂閱的內部類型。如果您的應用程式只提供單一訂閱，您可以將其稱為 default 或 primary。此訂閱類型僅供內部應用程式使用，不應向用戶顯示。此外，它不應包含空格，並且在建立訂閱後絕不應更改。第二個參數是用戶訂閱的特定價格。此值應與 Stripe 中的價格識別碼相對應。

接受 Stripe 付款方式識別碼 或 Stripe PaymentMethod 物件的 create 方法，將開始訂閱並使用可計費模型的 Stripe 客戶 ID 和其他相關帳務資訊來更新您的資料庫。

⚠️ 警告

直接將付款方式識別碼傳遞給 create 訂閱方法，也會自動將其新增到用戶儲存的付款方式中。

透過發票郵件收取定期付款 ​

與其自動收取客戶的定期付款，您可以指示 Stripe 在每次定期付款到期時向客戶發送電子郵件發票。然後，客戶可以在收到發票後手動支付。透過發票收取定期付款時，客戶無需預先提供付款方式：

php
$user->newSubscription('default', 'price_monthly')->createAndSendInvoice();

客戶在訂閱被取消之前支付發票的時間由 days_until_due 選項決定。預設為 30 天；但是，如果您願意，可以為此選項提供特定值：

php
$user->newSubscription('default', 'price_monthly')->createAndSendInvoice([], [
    'days_until_due' => 30
]);

數量 ​

如果您想在建立訂閱時為價格設定特定的 數量，您應該在建立訂閱之前在訂閱建構器上呼叫 quantity 方法：

php
$user->newSubscription('default', 'price_monthly')
    ->quantity(5)
    ->create($paymentMethod);

額外詳情 ​

如果您想指定 Stripe 支援的額外 客戶 或 訂閱 選項，您可以將它們作為 create 方法的第二個和第三個參數傳遞：

php
$user->newSubscription('default', 'price_monthly')->create($paymentMethod, [
    'email' => $email,
], [
    'metadata' => ['note' => 'Some extra information.'],
]);

優惠券 ​

如果您想在建立訂閱時應用優惠券，您可以使用 withCoupon 方法：

php
$user->newSubscription('default', 'price_monthly')
    ->withCoupon('code')
    ->create($paymentMethod);

或者，如果您想應用 Stripe 促銷碼，您可以使用 withPromotionCode 方法：

php
$user->newSubscription('default', 'price_monthly')
    ->withPromotionCode('promo_code_id')
    ->create($paymentMethod);

給定的促銷碼 ID 應該是分配給該促銷碼的 Stripe API ID，而不是面向客戶的促銷碼。如果您需要根據面向客戶的促銷碼找到促銷碼 ID，您可以使用 findPromotionCode 方法：

php
// Find a promotion code ID by its customer facing code...
$promotionCode = $user->findPromotionCode('SUMMERSALE');

// Find an active promotion code ID by its customer facing code...
$promotionCode = $user->findActivePromotionCode('SUMMERSALE');

在上面的範例中，返回的 $promotionCode 物件是 Laravel\Cashier\PromotionCode 的實例。此類別裝飾了一個底層的 Stripe\PromotionCode 物件。您可以透過呼叫 coupon 方法來取得與促銷碼相關的優惠券：

php
$coupon = $user->findPromotionCode('SUMMERSALE')->coupon();

優惠券實例允許您確定折扣金額，以及優惠券是固定折扣還是百分比折扣：

php
if ($coupon->isPercentage()) {
    return $coupon->percentOff().'%'; // 21.5%
} else {
    return $coupon->amountOff(); // $5.99
}

您也可以取得目前應用於客戶或訂閱的折扣：

php
$discount = $billable->discount();

$discount = $subscription->discount();

返回的 Laravel\Cashier\Discount 實例裝飾了一個底層的 Stripe\Discount 物件實例。您可以透過呼叫 coupon 方法來取得與此折扣相關的優惠券：

php
$coupon = $subscription->discount()->coupon();

如果您想將新的優惠券或促銷碼應用於客戶或訂閱，您可以透過 applyCoupon 或 applyPromotionCode 方法來實現：

php
$billable->applyCoupon('coupon_id');
$billable->applyPromotionCode('promotion_code_id');

$subscription->applyCoupon('coupon_id');
$subscription->applyPromotionCode('promotion_code_id');

請記住，您應該使用分配給促銷碼的 Stripe API ID，而不是面向客戶的促銷碼。在任何給定時間，客戶或訂閱只能應用一個優惠券或促銷碼。

有關此主題的更多資訊，請查閱 Stripe 關於 優惠券 和 促銷碼 的文件。

新增訂閱 ​

如果您想為已擁有預設付款方式的客戶新增訂閱，您可以在訂閱建構器上呼叫 add 方法：

php
use App\Models\User;

$user = User::find(1);

$user->newSubscription('default', 'price_monthly')->add();

從 Stripe Dashboard 建立訂閱 ​

您也可以直接從 Stripe Dashboard 建立訂閱。這樣做時，Cashier 會同步新增加的訂閱，並將其類型指定為 default。要自訂分配給從 Dashboard 建立的訂閱類型，請 定義 webhook 事件處理器。

此外，您只能透過 Stripe Dashboard 建立一種訂閱類型。如果您的應用程式提供使用不同類型的多個訂閱，則只能透過 Stripe Dashboard 新增一種訂閱類型。

最後，您應該始終確保每個應用程式提供的訂閱類型只新增一個活躍訂閱。如果客戶有兩個 default 訂閱，即使兩者都將與您應用程式的資料庫同步，Cashier 也只會使用最近新增的訂閱。

檢查訂閱狀態 ​

一旦客戶訂閱了您的應用程式，您可以使用各種便捷的方法輕鬆檢查其訂閱狀態。首先，subscribed 方法會回傳 true，如果客戶有啟用中的訂閱，即使該訂閱目前仍在試用期內。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
{
    /**
     * 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);
    }
}

如果您想判斷使用者是否仍在試用期內，可以使用 onTrial 方法。此方法有助於判斷您是否應向使用者顯示警告，告知他們仍在試用期內：

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

subscribedToProduct 方法可用於判斷使用者是否訂閱了指定產品，此判斷是基於指定的 Stripe 產品識別碼。在 Stripe 中，產品是價格的集合。在此範例中，我們將判斷使用者的 default 訂閱是否已啟用應用程式的「premium」產品。給定的 Stripe 產品識別碼應與您 Stripe 控制台中的其中一個產品識別碼相對應：

php
if ($user->subscribedToProduct('prod_premium', 'default')) {
    // ...
}

透過將陣列傳遞給 subscribedToProduct 方法，您可以判斷使用者的 default 訂閱是否已啟用應用程式的「basic」或「premium」產品：

php
if ($user->subscribedToProduct(['prod_basic', 'prod_premium'], 'default')) {
    // ...
}

subscribedToPrice 方法可用於判斷客戶的訂閱是否與給定的價格 ID 相符：

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

recurring 方法可用於判斷使用者目前是否已訂閱且不再處於試用期內：

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

⚠️ 警告

如果使用者有兩個相同類型的訂閱，subscription 方法將始終回傳最新的訂閱。例如，使用者可能有兩個類型為 default 的訂閱記錄；然而，其中一個訂閱可能是舊的、已過期的訂閱，而另一個是目前的、啟用中的訂閱。最新的訂閱將始終被回傳，而舊的訂閱則保留在資料庫中以供歷史查閱。

已取消的訂閱狀態 ​

若要判斷使用者曾是啟用中的訂閱者但已取消訂閱，您可以使用 canceled 方法：

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

您也可以判斷使用者是否已取消訂閱，但仍在「寬限期」內，直到訂閱完全到期。例如，如果使用者在 3 月 5 日取消了原定於 3 月 10 日到期的訂閱，則該使用者將在 3 月 10 日之前處於「寬限期」。請注意，在此期間 subscribed 方法仍會回傳 true：

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

若要判斷使用者是否已取消訂閱且不再處於「寬限期」內，您可以使用 ended 方法：

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

不完整與逾期狀態 ​

如果訂閱在建立後需要第二次付款操作，該訂閱將被標記為 incomplete。訂閱狀態儲存在 Cashier 的 subscriptions 資料庫表格的 stripe_status 欄位中。

同樣地，如果在更換價格時需要第二次付款操作，訂閱將被標記為 past_due。當您的訂閱處於這些狀態之一時，它將不會啟用，直到客戶確認其付款。判斷訂閱是否有不完整付款，可以使用可計費模型或訂閱實例上的 hasIncompletePayment 方法來完成：

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

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

當訂閱有不完整付款時，您應該引導使用者前往 Cashier 的付款確認頁面，並傳遞 latestPayment 識別碼。您可以使用訂閱實例上可用的 latestPayment 方法來取得此識別碼：

html
<a href="{{ route('cashier.payment', $subscription->latestPayment()->id) }}">
    Please confirm your payment.
</a>

如果您希望訂閱在處於 past_due 或 incomplete 狀態時仍被視為啟用中，您可以使用 Cashier 提供的 keepPastDueSubscriptionsActive 和 keepIncompleteSubscriptionsActive 方法。通常，這些方法應在您的 App\Providers\AppServiceProvider 的 register 方法中呼叫：

php
use Laravel\Cashier\Cashier;

/**
 * Register any application services.
 */
public function register(): void
{
    Cashier::keepPastDueSubscriptionsActive();
    Cashier::keepIncompleteSubscriptionsActive();
}

⚠️ 警告

當訂閱處於 incomplete 狀態時，在付款確認之前無法更改。因此，當訂閱處於 incomplete 狀態時，swap 和 updateQuantity 方法將拋出異常。

訂閱 Scope ​

大多數訂閱狀態也作為查詢 Scope 提供，因此您可以輕鬆地查詢資料庫中處於特定狀態的訂閱：

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

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

以下是所有可用 Scope 的完整列表：

php
Subscription::query()->active();
Subscription::query()->canceled();
Subscription::query()->ended();
Subscription::query()->incomplete();
Subscription::query()->notCanceled();
Subscription::query()->notOnGracePeriod();
Subscription::query()->notOnTrial();
Subscription::query()->onGracePeriod();
Subscription::query()->onTrial();
Subscription::query()->pastDue();
Subscription::query()->recurring();

更改價格 ​

當客戶訂閱您的應用程式後，他們偶爾可能會想更改為新的訂閱價格。要將客戶更換為新的價格，請將 Stripe 價格的識別碼傳遞給 swap 方法。更換價格時，假設使用者希望在訂閱先前已取消的情況下重新啟用訂閱。給定的價格識別碼應與 Stripe 儀表板中可用的 Stripe 價格識別碼相對應：

php
use App\Models\User;

$user = App\Models\User::find(1);

$user->subscription('default')->swap('price_yearly');

如果客戶正在試用期，則試用期將會保留。此外，如果訂閱存在「數量」，該數量也將會保留。

如果您想更換價格並取消客戶目前正在進行的任何試用期，您可以呼叫 skipTrial 方法：

php
$user->subscription('default')
    ->skipTrial()
    ->swap('price_yearly');

如果您想更換價格並立即向客戶開立發票，而不是等待下一個計費週期，您可以使用 swapAndInvoice 方法：

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

$user->subscription('default')->swapAndInvoice('price_yearly');

按比例收費 ​

預設情況下，Stripe 會在價格之間更換時按比例計算費用。noProrate 方法可用於更新訂閱價格，而不按比例計算費用：

php
$user->subscription('default')->noProrate()->swap('price_yearly');

有關訂閱按比例收費的更多資訊，請參閱 Stripe 文件。

⚠️ 警告

在 swapAndInvoice 方法之前執行 noProrate 方法將不會對按比例收費產生任何影響。發票將始終開立。

訂閱數量 ​

有時訂閱會受「數量」影響。例如，專案管理應用程式可能按每個專案每月收取 $10。您可以使用 incrementQuantity 和 decrementQuantity 方法輕鬆增加或減少您的訂閱數量：

php
use App\Models\User;

$user = User::find(1);

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

// Add five to the subscription's current quantity...
$user->subscription('default')->incrementQuantity(5);

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

// Subtract five from the subscription's current quantity...
$user->subscription('default')->decrementQuantity(5);

或者，您可以使用 updateQuantity 方法設定特定的數量：

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

noProrate 方法可用於更新訂閱數量，而不按比例計算費用：

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

有關訂閱數量的更多資訊，請參閱 Stripe 文件。

多產品訂閱的數量 ​

如果您的訂閱是 多產品訂閱，您應該將您希望增加或減少數量的價格 ID 作為第二個引數傳遞給 increment / decrement 方法：

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

多產品訂閱 ​

多產品訂閱 讓您能將多個計費產品指派給單一訂閱。例如，想像您正在建構一個客戶服務「服務台」應用程式，它每月的基本訂閱費用為 10 美元，但提供每月額外 15 美元的即時聊天附加產品。多產品訂閱的資訊儲存在 Cashier 的 subscription_items 資料庫表格中。

您可以透過將價格陣列作為第二個參數傳遞給 newSubscription 方法，為給定的訂閱指定多個產品：

php
use Illuminate\Http\Request;

Route::post('/user/subscribe', function (Request $request) {
    $request->user()->newSubscription('default', [
        'price_monthly',
        'price_chat',
    ])->create($request->paymentMethodId);

    // ...
});

在上述範例中，客戶的 default 訂閱將附加兩種價格。兩種價格都將在其各自的計費週期內收取費用。如有必要，您可以使用 quantity 方法來指示每種價格的特定數量：

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

$user->newSubscription('default', ['price_monthly', 'price_chat'])
    ->quantity(5, 'price_chat')
    ->create($paymentMethod);

如果您想將另一種價格新增到現有訂閱，您可以呼叫訂閱的 addPrice 方法：

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

$user->subscription('default')->addPrice('price_chat');

上述範例將會新增價格，客戶將在下一個計費週期收到費用。如果您想立即向客戶收取費用，可以使用 addPriceAndInvoice 方法：

php
$user->subscription('default')->addPriceAndInvoice('price_chat');

如果您想新增具有特定數量的價格，可以將數量作為 addPrice 或 addPriceAndInvoice 方法的第二個參數傳遞：

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

$user->subscription('default')->addPrice('price_chat', 5);

您可以使用 removePrice 方法從訂閱中移除價格：

php
$user->subscription('default')->removePrice('price_chat');

⚠️ 警告

您不能移除訂閱中的最後一個價格。相反地，您應該直接取消訂閱。

更換價格 ​

您也可以更改多產品訂閱所附加的價格。例如，想像一位客戶有一個 price_basic 訂閱，其中包含一個 price_chat 附加產品，而您想要將客戶從 price_basic 升級到 price_pro 價格：

php
use App\Models\User;

$user = User::find(1);

$user->subscription('default')->swap(['price_pro', 'price_chat']);

執行上述範例時，具有 price_basic 的基礎訂閱項目將被刪除，而具有 price_chat 的訂閱項目將被保留。此外，將會建立一個新的 price_pro 訂閱項目。

您也可以透過將鍵/值對陣列傳遞給 swap 方法來指定訂閱項目選項。例如，您可能需要指定訂閱價格的數量：

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

$user->subscription('default')->swap([
    'price_pro' => ['quantity' => 5],
    'price_chat'
]);

如果您想更換訂閱上的單一價格，可以使用訂閱項目本身的 swap 方法。如果您想保留訂閱其他價格上的所有現有中繼資料，這種方法特別有用：

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

$user->subscription('default')
    ->findItemOrFail('price_basic')
    ->swap('price_pro');

依比例收費 ​

預設情況下，Stripe 在新增或移除多產品訂閱的價格時，會按比例收取費用。如果您想在不按比例收費的情況下調整價格，您應該將 noProrate 方法串接到您的價格操作上：

php
$user->subscription('default')->noProrate()->removePrice('price_chat');

數量 ​

如果您想更新個別訂閱價格的數量，您可以使用 現有的數量方法，並將價格 ID 作為額外參數傳遞給該方法：

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

$user->subscription('default')->incrementQuantity(5, 'price_chat');

$user->subscription('default')->decrementQuantity(3, 'price_chat');

$user->subscription('default')->updateQuantity(10, 'price_chat');

⚠️ 警告

當訂閱有多個價格時，Subscription 模型上的 stripe_price 和 quantity 屬性將為 null。要存取個別價格屬性，您應該使用 Subscription 模型上可用的 items 關聯。

訂閱項目 ​

當訂閱有多個價格時，它將在您資料庫的 subscription_items 表中儲存多個訂閱「項目」。您可以透過訂閱上的 items 關聯來存取這些項目：

php
use App\Models\User;

$user = User::find(1);

$subscriptionItem = $user->subscription('default')->items->first();

// Retrieve the Stripe price and quantity for a specific item...
$stripePrice = $subscriptionItem->stripe_price;
$quantity = $subscriptionItem->quantity;

您也可以使用 findItemOrFail 方法來取得特定價格：

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

$subscriptionItem = $user->subscription('default')->findItemOrFail('price_chat');

多個訂閱 ​

Stripe 允許您的客戶同時擁有多個訂閱。例如，您經營一家健身房，提供游泳訂閱和舉重訂閱，並且每個訂閱可能具有不同的價格。當然，客戶應該能夠訂閱其中任一或兩者。

當您的應用程式建立訂閱時，您可以將訂閱類型提供給 newSubscription 方法。該類型可以是任何表示使用者正在啟動的訂閱類型的字串：

php
use Illuminate\Http\Request;

Route::post('/swimming/subscribe', function (Request $request) {
    $request->user()->newSubscription('swimming')
        ->price('price_swimming_monthly')
        ->create($request->paymentMethodId);

    // ...
});

在此範例中，我們為客戶啟動了每月游泳訂閱。然而，他們可能稍後想更換為年度訂閱。調整客戶的訂閱時，我們只需更換 swimming 訂閱上的價格即可：

php
$user->subscription('swimming')->swap('price_swimming_yearly');

當然，您也可以完全取消訂閱：

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

依用量計費 ​

依用量計費 (Usage based billing) 允許您根據客戶在計費週期內的產品用量向他們收費。例如，您可以根據客戶每月發送的簡訊或電子郵件數量來向他們收費。

若要開始使用用量計費，您首先需要在 Stripe 控制面板中建立一個新的產品，其具有依用量計費模型和一個計量器。建立計量器後，請儲存相關聯的事件名稱和計量器 ID，您將需要這些資訊來回報和取得用量。然後，使用 meteredPrice 方法將計量價格 ID 新增到客戶訂閱中：

php
use Illuminate\Http\Request;

Route::post('/user/subscribe', function (Request $request) {
    $request->user()->newSubscription('default')
        ->meteredPrice('price_metered')
        ->create($request->paymentMethodId);

    // ...
});

您也可以透過 Stripe Checkout 啟動按量計費訂閱：

php
$checkout = Auth::user()
    ->newSubscription('default', [])
    ->meteredPrice('price_metered')
    ->checkout();

return view('your-checkout-view', [
    'checkout' => $checkout,
]);

回報用量 ​

當您的客戶使用您的應用程式時，您需要將他們的用量回報給 Stripe，以便他們能夠準確計費。若要回報計量事件的用量，您可以使用 Billable 模型上的 reportMeterEvent 方法：

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

$user->reportMeterEvent('emails-sent');

預設情況下，會將「用量數量」1 新增到計費週期中。另外，您可以傳遞特定「用量」金額來新增到客戶在計費週期內的用量：

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

$user->reportMeterEvent('emails-sent', quantity: 15);

若要取得客戶計量器的事件摘要，您可以使用 Billable 實例的 meterEventSummaries 方法：

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

$meterUsage = $user->meterEventSummaries($meterId);

$meterUsage->first()->aggregated_value // 10

有關計量事件摘要的更多資訊，請參閱 Stripe 的計量事件摘要物件文件。

若要列出所有計量器，您可以使用 Billable 實例的 meters 方法：

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

$user->meters();

訂閱稅金 ​

⚠️ 警告

無需手動計算稅率，您可以使用 Stripe Tax 自動計算稅金

若要指定使用者在訂閱上支付的稅率，您應該在可計費模型上實作 taxRates 方法，並回傳一個包含 Stripe 稅率 ID 的陣列。您可以在您的 Stripe 控制面板中定義這些稅率：

php
/**
 * The tax rates that should apply to the customer's subscriptions.
 *
 * @return array<int, string>
 */
public function taxRates(): array
{
    return ['txr_id'];
}

taxRates 方法使您能夠以客戶為基礎應用稅率，這對於跨越多個國家和稅率的用戶群可能很有幫助。

如果您提供多產品訂閱，您可以透過在可計費模型上實作 priceTaxRates 方法來為每個價格定義不同的稅率：

php
/**
 * The tax rates that should apply to the customer's subscriptions.
 *
 * @return array<string, array<int, string>>
 */
public function priceTaxRates(): array
{
    return [
        'price_monthly' => ['txr_id'],
    ];
}

⚠️ 警告

taxRates 方法僅適用於訂閱費用。如果您使用 Cashier 進行「一次性」費用，您將需要當時手動指定稅率。

同步稅率 ​

當更改 taxRates 方法回傳的硬編碼稅率 ID 時，使用者任何現有訂閱的稅務設定將保持不變。如果您希望使用新的 taxRates 值更新現有訂閱的稅務價值，您應該在使用者訂閱實例上呼叫 syncTaxRates 方法：

php
$user->subscription('default')->syncTaxRates();

這也將同步多產品訂閱的任何項目稅率。如果您的應用程式提供多產品訂閱，您應該確保您的可計費模型實作了如上所述的 priceTaxRates 方法。

免稅 ​

Cashier 還提供了 isNotTaxExempt、isTaxExempt 和 reverseChargeApplies 方法來判斷客戶是否免稅。這些方法將呼叫 Stripe API 來判斷客戶的免稅狀態：

php
use App\Models\User;

$user = User::find(1);

$user->isTaxExempt();
$user->isNotTaxExempt();
$user->reverseChargeApplies();

⚠️ 警告

這些方法也適用於任何 Laravel\Cashier\Invoice 物件。但是，當在 Invoice 物件上呼叫時，這些方法將判斷發票建立時的免稅狀態。

訂閱錨定日期 ​

預設情況下，計費週期錨點是訂閱建立的日期，或者如果使用試用期，則是試用期結束的日期。如果您想修改計費錨定日期，您可以使用 anchorBillingCycleOn 方法：

php
use Illuminate\Http\Request;

Route::post('/user/subscribe', function (Request $request) {
    $anchor = Carbon::parse('first day of next month');

    $request->user()->newSubscription('default', 'price_monthly')
        ->anchorBillingCycleOn($anchor->startOfDay())
        ->create($request->paymentMethodId);

    // ...
});

有關管理訂閱計費週期的更多資訊，請查閱 Stripe 計費週期文件

取消訂閱 ​

若要取消訂閱，請在使用者訂閱上呼叫 cancel 方法：

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

當訂閱被取消時，Cashier 將自動在您的 subscriptions 資料庫表格中設定 ends_at 欄位。此欄位用於判斷 subscribed 方法何時應開始回傳 false。

例如，如果客戶在 3 月 1 日取消訂閱，但訂閱原定於 3 月 5 日結束，則 subscribed 方法將繼續回傳 true 直到 3 月 5 日。這樣做是因為通常允許使用者繼續使用應用程式直到其計費週期結束。

您可以使用 onGracePeriod 方法判斷使用者是否已取消訂閱但仍處於「寬限期」：

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

如果您希望立即取消訂閱，請在使用者訂閱上呼叫 cancelNow 方法：

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

如果您希望立即取消訂閱並開立任何剩餘的未開立發票的按量計費用量或新的 / 待處理的按比例計算的發票項目，請在使用者訂閱上呼叫 cancelNowAndInvoice 方法：

php
$user->subscription('default')->cancelNowAndInvoice();

您也可以選擇在特定時間點取消訂閱：

php
$user->subscription('default')->cancelAt(
    now()->plus(days: 10)
);

最後，您應始終在刪除相關使用者模型之前取消使用者的訂閱：

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

$user->delete();

恢復訂閱 ​

如果客戶已取消訂閱並希望恢復，您可以在訂閱上呼叫 resume 方法。客戶必須仍在「寬限期」內才能恢復訂閱：

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

如果客戶取消訂閱後，在訂閱完全到期前恢復訂閱，客戶不會立即被計費。相反，他們的訂閱將會重新啟用，並會在原始的計費週期內被計費。

訂閱試用 ​

預付付款方式 ​

如果您想為客戶提供試用期，同時仍預先收集付款方式資訊，您應該在建立訂閱時使用 trialDays 方法：

php
use Illuminate\Http\Request;

Route::post('/user/subscribe', function (Request $request) {
    $request->user()->newSubscription('default', 'price_monthly')
        ->trialDays(10)
        ->create($request->paymentMethodId);

    // ...
});

此方法將在資料庫中的訂閱記錄上設定試用期結束日期，並指示 Stripe 在此日期之後才開始向客戶收費。使用 trialDays 方法時，Cashier 將會覆寫 Stripe 中為該價格設定的任何預設試用期。

⚠️ 警告

如果客戶的訂閱在試用期結束日期之前未取消，一旦試用期到期，他們將立即被收取費用，因此您應該確保告知使用者其試用期結束日期。

trialUntil 方法允許您提供一個 DateTime 實例，用來指定試用期應該何時結束：

php
use Illuminate\Support\Carbon;

$user->newSubscription('default', 'price_monthly')
    ->trialUntil(Carbon::now()->plus(days: 10))
    ->create($paymentMethod);

您可以使用使用者實例的 onTrial 方法或訂閱實例的 onTrial 方法來判斷使用者是否仍在試用期內。以下兩個範例是等效的：

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

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

您可以使用 endTrial 方法立即結束訂閱試用：

php
$user->subscription('default')->endTrial();

若要判斷現有的試用期是否已過期，您可以使用 hasExpiredTrial 方法：

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

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

在 Stripe / Cashier 中定義試用天數 ​

您可以選擇在 Stripe 後台定義您的價格所獲得的試用天數，或者始終使用 Cashier 明確傳遞它們。如果您選擇在 Stripe 中定義價格的試用天數，您應該注意，除非您明確呼叫 skipTrial() 方法，否則新訂閱，包括過去曾有訂閱的客戶的新訂閱，將始終會獲得試用期。

不預付付款方式 ​

如果您想在不預先收集使用者付款方式資訊的情況下提供試用期，您可以將使用者記錄上的 trial_ends_at 欄位設定為您想要的試用結束日期。這通常在使用者註冊時完成：

php
use App\Models\User;

$user = User::create([
    // ...
    'trial_ends_at' => now()->plus(days: 10),
]);

⚠️ 警告

請務必在您可計費模型的類別定義中為 trial_ends_at 屬性新增一個 日期型別轉換。

Cashier 將此類試用稱為「通用試用 (generic trial)」，因為它未附加到任何現有訂閱。如果當前日期未超過 trial_ends_at 的值，則可計費模型實例上的 onTrial 方法將傳回 true：

php
if ($user->onTrial()) {
    // User is within their trial period...
}

一旦您準備好為使用者建立實際訂閱，您可以像往常一樣使用 newSubscription 方法：

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

$user->newSubscription('default', 'price_monthly')->create($paymentMethod);

若要取得使用者的試用期結束日期，您可以使用 trialEndsAt 方法。如果使用者正在試用中，此方法將傳回 Carbon 日期實例，否則傳回 null。如果您想取得除預設訂閱以外的特定訂閱的試用期結束日期，您也可以傳遞一個可選的訂閱類型參數：

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

如果您想具體知道使用者是否仍在「通用」試用期內且尚未建立實際訂閱，您也可以使用 onGenericTrial 方法：

php
if ($user->onGenericTrial()) {
    // User is within their "generic" trial period...
}

延長試用 ​

extendTrial 方法允許您在訂閱建立後延長試用期。如果試用期已經過期且客戶已經被收取訂閱費用，您仍然可以提供他們延長的試用期。在試用期內花費的時間將從客戶的下一張發票中扣除：

php
use App\Models\User;

$subscription = User::find(1)->subscription('default');

// End the trial 7 days from now...
$subscription->extendTrial(
    now()->plus(days: 7)
);

// Add an additional 5 days to the trial...
$subscription->extendTrial(
    $subscription->trial_ends_at->plus(days: 5)
);

處理 Stripe Webhook ​

📌 備註

您可以使用 Stripe CLI 在本地開發期間協助測試 Webhook。

Stripe 可以透過 Webhook 將各種事件通知您的應用程式。預設情況下，Cashier 服務提供者會自動註冊一個指向 Cashier Webhook 控制器的路由。此控制器將處理所有傳入的 Webhook 請求。

預設情況下，Cashier Webhook 控制器將自動處理因失敗次數過多而取消的訂閱 (依照您的 Stripe 設定)、客戶更新、客戶刪除、訂閱更新和付款方式變更；然而，正如我們稍後將會發現，您可以擴充此控制器來處理您喜歡的任何 Stripe Webhook 事件。

為確保您的應用程式可以處理 Stripe Webhook，請務必在 Stripe 控制面板中設定 Webhook URL。預設情況下，Cashier 的 Webhook 控制器會響應 /stripe/webhook URL 路徑。您應在 Stripe 控制面板中啟用所有 Webhook 的完整列表如下：

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

為方便起見，Cashier 包含一個 cashier:webhook Artisan 指令。此指令將在 Stripe 中建立一個監聽所有 Cashier 所需事件的 Webhook：

shell
php artisan cashier:webhook

預設情況下，所建立的 Webhook 將指向由 APP_URL 環境變數和 Cashier 所包含的 cashier.webhook 路由定義的 URL。如果您想使用不同的 URL，可以在呼叫指令時提供 --url 選項：

shell
php artisan cashier:webhook --url "https://example.com/stripe/webhook"

所建立的 Webhook 將使用您的 Cashier 版本相容的 Stripe API 版本。如果您想使用不同的 Stripe 版本，可以提供 --api-version 選項：

shell
php artisan cashier:webhook --api-version="2019-12-03"

建立後，Webhook 將立即啟用。如果您希望建立 Webhook 但在其準備好之前保持禁用狀態，可以在呼叫指令時提供 --disabled 選項：

shell
php artisan cashier:webhook --disabled

⚠️ 警告

請確保使用 Cashier 隨附的 Webhook 簽章驗證 中介層來保護傳入的 Stripe Webhook 請求。

Webhook 與 CSRF 保護 ​

由於 Stripe Webhook 需要繞過 Laravel 的 CSRF 保護，您應該確保 Laravel 不會嘗試驗證傳入 Stripe Webhook 的 CSRF 令牌。為此，您應該從應用程式的 bootstrap/app.php 檔案中排除 stripe/* 的 CSRF 保護：

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

定義 Webhook 事件處理器 ​

Cashier 會自動處理因費用失敗而取消的訂閱以及其他常見的 Stripe Webhook 事件。但是，如果您有其他想處理的 Webhook 事件，可以透過監聽 Cashier 派發的以下事件來實現：

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

這兩個事件都包含 Stripe Webhook 的完整負載。例如，如果您希望處理 invoice.payment_succeeded Webhook，您可以註冊一個 監聽器 來處理該事件：

php
<?php

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...
        }
    }
}

驗證 Webhook 簽章 ​

為保護您的 Webhook，您可以使用 Stripe 的 Webhook 簽章。為方便起見，Cashier 自動包含一個中介層，用於驗證傳入的 Stripe Webhook 請求是否有效。

要啟用 Webhook 驗證，請確保您的應用程式 .env 檔案中設定了 STRIPE_WEBHOOK_SECRET 環境變數。Webhook secret 可以從您的 Stripe 帳戶儀表板中取得。

單次費用 ​

簡單費用 ​

如果您想對客戶進行一次性收費，可以在可計費模型實例上使用 charge 方法。您需要將 付款方式識別碼 作為 charge 方法的第二個參數提供：

php
use Illuminate\Http\Request;

Route::post('/purchase', function (Request $request) {
    $stripeCharge = $request->user()->charge(
        100, $request->paymentMethodId
    );

    // ...
});

charge 方法接受一個陣列作為其第三個參數，允許您傳遞任何您希望傳遞給底層 Stripe 費用建立的選項。有關建立費用時可用的選項的更多資訊，請參閱 Stripe 文件：

php
$user->charge(100, $paymentMethod, [
    'custom_option' => $value,
]);

您也可以在沒有底層客戶或使用者的情況下使用 charge 方法。為此，可以在應用程式可計費模型的新實例上呼叫 charge 方法：

php
use App\Models\User;

$stripeCharge = (new User)->charge(100, $paymentMethod);

如果收費失敗，charge 方法將會拋出例外。如果收費成功，該方法將會回傳 Laravel\Cashier\Payment 的實例：

php
try {
    $payment = $user->charge(100, $paymentMethod);
} catch (Exception $e) {
    // ...
}

⚠️ 警告

charge 方法接受以應用程式所用貨幣的最小單位表示的支付金額。例如，如果客戶支付的是美元，金額應以美分表示。

包含發票的費用 ​

有時您可能需要進行一次性收費，並向客戶提供 PDF 發票。invoicePrice 方法就能實現這一點。例如，讓我們向客戶開立五件新襯衫的發票：

php
$user->invoicePrice('price_tshirt', 5);

該發票將立即從使用者的預設付款方式中扣款。invoicePrice 方法也接受一個陣列作為其第三個參數。此陣列包含發票項目的計費選項。該方法接受的第四個參數也是一個陣列，其中應包含發票本身的計費選項：

php
$user->invoicePrice('price_tshirt', 5, [
    'discounts' => [
        ['coupon' => 'SUMMER21SALE']
    ],
], [
    'default_tax_rates' => ['txr_id'],
]);

類似於 invoicePrice，您可以使用 tabPrice 方法，透過將多個項目（每張發票最多 250 個項目）加入客戶的「訂購單」中，然後向客戶開立發票，來進行一次性收費。例如，我們可以向客戶開立五件襯衫和兩個馬克杯的發票：

php
$user->tabPrice('price_tshirt', 5);
$user->tabPrice('price_mug', 2);
$user->invoice();

或者，您可以使用 invoiceFor 方法對客戶的預設付款方式進行「一次性」收費：

php
$user->invoiceFor('One Time Fee', 500);

儘管 invoiceFor 方法可供您使用，但建議您使用 invoicePrice 和 tabPrice 方法搭配預先定義的價格。這樣做，您將可以在 Stripe 後台儀表板中獲得關於您的產品銷售更好的分析和數據。

⚠️ 警告

invoice、invoicePrice 和 invoiceFor 方法將會建立 Stripe 發票，該發票會重試失敗的計費嘗試。如果您不希望發票重試失敗的費用，您需要在第一次費用失敗後使用 Stripe API 將其關閉。

建立支付意圖 ​

您可以透過在可計費模型實例上呼叫 pay 方法來建立新的 Stripe 支付意圖。呼叫此方法將會建立一個包裹在 Laravel\Cashier\Payment 實例中的支付意圖：

php
use Illuminate\Http\Request;

Route::post('/pay', function (Request $request) {
    $payment = $request->user()->pay(
        $request->get('amount')
    );

    return $payment->client_secret;
});

建立支付意圖後，您可以將 client secret 返回到應用程式的前端，以便使用者可以在其瀏覽器中完成付款。要了解更多關於使用 Stripe 支付意圖建立完整支付流程的資訊，請查閱 Stripe 文件。

當使用 pay 方法時，Stripe 後台儀表板中啟用的預設付款方式將會供客戶使用。或者，如果您只想允許使用某些特定的付款方式，您可以使用 payWith 方法：

php
use Illuminate\Http\Request;

Route::post('/pay', function (Request $request) {
    $payment = $request->user()->payWith(
        $request->get('amount'), ['card', 'bancontact']
    );

    return $payment->client_secret;
});

⚠️ 警告

pay 和 payWith 方法接受以應用程式所用貨幣的最小單位表示的支付金額。例如，如果客戶支付的是美元，金額應以美分表示。

退款 ​

如果您需要退款一筆 Stripe 費用，您可以使用 refund 方法。此方法接受 Stripe 支付意圖 ID 作為其第一個參數：

php
$payment = $user->charge(100, $paymentMethodId);

$user->refund($payment->id);

發票 ​

取得發票 ​

您可以很輕鬆地使用 invoices 方法取得可計費模型的發票陣列。invoices 方法會回傳 Laravel\Cashier\Invoice 實例的集合：

php
$invoices = $user->invoices();

如果您想在結果中包含待處理發票，可以使用 invoicesIncludingPending 方法：

php
$invoices = $user->invoicesIncludingPending();

您可以使用 findInvoice 方法來透過 ID 取得特定的發票：

php
$invoice = $user->findInvoice($invoiceId);

顯示發票資訊 ​

列出客戶的發票時，您可以使用發票的方法來顯示相關資訊。例如，您可能希望在表格中列出所有發票，讓使用者可以輕鬆下載任一發票：

blade
<table>
    @foreach ($invoices as $invoice)
        <tr>
            <td>{{ $invoice->date()->toFormattedDateString() }}</td>
            <td>{{ $invoice->total() }}</td>
            <td><a href="/user/invoice/{{ $invoice->id }}">Download</a></td>
        </tr>
    @endforeach
</table>

即將到來的發票 ​

若要取得客戶即將到來的發票，您可以使用 upcomingInvoice 方法：

php
$invoice = $user->upcomingInvoice();

同樣地，如果客戶有多個訂閱，您也可以為特定的訂閱取得即將到來的發票：

php
$invoice = $user->subscription('default')->upcomingInvoice();

預覽訂閱發票 ​

使用 previewInvoice 方法，您可以在變更價格之前預覽發票。這將允許您確定當價格發生變動時，客戶的發票會是什麼樣子：

php
$invoice = $user->subscription('default')->previewInvoice('price_yearly');

您可以將一個價格陣列傳遞給 previewInvoice 方法，以預覽包含多個新價格的發票：

php
$invoice = $user->subscription('default')->previewInvoice(['price_yearly', 'price_metered']);

產生發票 PDF ​

在產生發票 PDF 之前，您應該使用 Composer 安裝 Dompdf 函式庫，它是 Cashier 預設的發票渲染器：

shell
composer require dompdf/dompdf

在路由或控制器中，您可以使用 downloadInvoice 方法來產生指定發票的 PDF 下載。此方法會自動產生下載發票所需的適當 HTTP 回應：

php
use Illuminate\Http\Request;

Route::get('/user/invoice/{invoice}', function (Request $request, string $invoiceId) {
    return $request->user()->downloadInvoice($invoiceId);
});

預設情況下，發票上的所有資料都來自於 Stripe 中儲存的客戶和發票資料。檔案名稱基於您 app.name 的設定值。然而，您可以透過將一個陣列作為 downloadInvoice 方法的第二個引數來客製化部分資料。這個陣列允許您自訂公司和產品詳細資訊等資訊：

php
return $request->user()->downloadInvoice($invoiceId, [
    'vendor' => 'Your Company',
    'product' => 'Your Product',
    'street' => 'Main Str. 1',
    'location' => '2000 Antwerp, Belgium',
    'phone' => '+32 499 00 00 00',
    'email' => '[email protected]',
    'url' => 'https://example.com',
    'vendorVat' => 'BE123456789',
]);

downloadInvoice 方法也允許透過其第三個引數自訂檔案名稱。此檔案名稱會自動加上 .pdf 副檔名：

php
return $request->user()->downloadInvoice($invoiceId, [], 'my-invoice');

自訂發票渲染器 ​

Cashier 也支援使用自訂發票渲染器。預設情況下，Cashier 使用 DompdfInvoiceRenderer 實作，其利用 dompdf PHP 函式庫來產生 Cashier 的發票。然而，您可以透過實作 Laravel\Cashier\Contracts\InvoiceRenderer 介面來使用任何您想要的渲染器。例如，您可能希望透過呼叫第三方 PDF 渲染服務的 API 來渲染發票 PDF：

php
use Illuminate\Support\Facades\Http;
use Laravel\Cashier\Contracts\InvoiceRenderer;
use Laravel\Cashier\Invoice;

class ApiInvoiceRenderer implements InvoiceRenderer
{
    /**
     * Render the given invoice and return the raw PDF bytes.
     */
    public function render(Invoice $invoice, array $data = [], array $options = []): string
    {
        $html = $invoice->view($data)->render();

        return Http::get('https://example.com/html-to-pdf', ['html' => $html])->get()->body();
    }
}

實作了發票渲染器契約後，您應該更新應用程式 config/cashier.php 設定檔中的 cashier.invoices.renderer 設定值。這個設定值應該設定為您自訂渲染器實作的類別名稱。

結帳 ​

Cashier Stripe 也支援 Stripe Checkout。Stripe Checkout 透過提供預建的託管支付頁面，免除了實作自訂支付頁面的麻煩。

以下文件包含如何開始使用 Cashier 搭配 Stripe Checkout 的資訊。要了解更多關於 Stripe Checkout 的內容，您也應該考慮查閱 Stripe 關於 Checkout 的官方文件。

產品結帳 ​

您可以使用可計費模型上的 checkout 方法，為您在 Stripe 儀表板中建立的現有產品執行結帳。checkout 方法將啟動一個新的 Stripe Checkout 會話。預設情況下，您需要傳遞一個 Stripe 價格 ID：

php
use Illuminate\Http\Request;

Route::get('/product-checkout', function (Request $request) {
    return $request->user()->checkout('price_tshirt');
});

如有需要，您也可以指定產品數量：

php
use Illuminate\Http\Request;

Route::get('/product-checkout', function (Request $request) {
    return $request->user()->checkout(['price_tshirt' => 15]);
});

當客戶造訪此路由時，他們將被重新導向到 Stripe 的 Checkout 頁面。預設情況下，當使用者成功完成或取消購買時，他們將被重新導向到您的 home 路由位置，但您可以使用 success_url 和 cancel_url 選項指定自訂回調 URL：

php
use Illuminate\Http\Request;

Route::get('/product-checkout', function (Request $request) {
    return $request->user()->checkout(['price_tshirt' => 1], [
        'success_url' => route('your-success-route'),
        'cancel_url' => route('your-cancel-route'),
    ]);
});

在定義您的 success_url 結帳選項時，您可以指示 Stripe 在調用您的 URL 時將結帳會話 ID 作為查詢字串參數添加。為此，請將字串 {CHECKOUT_SESSION_ID} 添加到您的 success_url 查詢字串中。Stripe 會將此佔位符替換為實際的結帳會話 ID：

php
use Illuminate\Http\Request;
use Stripe\Checkout\Session;
use Stripe\Customer;

Route::get('/product-checkout', function (Request $request) {
    return $request->user()->checkout(['price_tshirt' => 1], [
        'success_url' => route('checkout-success').'?session_id={CHECKOUT_SESSION_ID}',
        'cancel_url' => route('checkout-cancel'),
    ]);
});

Route::get('/checkout-success', function (Request $request) {
    $checkoutSession = $request->user()->stripe()->checkout->sessions->retrieve($request->get('session_id'));

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

促銷代碼 ​

預設情況下，Stripe Checkout 不允許 使用者可兌換的促銷代碼。幸運的是，有一種簡單的方法可以為您的 Checkout 頁面啟用這些功能。為此，您可以調用 allowPromotionCodes 方法：

php
use Illuminate\Http\Request;

Route::get('/product-checkout', function (Request $request) {
    return $request->user()
        ->allowPromotionCodes()
        ->checkout('price_tshirt');
});

單次費用結帳 ​

您也可以為尚未在 Stripe 儀表板中建立的臨時產品執行簡單的費用收取。為此，您可以使用可計費模型上的 checkoutCharge 方法，並傳遞可收取的金額、產品名稱以及可選的數量。當客戶造訪此路由時，他們將被重新導向到 Stripe 的 Checkout 頁面：

php
use Illuminate\Http\Request;

Route::get('/charge-checkout', function (Request $request) {
    return $request->user()->checkoutCharge(1200, 'T-Shirt', 5);
});

⚠️ 警告

當使用 checkoutCharge 方法時，Stripe 將始終在您的 Stripe 儀表板中建立一個新的產品和價格。因此，我們建議您在 Stripe 儀表板中預先建立產品，然後改用 checkout 方法。

訂閱結帳 ​

⚠️ 警告

搭配 Stripe Checkout 使用訂閱功能時，您需要在 Stripe 儀表板中啟用 customer.subscription.created webhook。此 webhook 將在您的資料庫中建立訂閱記錄並儲存所有相關的訂閱項目。

您也可以使用 Stripe Checkout 來啟動訂閱。在透過 Cashier 的訂閱建構器方法定義訂閱後，您可以呼叫 checkout 方法。當客戶造訪此路由時，他們將被重新導向到 Stripe 的 Checkout 頁面：

php
use Illuminate\Http\Request;

Route::get('/subscription-checkout', function (Request $request) {
    return $request->user()
        ->newSubscription('default', 'price_monthly')
        ->checkout();
});

正如產品結帳一樣，您可以自訂成功和取消的 URL：

php
use Illuminate\Http\Request;

Route::get('/subscription-checkout', function (Request $request) {
    return $request->user()
        ->newSubscription('default', 'price_monthly')
        ->checkout([
            'success_url' => route('your-success-route'),
            'cancel_url' => route('your-cancel-route'),
        ]);
});

當然，您也可以為訂閱結帳啟用促銷代碼：

php
use Illuminate\Http\Request;

Route::get('/subscription-checkout', function (Request $request) {
    return $request->user()
        ->newSubscription('default', 'price_monthly')
        ->allowPromotionCodes()
        ->checkout();
});

⚠️ 警告

遺憾的是，Stripe Checkout 在啟動訂閱時不支援所有訂閱計費選項。在訂閱建構器上使用 anchorBillingCycleOn 方法、設定按比例分配行為或設定支付行為在 Stripe Checkout 會話期間將不起任何作用。請查閱 Stripe Checkout Session API 文件 以查看哪些參數可用。

Stripe Checkout 與試用期 ​

當然，在建立將透過 Stripe Checkout 完成的訂閱時，您可以定義一個試用期：

php
$checkout = Auth::user()->newSubscription('default', 'price_monthly')
    ->trialDays(3)
    ->checkout();

然而，試用期必須至少為 48 小時，這是 Stripe Checkout 支援的最短試用時間。

訂閱與 Webhook ​

請記住，Stripe 和 Cashier 透過 webhooks 更新訂閱狀態，因此客戶在輸入支付資訊後返回應用程式時，訂閱可能尚未啟用。為了處理這種情況，您可能希望顯示一條訊息，告知使用者其支付或訂閱正在處理中。

收集稅號 ​

Checkout 也支援收集客戶的稅號。要在結帳會話中啟用此功能，請在建立會話時調用 collectTaxIds 方法：

php
$checkout = $user->collectTaxIds()->checkout('price_tshirt');

調用此方法時，客戶將會看到一個新的核取方塊，允許他們表明是否以公司身份進行購買。如果是，他們將有機會提供其稅號。

⚠️ 警告

如果您已在應用程式的服務提供者中設定了 自動稅金收集，則此功能將自動啟用，無需調用 collectTaxIds 方法。

訪客結帳 ​

您可以使用 Checkout::guest 方法，為應用程式中沒有「帳號」的訪客啟動結帳流程：

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

Route::get('/product-checkout', function (Request $request) {
    return Checkout::guest()->create('price_tshirt', [
        'success_url' => route('your-success-route'),
        'cancel_url' => route('your-cancel-route'),
    ]);
});

類似於為現有使用者建立結帳流程時，您可以使用 Laravel\Cashier\CheckoutBuilder 實例上提供的其他方法來自訂訪客結帳流程：

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

Route::get('/product-checkout', function (Request $request) {
    return Checkout::guest()
        ->withPromotionCode('promo-code')
        ->create('price_tshirt', [
            'success_url' => route('your-success-route'),
            'cancel_url' => route('your-cancel-route'),
        ]);
});

訪客結帳完成後，Stripe 可以分派一個 checkout.session.completed webhook 事件，因此請務必設定您的 Stripe Webhook 以實際將此事件傳送至您的應用程式。一旦在 Stripe 控制面板中啟用 Webhook 後，您可以使用 Cashier 處理此 Webhook。Webhook 負載中包含的物件將會是一個結帳物件，您可以檢查該物件以完成客戶的訂單。

處理失敗付款 ​

有時，訂閱或單次費用的付款可能會失敗。此時，Cashier 將會拋出 Laravel\Cashier\Exceptions\IncompletePayment 異常，告知您付款失敗。捕獲此異常後，您有兩種處理方式。

首先，您可以將客戶重新導向到 Cashier 內建的專用付款確認頁面。此頁面已透過 Cashier 的服務提供者註冊了相關的具名路由。因此，您可以捕獲 IncompletePayment 異常並將使用者重新導向至付款確認頁面：

php
use Laravel\Cashier\Exceptions\IncompletePayment;

try {
    $subscription = $user->newSubscription('default', 'price_monthly')
        ->create($paymentMethod);
} catch (IncompletePayment $exception) {
    return redirect()->route(
        'cashier.payment',
        [$exception->payment->id, 'redirect' => route('home')]
    );
}

在付款確認頁面上，客戶將會被要求再次輸入其信用卡資訊，並執行 Stripe 所要求的任何額外操作，例如「3D Secure」確認。確認付款後，使用者將會被重新導向至上方指定的 redirect 參數所提供的 URL。重新導向後，URL 中將會新增 message (字串) 和 success (整數) 查詢字串變數。付款頁面目前支援以下付款方式：

  • 信用卡
  • 支付寶
  • Bancontact
  • BECS 直接扣款
  • EPS
  • Giropay
  • iDEAL
  • SEPA 直接扣款

或者，您可以讓 Stripe 為您處理付款確認。在這種情況下，您可以不在重新導向到付款確認頁面，而是在 Stripe 控制面板中設定 Stripe 的自動帳單電子郵件。不過，如果捕獲到 IncompletePayment 異常，您仍應告知使用者他們將會收到一封包含進一步付款確認說明的電子郵件。

針對使用 Billable trait 的模型，charge、invoiceFor 和 invoice 等方法可能會拋出付款異常。當與訂閱互動時，SubscriptionBuilder 上的 create 方法，以及 Subscription 和 SubscriptionItem 模型上的 incrementAndInvoice 和 swapAndInvoice 方法，都可能會拋出不完整的付款異常。

若要判斷現有訂閱是否有不完整的付款，可以使用可計費模型或訂閱實例上的 hasIncompletePayment 方法：

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

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

您可以透過檢查異常實例上的 payment 屬性來推斷不完整付款的特定狀態：

php
use Laravel\Cashier\Exceptions\IncompletePayment;

try {
    $user->charge(1000, 'pm_card_threeDSecure2Required');
} catch (IncompletePayment $exception) {
    // Get the payment intent status...
    $exception->payment->status;

    // Check specific conditions...
    if ($exception->payment->requiresPaymentMethod()) {
        // ...
    } elseif ($exception->payment->requiresConfirmation()) {
        // ...
    }
}

確認付款 ​

某些付款方式需要額外資料才能確認付款。例如，SEPA 付款方式在付款過程中需要額外的「授權 (mandate)」資料。您可以使用 withPaymentConfirmationOptions 方法將此資料提供給 Cashier：

php
$subscription->withPaymentConfirmationOptions([
    'mandate_data' => '...',
])->swap('price_xxx');

您可以查閱 Stripe API 文件以審查確認付款時接受的所有選項。

強客戶驗證 (SCA) ​

如果您的業務或其中一位客戶位於歐洲，您將需要遵守歐盟的強客戶驗證 (SCA) 法規。這些法規由歐盟於 2019 年 9 月實施，旨在防止支付詐騙。幸運的是，Stripe 和 Cashier 已為建構符合 SCA 規範的應用程式做好準備。

⚠️ 警告

在開始之前，請審查 Stripe 關於 PSD2 和 SCA 的指南以及他們關於 新 SCA API 的文件。

需要額外確認的付款 ​

SCA 法規通常需要額外驗證才能確認和處理付款。此時，Cashier 將會拋出 Laravel\Cashier\Exceptions\IncompletePayment 異常，告知您需要額外驗證。關於如何處理這些異常的更多資訊，可以在處理失敗付款的文件中找到。

Stripe 或 Cashier 呈現的付款確認畫面可能會針對特定銀行或發卡機構的付款流程進行客製化，並可能包含額外的信用卡確認、臨時小額費用、獨立裝置驗證或其他形式的驗證。

不完整與逾期狀態 ​

當付款需要額外確認時，訂閱將保持在 incomplete 或 past_due 狀態，如其 stripe_status 資料庫欄位所示。一旦付款確認完成，且您的應用程式透過 Stripe 的 webhook 收到通知，Cashier 將自動啟用客戶的訂閱。

有關 incomplete 和 past_due 狀態的更多資訊，請參閱 我們關於這些狀態的額外文件。

離線付款通知 ​

由於 SCA 法規要求客戶即使在訂閱啟用期間也需偶爾驗證其付款詳細資料，因此當需要離線付款確認時，Cashier 可以向客戶傳送通知。例如，這可能發生在訂閱續訂時。Cashier 的付款通知可以透過將 CASHIER_PAYMENT_NOTIFICATION 環境變數設定為通知類別來啟用。預設情況下，此通知是停用的。當然，Cashier 包含一個您可用於此目的的通知類別，但如果您願意，可以提供自己的通知類別：

ini
CASHIER_PAYMENT_NOTIFICATION=Laravel\Cashier\Notifications\ConfirmPayment

為確保離線付款確認通知送達，請驗證您的應用程式已設定 Stripe webhook，並且在您的 Stripe 控制面板中已啟用 invoice.payment_action_required webhook。此外，您的 Billable 模型也應該使用 Laravel 的 Illuminate\Notifications\Notifiable trait。

⚠️ 警告

即使客戶手動進行需要額外確認的付款，也會傳送通知。遺憾的是，Stripe 無法得知該付款是手動完成還是「離線」完成。但如果客戶在已經確認付款後再次造訪付款頁面，他們只會看到「付款成功」的訊息。客戶將不會被允許意外地確認同一筆付款兩次並產生意外的二次費用。

Stripe SDK ​

許多 Cashier 的物件都是 Stripe SDK 物件的封裝。若您想直接與 Stripe 物件互動，可方便地使用 asStripe 方法來取得它們：

php
$stripeSubscription = $subscription->asStripeSubscription();

$stripeSubscription->application_fee_percent = 5;

$stripeSubscription->save();

您也可以使用 updateStripeSubscription 方法來直接更新 Stripe 訂閱：

php
$subscription->updateStripeSubscription(['application_fee_percent' => 5]);

若您想直接使用 Stripe\StripeClient 用戶端，可以在 Cashier 類別上呼叫 stripe 方法。例如，您可以使用此方法來存取 StripeClient 實例並從您的 Stripe 帳號中取得價格列表：

php
use Laravel\Cashier\Cashier;

$prices = Cashier::stripe()->prices->all();

測試 ​

當測試使用 Cashier 的應用程式時，您可以模擬對 Stripe API 的實際 HTTP 請求；然而，這要求您部分重新實現 Cashier 本身的行為。因此，我們建議讓您的測試直接向實際的 Stripe API 發出請求。雖然這會較慢，但能提供更高的信心，確保您的應用程式如預期般運作，並且任何慢速測試都可以放在它們自己的 Pest / PHPUnit 測試群組中。

測試時，請記住 Cashier 本身已經有完善的測試套件，因此您只需專注於測試您應用程式的訂閱和付款流程，而非每一個底層的 Cashier 行為。

開始之前，請將您 Stripe Secret 金鑰的測試版本添加到您的 phpunit.xml 檔案中：

xml
<env name="STRIPE_SECRET" value="sk_test_<your-key>"/>

現在，每當您在測試期間與 Cashier 互動時，它將向您的 Stripe 測試環境發送實際的 API 請求。為了方便，您應該在 Stripe 測試帳號中預先填寫可在測試期間使用的訂閱 / 價格。

📌 備註

為了測試各種計費情境，例如信用卡拒絕和失敗，您可以使用 Stripe 提供的各種測試卡號和權杖。