Laravel Cashier (Stripe) 8.x Laravel

イントロダクション

Laravel Cashier Stripeは、Stripeのサブスクリプション課金サービスに対する表現力豊かで流暢なインターフェイスを提供します。それはあなたが書くことを恐れている定型的なサブスクリプション請求コードのほとんどすべてを処理します。キャッシャーは、基本的なサブスクリプション管理に加えて、クーポン、サブスクリプションの交換、サブスクリプションの「数量」、キャンセルの猶予期間を処理し、請求書のPDFを生成することもできます。

Cashierのアップデート

キャッシャーの新しいバージョンにアップグレードするときは、アップグレードガイドを注意深く確認することが重要です。

{note} 重大な変更を防ぐために、Cashierは固定のStripe APIバージョンを使用します。Cashier13はStripeAPIバージョン2020-08-27を利用しています。StripeAPIバージョンは、新しいStripe機能と改善点を利用するために、マイナーリリースで更新されます。

インストール

まず、Composerパッケージマネージャーを使用して、StripeのCashierパッケージをインストールします。

composer require laravel/cashier

{note} CashierにすべてのStripeイベントを適切に処理させるには、キャッシャーのWebhook処理を忘れずに設定してください。

データベースマイグレーション

Cashierのサービスプロバイダは独自のデータベースマイグレーションディレクトリを登録しているため、パッケージのインストール後にデータベースをマイグレーションするのを忘れないでください。Cashierのマイグレーションにより、usersテーブルへ列がいくつか追加されるだけでなく、顧客のすべてのサブスクリプションを保持する新しいsubscriptionsテーブルが作成されます。

php artisan migrate

Cashierに同梱されているマイグレーションを上書きする必要がある場合は、vendor:publish Artisanコマンドを使用してそれらをリソース公開できます。

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

Cashierのマイグレーションを完全に実行しないようにする場合は、Cashierが提供するignoreMigrationsメソッドを使用してください。通常、このメソッドは、AppServiceProviderのregisterメソッドで呼び出す必要があります。

use Laravel\Cashier\Cashier;

/**
 * 全アプリケーションサービスの登録
 *
 * @return void
 */
public function register()
{
    Cashier::ignoreMigrations();
}

{note} Stripeは、Stripe識別子の格納に使用される列では大文字と小文字を区別することを推奨しています。したがって、MySQLを使用する場合は、stripe_id列の列照合順序を確実にutf8_binへ設定する必要があります。これに関する詳細は、Stripeドキュメントにあります。

設定

Billableモデル

Cashierを使用する前に、Billableなモデルの定義へBillableトレイトを追加してください。通常、これはApp\Models\Userモデルになるでしょう。このトレイトはサブスクリプションの作成、クーポンの適用、支払い方法情報の更新など、一般的な請求タスクを実行できるようにするさまざまなメソッドを提供します。

use Laravel\Cashier\Billable;

class User extends Authenticatable
{
    use Billable;
}

CashierはLaravelに同梱されているApp\Models\UserクラスをBillableなモデルとして想定しています。これを変更したい場合は、useCustomerModelメソッドで別のモデルを指定します。このメソッドは通常、AppServiceProviderクラスのbootメソッドで呼び出します。

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

/**
 * アプリケーション全サービスの初期起動処理
 *
 * @return void
 */
public function boot()
{
    Cashier::useCustomerModel(User::class);
}

{note} Laravelが提供するApp\Models\Userモデル以外のモデルを使用する場合は、代替モデルのテーブル名と一致するように、提供されているCashierマイグレーションをリソース公開し、変更する必要があります。

ＡＰＩキー

次に、アプリケーションの.envファイルでStripeAPIキーを設定する必要があります。StripeAPIキーはStripeコントロールパネルから取得できます。

STRIPE_KEY=your-stripe-key
STRIPE_SECRET=your-stripe-secret

通貨設定

デフォルトのCashier通貨は米ドル(USD)です。アプリケーションの.envファイル内でCASHIER_CURRENCY環境変数を設定することにより、デフォルトの通貨を変更できます。

CASHIER_CURRENCY=eur

Cashierの通貨の設定に加え、請求書に表示するの金額の値をフォーマットするときに使用するロケールを指定することもできます。内部的には、CashierはPHPのNumberFormatterクラスを利用して通貨ロケールを設定します。

CASHIER_CURRENCY_LOCALE=nl_BE

{note} en以外のロケールを使用するには、ext-intl PHP拡張機能を確実にサーバにインストールおよび設定してください。

税設定

Stripe Taxのおかげで、Stripeが生成するすべての請求書の税金を自動的に計算可能になりました。税金の自動計算を有効にするには、アプリケーションのApp\Providers\AppServiceProviderクラスのbootメソッドでcalculateTaxesメソッドを実行します。

use Laravel\Cashier\Cashier;

/**
 * アプリケーションの全サービスの初期起動処理
 *
 * @return void
 */
public function boot()
{
    Cashier::calculateTaxes();
}

税計算を有効にすると、新規サブスクリプションや単発の請求書が作成された場合、自動的に税計算が行われます。

この機能を正常に動作させるためには、顧客の氏名、住所、課税IDなどの請求情報がStripeに同期されている必要があります。そのために、Cashierが提供する顧客データの同期や課税IDのメソッドを使用できます。

{note} 残念ながら今のところ、一回限りの課金や一回限りの支払いでは税金が計算されません。また、Stripe Taxは現在、ベータ期間中で「招待制」となっています。Stripe Taxへのアクセスをリクエストするには、Stripe Taxウェブサイトをご利用ください。

ログ

Cashierを使用すると、StripeのFatalエラーをログに記録するときに使用するログチャネルを指定できます。アプリケーションの.envファイル内でCASHIER_LOGGER環境変数を定義することにより、ログチャネルを指定できます。

CASHIER_LOGGER=stack

StripeへのAPI呼び出しで発生した例外は、アプリケーションのデフォルトログチャンネルにより記録されます。

カスタムモデルの使用

独自のモデルを定義し対応するCashierモデルを拡張することにより、Cashierが内部で使用するモデルを自由に拡張できます。

use Laravel\Cashier\Subscription as CashierSubscription;

class Subscription extends CashierSubscription
{
    // ...
}

モデルを定義した後、Laravel\Cashier\Cashierクラスを介してカスタムモデルを使用するようにCashierへ指示します。通常、アプリケーションのApp\Providers\AppServiceProviderクラスのbootメソッドで、カスタムモデルをキャッシャーへ通知する必要があります。

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

/**
 * 全アプリケーションサービスの初期起動処理
 *
 * @return void
 */
public function boot()
{
    Cashier::useSubscriptionModel(Subscription::class);
    Cashier::useSubscriptionItemModel(SubscriptionItem::class);
}

顧客

顧客の取得

Cashier::findBillableメソッドを使用して、StripeIDで顧客を取得できます。このメソッドは、Billableなモデルのインスタンスを返します。

use Laravel\Cashier\Cashier;

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

顧客の作成

まれに、サブスクリプションを開始せずにStripeの顧客を作成したいことも起きるでしょう。これは、createAsStripeCustomerメソッドを使用して実行できます。

$stripeCustomer = $user->createAsStripeCustomer();

Stripeで顧客を作成しておき、あとからサブスクリプションを開始できます。オプションの$options配列を指定して、追加のStripeAPIでサポートされている顧客作成パラメーターを渡せます。

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

BillableなモデルのStripe顧客オブジェクトを返す場合は、asStripeCustomerメソッドを使用できます。

$stripeCustomer = $user->asStripeCustomer();

createOrGetStripeCustomerメソッドは、特定のBillableモデルのStripe顧客オブジェクトを取得したいが、BillableモデルがすでにStripe内の顧客であるかわからない場合に使用できます。このメソッドは、Stripeに新しい顧客がまだ存在しない場合、新しい顧客を作成します。

$stripeCustomer = $user->createOrGetStripeCustomer();

顧客の更新

たまに、Stripeの顧客を追加情報と一緒に直接更新したい状況が起こるでしょう。これは、updateStripeCustomerメソッドを使用して実行できます。このメソッドは、StripeAPIでサポートされている顧客更新オプションの配列を引数に取ります。

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

Balances

Stripeでは、顧客の「残高」に入金または引き落としができます。後日新しい請求書に基づき、この残高は入金もしくは引き落としされます。顧客の合計残高を確認するには、Billableモデルに用意してあるbalanceメソッドを使用します。balanceメソッドは、顧客の通貨建てで残高をフォーマットした文字列で返します。

$balance = $user->balance();

顧客の残高から引き落とすには、applyBalanceメソッドに負の値を指定します。また、必要に応じて、説明を指定することもできます。

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

applyBalanceメソッドに正の値を渡すと、顧客の残高へ入金されます。

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

applyBalanceメソッドは、その顧客にたいする新しい顧客残高トランザクションを作成します。これらのトランザクションレコードはbalanceTransactionsメソッドを使って取得でき、顧客に確認してもらうため入金と引き落としのログを提供するのに便利です。

// 全トランザクションの取得
$transactions = $user->balanceTransactions();

foreach ($transactions as $transaction) {
    // トランザクションの金額
    $amount = $transaction->amount(); // $2.31

    // 利用できるなら、関連するインボイスの取得
    $invoice = $transaction->invoice();
}

タックスID

Cashierでは、顧客のタックスIDを簡単に管理できます。例えば、taxIdsメソッドを使って、顧客に割り当てられている全てのタックスIDをコレクションとして取得できます。

$taxIds = $user->taxIds();

識別子により、顧客の特定のタックスIDを取得することもできます。

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

有効なタイプと値をcreateTaxIdメソッドへ渡し、新しいタックスIDを作成できます。

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

createTaxIdメソッドは、VAT IDを顧客のアカウントへ即座に追加します。VAT IDの検証はStripeも行いますが、これは非同期のプロセスです。検証の更新を通知するには、customer.tax_id.updated Webフックイベントを購読し、VAT IDのverificationパラメータを検査します。Webフックの取り扱いについては、Webフックの処理の定義に関するドキュメントを参照してください。

deleteTaxIdメソッドを使ってタックスIDを削除できます。

$user->deleteTaxId('txi_belgium');

顧客データをStripeと同期する

通常、アプリケーションのユーザーが氏名、メールアドレス、その他のStripeも保存している情報を更新した場合、その更新をStripeへ通知する必要があります。それにより、Stripeの情報とアプリケーションの情報が同期されます。

これを自動化するには、Billableモデルにイベントリスナを定義して、モデルのupdatedイベントに対応させます。そして、イベントリスナの中で、モデルのsyncStripeCustomerDetailsメソッドを呼び出します。

use function Illuminate\Events\queueable;

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

これで、顧客モデルが更新されるたびに、その情報がStripeと同期されます。便利なように、Cashierは顧客の初回作成時、自動的に顧客の情報をStripeと同期します。

Cashierが提供する様々なメソッドをオーバーライドすることで、顧客情報をStripeに同期する際に使用するカラムをカスタマイズすることができます。例として、stripeNameメソッドをオーバーライドして、Cashierが顧客情報をStripeに同期する際に、顧客の「名前」とみなす属性をカスタマイズしてみましょう。

/**
 * ストライプと同期する顧客名の取得
 *
 * @return string|null
 */
public function stripeName()
{
    return $this->company_name;
}

同様に、stripeEmail、stripePhone、stripeAddressメソッドをオーバーライドできます。これらのメソッドは、Stripe顧客オブジェクトの更新の際に、対応する顧客パラメータへ情報を同期します。顧客情報の同期プロセスを完全にコントロールしたい場合は、syncStripeCustomerDetailsメソッドをオーバーライドできます。

請求ポータル

Stripeは、請求ポータルを設定する簡単な方法を提供しており、顧客はサブスクリプション、支払い方法を管理し、請求履歴を表示できます。コントローラまたはルートからBillableモデルでredirectToBillingPortalメソッドを呼び出すことにより、ユーザーを請求ポータルにリダイレクトできます。

use Illuminate\Http\Request;

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

デフォルトでは、ユーザーがサブスクリプションの管理を終了すると、Stripe課金ポータル内のリンクを介してアプリケーションのhomeルートに戻ることができます。redirectToBillingPortalメソッドに引数としてURLを渡すことにより、ユーザーが戻る必要のあるカスタムURLを指定できます。

use Illuminate\Http\Request;

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

HTTPリダイレクトレスポンスを生成せずに課金ポータルへのURLを生成したい場合は、billingPortalUrlメソッドを呼び出してください。

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

支払い方法

支払い方法の保存

Stripeでサブスクリプションを作成したり、「１回限りの」料金を実行したりするには、支払い方法を保存し、Stripeからその識別子を取得する必要があります。これを実現するアプローチは、サブスクリプションに支払い方法を使用するか、単一料金を使用するかにより異なるため、以降で両方とも説明します。

サブスクリプションの支払い方法

サブスクリプションで将来使用するときのため顧客のクレジットカード情報を保存する場合、Stripeの"Setup Intents" APIを使用して、顧客の支払い方法の詳細を安全に収集する必要があります。"Setup Intent "は、顧客の支払い方法により課金する意図をStripeに示します。CashierのBillableトレイトには、新しいセットアップインテントを簡単に作成するためのcreateSetupIntentメソッドを用意しています。顧客の支払い方法の詳細を収集するフォームをレンダーするルートまたはコントローラからこのメソッドを呼び出す必要があります。

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

セットアップインテントを作成してビューに渡したら、支払い方法を収集する要素にそのシークレットを添付する必要があります。たとえば、次の「支払い方法の更新」フォームについて考えてみます。

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

<!-- ストライプ要素のプレースホルダ -->
<div id="card-element"></div>

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

次に、Stripe.jsライブラリを使用して、Stripe要素をフォームに添付し、顧客の支払いの詳細を安全に収集します。

<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から安全な「支払い方法識別子」を取得します。

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) {
        // "error.message"をユーザーに表示…
    } else {
        // カードは正常に検証された…
    }
});

カードがStripeによって検証されたあとに、結果のsetupIntent.payment_method識別子をLaravelアプリケーションに渡して、顧客にアタッチします。支払い方法は、新しい支払い方法として追加またはデフォルトの支払い方法の更新に使用のいずれかです。すぐに支払い方法識別子を使用して新しいサブスクリプションを作成することもできます。

{tip} セットアップインテントと顧客の支払いの詳細の収集について詳しく知りたい場合は、Stripeが提供しているこの概要を確認してください。

一回限りの支払いの支払い方法

もちろん、お客様の支払い方法に対して１回請求を行う場合、支払い方法IDを使用する必要があるのは１回だけです。Stripeの制約により、顧客が保存したデフォルトの支払い方法を単一の請求に使用することはできません。Stripe.jsライブラリを使用して、顧客が支払い方法の詳細を入力できるようにする必要があります。たとえば、次のフォームについて考えてみます。

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

<!-- ストライプ要素プレースホルダ -->
<div id="card-element"></div>

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

このようなフォームを定義した後、Stripe.jsライブラリを使用してStripe要素をフォームに添付し、顧客の支払いの詳細を安全に収集します。

<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から安全な「支払い方法識別子」を取得します。

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) {
        // "error.message"をユーザーに表示…
    } else {
        // カードは正常に検証された…
    }
});

カードが正常に確認されたら、paymentMethod.idをLaravelアプリケーションに渡して、一回限りの請求を処理できます。

支払い方法の取得

BillableなモデルインスタンスのpaymentMethodsメソッドは、Laravel\Cashier\PaymentMethodインスタンスのコレクションを返します。

$paymentMethods = $user->paymentMethods();

このメソッドはデフォルトで、cardタイプの支払い方法を返します。別のタイプの支払い方法を取得するには、メソッドの引数にtypeを渡します。

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

顧客のデフォルトの支払い方法を取得するには、defaultPaymentMethodメソッドを使用します。

$paymentMethod = $user->defaultPaymentMethod();

findPaymentMethodメソッドを使用して、Billableモデルに関連付けている特定の支払い方法を取得できます。

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

顧客に支払い方法があるか判定

Billableなモデルのアカウントにデフォルトの支払い方法が関連付けられているかどうかを確認するには、hasDefaultPaymentMethodメソッドを呼び出します。

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

hasPaymentMethodメソッドを使用して、Billableなモデルのアカウントに少なくとも1つの支払い方法が関連付けられているかを判定できます。

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

このメソッドは、Billableモデルがcardタイプの支払い方法を持っているかどうかを判断します。そのモデルに別のタイプの支払い方法が存在するかを判断するには、メソッドの引数にtypeを渡してください。

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

デフォルト支払い方法の変更

updateDefaultPaymentMethodメソッドは、顧客のデフォルトの支払い方法情報を更新するために使用します。このメソッドは、Stripe支払い方法識別子を受け入れ、新しい支払い方法をデフォルトの請求支払い方法として割り当てます。

$user->updateDefaultPaymentMethod($paymentMethod);

デフォルトの支払い方法情報をStripeの顧客のデフォルトの支払い方法情報と同期するには、updateDefaultPaymentMethodFromStripeメソッドを使用できます。

$user->updateDefaultPaymentMethodFromStripe();

{note} 顧客のデフォルトの支払い方法は、新しいサブスクリプションの請求と作成にのみ使用できます。Stripeの制約により、１回だけの請求には使用できません。

支払い方法の追加

新しい支払い方法を追加するには、支払い方法IDを渡して、BillableモデルでaddPaymentMethodメソッドを呼び出してください。

$user->addPaymentMethod($paymentMethod);

{tip} 支払い方法の識別子を取得する方法については、支払い方法の保存に関するドキュメントを確認してください。

支払い方法の削除

支払い方法を削除するには、削除したいLaravel\Cashier\PaymentMethodインスタンスでdeleteメソッドを呼び出してください。

$paymentMethod->delete();

deletePaymentMethodメソッドは、Billableモデルから特定の支払い方法を削除します。

$user->deletePaymentMethod('pm_visa');

deletePaymentMethodsメソッドは、Billableなモデルのすべての支払い方法情報を削除します。

$user->deletePaymentMethods();

このメソッドはデフォルトで、cardタイプの支払い方法を削除します。別のタイプの支払い方法を削除するには、メソッドの引数にtypeを渡します。

$user->deletePaymentMethods('sepa_debit');

{note} ユーザーがアクティブなサブスクリプションを持っている場合、アプリケーションはユーザーがデフォルトの支払い方法を削除することを許してはいけません。

サブスクリプション

サブスクリプションは、顧客に定期的な支払いを設定する方法を提供します。Cashierが管理するStripeサブスクリプションは、複数価格のサブスクリプション、サブスクリプション数量、トライアルなどをサポートします。

サブスクリプションの作成

サブスクリプションを作成するには、最初にBillableなモデルのインスタンスを取得します。これは通常、App\Models\Userのインスタンスになります。モデルインスタンスを取得したら、newSubscriptionメソッドを使用してモデルのサブスクリプションを作成できます。

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支払い方法識別子またはStripePaymentMethodオブジェクトを引数に取るcreateメソッドは、サブスクリプションを開始するのと同時に、BillableなモデルのStripe顧客IDおよびその他の関連する課金情報でデータベースを更新します。

{note} 支払い方法識別子をcreateサブスクリプションメソッドへ直接渡すと、ユーザーの保存済み支払い方法にも自動的に追加されます。

インボイスメールによる定期支払いの収集

顧客の定期支払いを自動で収集する代わりに、定期支払いの期日ごとに請求書を顧客にメールで送信するように、Stripeへ指示できます。顧客は請求書を受け取った後に、手動で支払います。請求書を使い、定期の支払いを集める場合に、顧客は前もって支払い方法を指定する必要はありません。

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

サブスクリプションがキャンセルされたと判断するまでの顧客の支払い猶予期間は、Stripeダッシュボード内のサブスクリプションとインボイスの設定により決まります。

サブスクリプション数

サブスクリプションの作成時にの価格に数量を指定する場合は、サブスクリプションを作成する前にビルダでquantityメソッドを呼び出してください。

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

詳細の追加

Stripeがサポートしている顧客やサブスクリプションオプションを指定する場合、createメソッドの２番目と３番目の引数に指定することで、追加できます。

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

クーポン

サブスクリプションの作成時にクーポンを適用する場合は、withCouponメソッドを使用できます。

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

また、Stripeプロモーションコードを適用したい場合には、withPromotionCodeメソッドを使用してください。指定するプロモーションコードIDは、プロモーションコードに割り当てたStripe API IDであり、顧客向けのプロモーションコードではありません。

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

サブスクリプションの追加

すでにデフォルトの支払い方法を持っている顧客へサブスクリプションを追加する場合は、サブスクリプションビルダでaddメソッドを呼び出してください。

use App\Models\User;

$user = User::find(1);

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

Stripeダッシュボードからのサブスクリプション作成

Stripeダッシュボード自体からも、サブスクリプションを作成できます。その際、Cashierは新しく追加したサブスクリプションを同期し、それらにdefaultの名前を割り当てます。ダッシュボードから作成するサブスクリプションに割り当てるサブスクリプション名をカスタマイズするには、WebhookControllerを拡張し、newSubscriptionNameメソッドを上書きします。

また、Stripeダッシュボードから作成できるサブスクリプションのタイプは１つだけです。アプリケーションが異なる名前を使用する複数のサブスクリプションを提供している場合でも、Stripeダッシュボードから追加できるサブスクリプションのタイプは１つのみです。

最後に、アプリケーションが提供するサブスクリプションのタイプごとに、アクティブなサブスクリプションを１つだけ追加するようにしてください。顧客が２つのdefaultサブスクリプションを持っている場合、たとえ両方がアプリケーションのデータベースと同期されていても、最後に追加したサブスクリプションのみ、Cashierは使用します。

サブスクリプション状態のチェック

顧客がアプリケーションでサブスクリプションを購入すると、さまざまな便利なメソッドを使用して、サブスクリプションの状態を簡単に確認できます。まず、subscribedメソッドは、そのサブスクリプションが現在試用期間内であっても、顧客がアクティブなサブスクリプションを持っている場合は、trueを返します。subscribedメソッドは、最初の引数としてサブスクリプションの名前を受け入れます。

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

subscribedメソッドはルートミドルウェアの優れた候補にもなり、ユーザーのサブスクリプション状態に基づいてルートとコントローラへのアクセスをフィルタリングできます。

<?php

namespace App\Http\Middleware;

use Closure;

class EnsureUserIsSubscribed
{
    /**
     * 受信リクエストの処理
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        if ($request->user() && ! $request->user()->subscribed('default')) {
            // このユーザーは、支払い済みユーザーではない
            return redirect('billing');
        }

        return $next($request);
    }
}

ユーザーがまだ試用期間内であるかどうかを確認したい場合は、onTrialメソッドを使用します。このメソッドは、ユーザーがまだ試用期間中であるという警告をユーザーに表示する必要があるかどうかを判断するのに役立ちます。

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

subscribedToProductメソッドは、ユーザーが指定のStripe製品識別子に基づき、指定の製品を購読しているかどうかを判断するために使用します。Stripeでの商品とは、価格のコレクションです。この例では、ユーザーのdefaultサブスクリプションが、アプリケーションの「プレミアム」製品をアクティブに購読しているかを判定してみます。指定するStripe製品識別子は、Stripeダッシュボード内の製品識別子のいずれかに対応する必要があります。

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

subscribedToProductメソッドへ配列を渡し、ユーザーのdefaultサブスクリプションがアプリケーションの"basic"か"premium"製品をアクティブに購読しているかを判断してみます。

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

subscribedToPriceメソッドは、顧客のサブスクリプションが指定する価格IDに対応しているかを判断するために使用します。

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

recurringメソッドを使用して、ユーザーが現在サブスクリプションを購入しており、試用期間でないことを判定します。

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

{note} ユーザーが同じ名前のサブスクリプションを２つ持っている場合、subscriptionメソッドは最新のサブスクリプションを常に返します。たとえば、ユーザーがdefaultという名前のサブスクリプションレコードを２つ持っているとします。この場合、サブスクリプションの１つは古い期限切れのサブスクリプションであり、もう１つは現在のアクティブなサブスクリプションである可能性があります。最新のサブスクリプションを常に返しますが、古いサブスクリプションは履歴レビューのためにデータベースに保持されます。

サブスクリプションの取り消し

ユーザーがかつてアクティブなサブスクリプション購入者であったが、そのサブスクリプションをキャンセルしたかを判定するには、canceledメソッドを使用します。

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

また、ユーザーがサブスクリプションをキャンセルしたが、サブスクリプションが完全に期限切れになるまで「猶予期間」にあるかを判定することもできます。たとえば、ユーザーが３月１０日に期限切れになる予定のサブスクリプションを３月５日にキャンセルした場合、ユーザーは３月１０日まで「猶予期間」になります。この間、subscribedメソッドは引き続きtrueを返すことに注意してください。

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

ユーザーがサブスクリプションをキャンセルし、「猶予期間」も過ぎていることを判断するには、endedメソッドを使用します。

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

不完全および延滞ステータス

サブスクリプションの作成後に二次支払いアクションが必要な場合、サブスクリプションは「未完了（incomplete）」としてマークされます。サブスクリプションステータスは、Cashierのsubscriptionsデータベーステーブルのstripe_status列に保存されます。

同様に、価格を変更するときに二次支払いアクションが必要な場合、サブスクリプションは「延滞（past_due）」としてマークされます。サブスクリプションがこれらの状態のどちらかにある場合、顧客が支払いを確認するまでサブスクリプションはアクティブになりません。サブスクリプションの支払いが不完全であるかの判定は、BillableモデルまたはサブスクリプションインスタンスでhasIncompletePaymentメソッドを使用します。

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

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

サブスクリプションの支払いが不完全な場合は、latestPayment識別子を渡して、ユーザーをCashierの支払い確認ページに誘導する必要があります。サブスクリプションインスタンスで使用可能なlatestPaymentメソッドを使用して、この識別子を取得できます。

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

サブスクリプションがpast_due状態のときにアクティブであると見なしたい場合は、Cashierが提供するkeepPastDueSubscriptionsActiveメソッドを使用します。通常、このメソッドは、App\Providers\AppServiceProviderのregisterメソッドで呼び出す必要があります。

use Laravel\Cashier\Cashier;

/**
 * 全アプリケーションサービスの登録
 *
 * @return void
 */
public function register()
{
    Cashier::keepPastDueSubscriptionsActive();
}

{note} サブスクリプションがincomplete状態の場合、支払いが確認されるまで変更できません。したがって、サブスクリプションがincomplete状態の場合、swapメソッドとupdateQuantityメソッドは例外を投げます。

サブスクリプションのスコープ

ほとんどのサブスクリプション状態はクエリスコープとしても利用できるため、特定の状態にあるサブスクリプションはデータベースで簡単にクエリできます。

// すべてのアクティブなサブスクリプションを取得
$subscriptions = Subscription::query()->active()->get();

// ユーザーのキャンセルしたサブスクリプションをすべて取得
$subscriptions = $user->subscriptions()->canceled()->get();

使用可能なスコープの完全なリストは、以下のとおりです。

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価格の識別子に対応する必要があります。

use App\Models\User;

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

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

その顧客が試用中の場合、試用期間は維持されます。さらに、サブスクリプションに「数量」が存在する場合、その数量も維持されます。

価格を交換して、顧客が現在行っている試用期間をキャンセルしたい場合は、skipTrialメソッドを呼び出してください。

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

価格を交換して、次の請求サイクルを待たずにすぐに顧客に請求する場合は、swapAndInvoiceメソッドを使用します。

$user = User::find(1);

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

按分

デフォルトで、Stripeは価格を変更するときに料金を按分します。noProrateメソッドを使用すると、料金を按分せずにサブスクリプションの価格を更新できます。

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

サブスクリプションの按分について詳しくは、Stripeドキュメントを参照してください。

{note} swapAndInvoiceメソッドの前にnoProrateメソッドを実行しても、按分には影響しません。請求書は常に発行されます。

サブスクリプション数

サブスクリプションは「数量」の影響を受ける場合があります。たとえば、プロジェクト管理アプリケーションは、プロジェクトごとに月額$10を請求する場合があります。incrementQuantityメソッドとdecrementQuantityメソッドを使用して、サブスクリプション数量を簡単に増減できます。

use App\Models\User;

$user = User::find(1);

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

// サブスクリプションの現在の数量へ５個追加
$user->subscription('default')->incrementQuantity(5);

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

// サブスクリプションの現在の数量から５個減少
$user->subscription('default')->decrementQuantity(5);

または、updateQuantityメソッドを使用して特定の数量を設定することもできます。

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

noProrateメソッドを使用すると、料金を按分せずにサブスクリプションの数量を更新できます。

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

サブスクリプション数量の詳細については、Stripeドキュメントを参照してください。

複数価格でのサブスクリプション数

サブスクリプションが複数価格のサブスクリプションの場合は、増量または減量したい価格の名前をincrement／decrementメソッドの第２引数に渡す必要があります。

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

複数価格のサブスクリプション

複数価格のサブスクリプションでは、1つのサブスクリプションに複数の請求価格を割り当て可能です。例えば、カスタマーサービスの「ヘルプデスク」アプリケーションを構築しているとします。このアプリケーションの基本サブスクリプション価格は月額１０ドルですが、ライブチャットのアドオン価格は月額１５ドルに設定しましょう。複数価格のサブスクリプションの情報は、Cashierのsubscription_itemsデータベーステーブルに格納されます。

newSubscriptionメソッドの第２引数に価格の配列を渡すことで、指定したサブスクリプションに複数の価格を指定できます。

use Illuminate\Http\Request;

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

    // ...
});

上記の例では、顧客のdefaultサブスクリプションに２つの価格を設定しています。どちらの価格も、それぞれの請求間隔で請求されます。必要に応じて、quantityメソッドを使用して、各価格に特定の数量を指定できます。

$user = User::find(1);

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

既存のサブスクリプションに別の価格を追加したい場合は、サブスクリプションのaddPriceメソッドを呼び出します。

$user = User::find(1);

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

上記の例では、新しい価格が追加され、次の請求サイクルで顧客へ請求します。すぐに顧客へ請求したい場合は、addPriceAndInvoiceメソッドを使います。

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

数量を指定して価格を追加したい場合には、addPriceまたはaddPriceAndInvoiceメソッドの第２引数に数量を渡します。

$user = User::find(1);

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

サブスクリプションから価格を削除するには、removePriceメソッドを使用します。

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

{note} サブスクリプションの最後の価格は削除できません。代わりに、単にサブスクリプションをキャンセルしてください。

価格の交換

複数価格のサブスクリプションに設定した価格を変更することもできます。例えば、ある顧客がprice_basicのサブスクリプションにprice_chatのアドオン価格を設定していて、その顧客をprice_basicからprice_proにアップグレードしたいとします。

use App\Models\User;

$user = User::find(1);

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

上記の例を実行すると、price_basicのサブスクリプションアイテムが削除され、price_chatのサブスクリプションアイテムが保存されます。さらに、price_proのサブスクリプションアイテムが新たに作成されます。

また、キーと値のペアの配列をswapメソッドに渡すことで、サブスクリプションアイテムのオプションを指定することもできます。たとえば、サブスクリプション価格の数量を指定する必要があるかもしれません。

$user = User::find(1);

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

サブスクリプションの価格を１つだけ交換したい場合は、サブスクリプションアイテム自体のswapメソッドを使って交換できます。この方法は、サブスクリプションの他の価格に関する既存のメタデータをすべて保持したい場合に特に有効です。

$user = User::find(1);

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

按分

デフォルトで、Stripeは複数価格サブスクリプションに価格を追加または削除するとき、料金を按分します。按分せずに調整したい場合は、noProrateメソッドを価格の操作へチェーンする必要があります。

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

個数

個々のサブスクリプション価格の個数を変更する場合は、既存の個数メソッドを使用して、価格の名前をメソッドの追加引数として渡すことで更新できます。

$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');

{note} サブスクリプションに複数の価格がある場合、Subscriptionモデルのstripe_plan属性とquantity属性はnullになります。個々の価格属性にアクセスするには、Subscriptionモデルで使用可能なitemsリレーションを使用する必要があります。

サブスクリプションアイテム

サブスクリプションに複数の価格がある場合、データベースのsubscription_itemsテーブルに複数のサブスクリプション「アイテム」が保存されます。サブスクリプションのitemsリレーションを介してこれらにアクセスできます。

use App\Models\User;

$user = User::find(1);

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

// 特定のアイテムのStripe価格と個数を取得
$stripePrice = $subscriptionItem->stripe_price;
$quantity = $subscriptionItem->quantity;

findItemOrFailメソッドを使用して特定の価格を取得できます。

$user = User::find(1);

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

従量制課金

従量制課金を使用すると、課金サイクル中の製品の使用状況に基づき顧客へ請求できます。たとえば、顧客が１か月に送信するテキストメッセージまたは電子メールの数に基づいて顧客に請求するケースが考えられます。

従量制課金を使用開始するには、最初に、Stripeダッシュボードの従量制価格（metered price）で新しい製品を作成する必要があります。次に、meteredPriceを使用して、従量制の価格IDを顧客のサブスクリプションに追加します。

use Illuminate\Http\Request;

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

    // ...
});

Stripeの支払いから従量制サブスクリプションを開始することもできます。

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

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

資料状況の報告

顧客がアプリケーションを使用しているとき、正確な請求ができるように、使用状況をStripeへ報告します。従量制サブスクリプションの使用量を増やすには、reportUsageメソッドを使用します。

$user = User::find(1);

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

デフォルトでは、「使用量」１が請求期間に追加されます。または、指定の「使用量」を渡して、請求期間中の顧客の使用量に追加することもできます。

$user = User::find(1);

$user->subscription('default')->reportUsage(15);

アプリケーションが単一のサブスクリプションで複数の価格を提供している場合は、reportUsageForメソッドを使用して、使用状況を報告する従量制価格を指定する必要があります。

$user = User::find(1);

$user->subscription('default')->reportUsageFor('price_metered', 15);

以前に報告した使用状況を更新する必要も起こるでしょう。これにはタイムスタンプまたはDateTimeInterfaceインスタンスを２番目のパラメータとしてreportUsageに渡します。その際、Stripeはその時点で報告された使用状況を更新します。指定する日時は現在の請求期間内であるため、以前の使用記録を引き続き更新できます。

$user = User::find(1);

$user->subscription('default')->reportUsage(5, $timestamp);

使用記録の取得

顧客の過去の使用状況を取得するには、サブスクリプションインスタンスのusageRecordsメソッドを使用します。

$user = User::find(1);

$usageRecords = $user->subscription('default')->usageRecords();

アプリケーションが１つのサブスクリプションで複数の価格を提供している場合は、usageRecordsForメソッドを使用して、使用記録を取得する従量制価格を指定します。

$user = User::find(1);

$usageRecords = $user->subscription('default')->usageRecordsFor('price_metered');

usageRecordsメソッドとusageRecordsForメソッドは、使用レコードの連想配列を含むCollectionインスタンスを返します。この配列を繰り返し処理して、顧客の合計使用量を表示できます。

@foreach ($usageRecords as $usageRecord)
    - Period Starting: {{ $usageRecord['period']['start'] }}
    - Period Ending: {{ $usageRecord['period']['end'] }}
    - Total Usage: {{ $usageRecord['total_usage'] }}
@endforeach

返されるすべての使用状況データの完全なリファレンスと、Stripeのカーソルベースのペジネーションの使用方法については、Stripe公式のAPIドキュメントを参照してください。

サブスクリプションの税率

{note} 税率を手動で計算する代わりに、Stripe Taxを使って自動的に税金を計算できます。

ユーザーがサブスクリプションで支払う税率を指定するには、BillableなモデルにtaxRatesメソッドを実装し、Stripe税率IDを含む配列を返す必要があります。これらの税率は、Stripeダッシュボードで定義します。

/**
 * 顧客のサブスクリプションに適用する税率
 *
 * @return array
 */
public function taxRates()
{
    return ['txr_id'];
}

taxRatesメソッドを使用すると、顧客ごとに税率を適用できます。これは、ユーザーベースが複数の国と税率にまたがる場合に役立つでしょう。

複数価格サブスクリプションを提供している場合は、BillableなモデルにpriceTaxRatesメソッドを実装することで、プランごとに異なる税率を定義できます。

/**
 * 顧客のサブスクリプションに適用する税率
 *
 * @return array
 */
public function priceTaxRates()
{
    return [
        'price_monthly' => ['txr_id'],
    ];
}

{note} taxRatesメソッドはサブスクリプション料金にのみ適用されます。Cashierを使用して「１回限り」の料金を請求する場合は、その時点で税率を手動で指定する必要があります。

税率の同期

taxRatesメソッドから返すハードコードした税率IDを変更する場合、ユーザーの既存サブスクリプションの設定税率は同じままです。既存のサブスクリプションの税額を新しいtaxRates値で更新する場合は、ユーザーのサブスクリプションインスタンスでsyncTaxRatesメソッドを呼び出す必要があります。

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

これにより、複数価格のサブスクリプションアイテムの税率も同期されます。複数価格のサブスクリプションを提供している場合は、Billableモデルが前述のpriceTaxRatesメソッドを実装していることを確認する必要があります。

非課税

Cashierは、顧客が非課税であるかどうかを判断するために、isNotTaxExempt、isTaxExempt、reverseChargeAppliesメソッドも提供しています。これらのメソッドは、StripeAPIを呼び出して、顧客の免税ステータスを判定します。

use App\Models\User;

$user = User::find(1);

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

{note} これらのメソッドは、すべてのLaravel\Cashier\Invoiceオブジェクトでも使用できます。ただし、Invoiceオブジェクトで呼び出されると、メソッドは請求書が作成されたときの免除ステータスを用います。

サブスクリプション基準日

デフォルトの請求サイクル基準日は、サブスクリプションが作成された日付、または試用期間が使用されている場合は試用が終了した日付です。請求基準日を変更する場合は、anchorBillingCycleOnメソッドを使用します。

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メソッドを呼び出します。

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

サブスクリプションがキャンセルされると、Cashierは自動的にsubscriptionsデータベーステーブルのends_atカラムを設定します。このカラムは、subscribedメソッドがfalseを返し始めるタイミングを決めるため使用されます。

たとえば、顧客が３月１日にサブスクリプションをキャンセルしたが、そのサブスクリプションが３月５日までに終了するようスケジュールされていなかった場合、subscribedメソッドは３月５日までtrueを返し続けます。この振る舞いを行うのは、ユーザーは請求サイクルが終了するまでアプリケーションの使用を通常継続できるためです。

onGracePeriodメソッドを使用して、ユーザーがサブスクリプションをキャンセルしたが、まだ「猶予期間」にあるかどうかを判断できます。

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

サブスクリプションをすぐにキャンセルする場合は、ユーザーのサブスクリプションでcancelNowメソッドを呼び出します。

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

サブスクリプションをすぐにキャンセルし、従量制による使用量の未請求部分や、新規/保留中の請求項目を請求する場合は、ユーザーのサブスクリプションに対しcancelNowAndInvoiceメソッドを呼び出します。

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

特定の時間に購読をキャンセルすることもできます。

$user->subscription('default')->cancelAt(
    now()->addDays(10)
);

サブスクリプションの再開

顧客がサブスクリプションをキャンセルし、それを再開する場合は、サブスクリプションに対しresumeメソッドを呼び出します。サブスクリプションを再開するには、顧客は「猶予期間」内である必要があります。

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

顧客がサブスクリプションをキャンセルし、サブスクリプションが完全に期限切れになる前にそのサブスクリプションを再開する場合、請求はすぐに顧客へ課せられれません。代わりに、サブスクリプションを再アクティブ化し、元の請求サイクルで請求します。

サブスクリプションの試用期間

支払い方法の事前登録

事前に支払い方法情報を収集し、顧客に試用期間を提供したい場合は、サブスクリプションの作成時にtrialDaysメソッドを使用します。

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の価格に設定しているデフォルトの試用期間を上書きします。

{note} 試用期間の終了日より前に顧客のサブスクリプションがキャンセルされなかった場合、試用期間の終了時にすぐ課金されるため、試用期間の終了日をユーザーに必ず通知する必要があります。

trialUntilメソッドを使用すると、試用期間をいつ終了するかを指定するDateTimeインスタンスを渡せます。

use Carbon\Carbon;

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

ユーザーインスタンスのonTrialメソッドまたはサブスクリプションインスタンスのonTrialメソッドのいずれかを使用して、ユーザーが試用期間内にあるかどうか判定できます。以下の２例は同じ働きです。

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

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

endTrialメソッドを使用して、サブスクリプションの試用期間を即時終了できます。

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

ストライプ／Cashierでの試用期間日数の定義

価格が受け取るトライアル日数をStripeダッシュボードで定義するか、常にCashierを使用して明示的に渡すかを選択できます。Stripeで価格の試用日数を定義することを選択した場合、過去にそのサブスクリプションを購読していた顧客の新しいサブスクリプションを含む、新しいサブスクリプションは全部、明示的にskipTrial()メソッドを呼び出さない限り、常に試用期間が提供されることに注意してください。

支払い方法事前登録なし

ユーザーの支払い方法情報を事前に収集せずに試用期間を提供したい場合は、ユーザーレコードのtrial_ends_at列を希望の試用終了日に設定してください。これは通常、ユーザー登録時に行います。

use App\Models\User;

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

{note} Billableなモデルのクラス定義内のtrial_ends_at属性にdatecastを必ず追加してください。

Cashierはこのタイプの試用期間を「一般的な試用期間（generic trial）」と呼んでいます。これは、既存のサブスクリプションに関連付けられていないからです。BillableなモデルインスタンスのonTrialメソッドは、現在の日付がtrial_ends_atの値を超えていない場合にtrueを返します。

if ($user->onTrial()) {
    // ユーザーは試用期間内
}

ユーザーの実際のサブスクリプションを作成する準備ができたら、通常どおりnewSubscriptionメソッドを使用できます。

$user = User::find(1);

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

ユーザーの試用終了日を取得するには、trialEndsAtメソッドを使用します。このメソッドは、ユーザーが試用中の場合はCarbon日付インスタンスを返し、そうでない場合はnullを返します。デフォルト以外の特定のサブスクリプションの試用終了日を取得する場合は、オプションのサブスクリプション名パラメーターを渡すこともできます。

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

ユーザーが「一般的な」試用期間内であり、実際のサブスクリプションをまだ作成していないことを具体的に知りたい場合は、onGenericTrialメソッドを使用することもできます。

if ($user->onGenericTrial()) {
    // ユーザーは「一般的な」試用期間内
}

試用期間の延長

extendTrialメソッドを使用すると、サブスクリプションの作成後にサブスクリプションの試用期間を延長できます。試用期間がすでに終了していて、顧客にサブスクリプションの料金が既に請求されている場合でも、延長試用期間を提供できます。試用期間内に費やされた時間は、その顧客の次の請求から差し引かれます。

use App\Models\User;

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

// 今から７日後に試用期間終了
$subscription->extendTrial(
    now()->addDays(7)
);

// 試用期間をさらに５日追加
$subscription->extendTrial(
    $subscription->trial_ends_at->addDays(5)
);

StripeのWebフックの処理

{tip} Stripe CLIを使用して、ローカル開発中にWebhookをテストすることができます。

Stripeは、Webフックを介してさまざまなイベントをアプリケーションに通知できます。デフォルトでは、CashierのWebフックコントローラを指すルートは、Cashierサービスプロバイダにより自動的に登録されます。このコントローラは、すべての受信Webフックリクエストを処理します。

デフォルトでは、Cashier Webフックコントローラは、（Stripe設定で定義する）課金失敗が多すぎるサブスクリプションのキャンセル、顧客の更新、顧客の削除、サブスクリプションの更新、および支払い方法の変更を自動的に処理します。ただし、すぐにわかりますが、このコントローラを拡張して、任意のStripe Webフックイベントを処理できます。

アプリケーションがStripe Webフックを処理できるようにするには、StripeコントロールパネルでWebフックURLを設定してください。デフォルトでは、CashierのWebフックコントローラは/stripe/webhookURLパスに応答します。Stripeコントロールパネルで有効にする必要があるすべてのWebフックの完全なリストは次のとおりです。

customer.subscription.created
customer.subscription.updated
customer.subscription.deleted
customer.updated
customer.deleted
invoice.payment_action_required

Cashierは、cashier:webhook Artisanコマンドを利便性のために用意しています。このコマンドはCashierが必要とするすべてのイベントをリッスンする、StripeのWebフックを作成します。

php artisan cashier:webhook

作成されたWebhookはデフォルトで、環境変数APP_URLとCashierに含まれるcashier.webhookルートで定義したURLを示します。別のURLを使用したい場合は、このコマンドを実行するとき、--urlオプションで指定できます。

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

作成されるWebフックは、使用するCashierバージョンが対応しているStripe APIバージョンを使用します。異なるStripeのバージョンを使用したい場合は、--api-versionオプションを指定してください。

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

作成後、Webフックはすぐに有効になります。Webフックを作成するが、準備が整うまで無効にしておく場合は、コマンド実行時に、--disabledオプションを指定します。

php artisan cashier:webhook --disabled

{note} Cashierに含まれるWebフック署名の確認ミドルウェアを使って、受信するStripe Webフックリクエストを保護してください。。

WebフックとCSRF保護

Stripe WebフックはLaravelのCSRF保護をバイパスする必要があるため、アプリケーションのApp\Http\Middleware\VerifyCsrfTokenミドルウェアに例外としてURIをリストするか、webミドルウェアグループの外にルートをリストしてください。

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

Webフックイベントハンドラの定義

Cashierは課金の失敗やその他一般的なStripe Webフックイベントによる、サブスクリプションキャンセルを自動的に処理します。ただし、追加でWebフックイベントを処理したい場合は、Cashierが発行する以下のイベントをリッスンすることで可能です。

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

両イベントも、Stripe Webフックの完全なペイロードが含んでいます。例えば、invoice.payment_succeededというWebフックを扱いたい場合は、そのイベントを処理するリスナを登録します。

<?php

namespace App\Listeners;

use Laravel\Cashier\Events\WebhookReceived;

class StripeEventListener
{
    /**
     * 受信したStripeのWebフックを処理
     *
     * @param  \Laravel\Cashier\Events\WebhookReceived  $event
     * @return void
     */
    public function handle(WebhookReceived $event)
    {
        if ($event->payload['type'] === 'invoice.payment_succeeded') {
            // 受信イベントの処理…
        }
    }
}

リスナを定義したら、アプリケーションのEventServiceProviderで登録します。

<?php

namespace App\Providers;

use App\Listeners\StripeEventListener;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Laravel\Cashier\Events\WebhookReceived;

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

Webフック署名の確認

Webフックを保護するために、StripeのWebフック署名を使用できます。便利なように、Cashierには受信Stripe Webフックリクエストが有効であるかを検証するミドルウェアが自動的に含まれています。

Webフックの検証を有効にするには、STRIPE_WEBHOOK_SECRET環境変数がアプリケーションの.envファイルに設定されていることを確認してください。Webフックのsecretは、Stripeアカウントダッシュボードから取得できます。

一回限りの支払い

シンプルな支払い

{note} chargeメソッドは、アプリケーションで使用する通貨の最小単位で請求する金額を受け入れます。たとえば、米ドルを使用する場合、金額はペニーで指定する必要があります。

顧客に対して1回限りの請求を行う場合は、Billableなモデルインスタンスでchargeメソッドを使用します。chargeメソッドの２番目の引数として支払い方法識別子を指定する必要があります。

use Illuminate\Http\Request;

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

    // ...
});

chargeメソッドは３番目の引数を取り、ベースにあるStripeの課金作成へのオプションを指定できます。課金作成時に利用できるオプションの詳細は、Stripeドキュメントを参照してください。

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

また、基礎となる顧客やユーザーなしにchargeメソッドを使用することもできます。そのためには、アプリケーションのBillableなモデルの新しいインスタンスでchargeメソッドを呼び出します。

use App\Models\User;

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

課金失敗の場合、chargeメソッドは例外を投げます。課金が成功すると、メソッドはLaravel\Cashier\Paymentのインスタンスを返します。

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

インボイス付きの支払い

時には、一回限りの請求を行い、顧客にPDFのインボイスを提供する必要があるでしょう。invoicePriceメソッドを使えば、それが可能です。例えば、新しいシャツを5枚購入した顧客へ請求書を発行してみましょう。

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

インボイスは、ユーザーのデフォルトの支払い方法に対し即時請求されます。invoicePriceメソッドは３番目の引数として配列も受け入れます。この配列には、インボイスアイテムの請求オプションを指定します。メソッドの４番目の引数も配列で、インボイス自体の請求オプションを指定します。

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

もしくは、invoiceForメソッドを使って、顧客のデフォルトの支払い方法に対して「一回限り」の請求を行うこともできます。

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

invoiceForメソッドを利用することもできますが、あらかじめ価格を設定したinvoicePriceメソッドを利用することを推奨します。そうすることにより、Stripeダッシュボード内で、商品ごとの売上に関するより良い分析とデータへアクセスできるようになります。

{note} invoicePriceとinvoiceForメソッドは、失敗した請求を再試行するStripeのインボイスを作成します。請求に失敗したインボイスを再試行したくない場合は、最初の請求に失敗した後で、Stripe APIを使いインボイスを閉じる必要があります。

支払いの払い戻し

Stripeの料金を払い戻す必要がある場合は、refundメソッドを使用します。このメソッドは、最初の引数にStripe支払いインテントIDを取ります。

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

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

インボイス

インボイスの取得

invoicesメソッドを使用して、Billableなモデルのインボイスの配列を簡単に取得できます。invoicesメソッドはLaravel\Cashier\Invoiceインスタンスのコレクションを返します。

$invoices = $user->invoices();

結果に保留中のインボイスを含めたい場合は、invoicesInclusivePendingメソッドを使用します。

$invoices = $user->invoicesIncludingPending();

findInvoiceメソッドを使用して、IDで特定のインボイスを取得できます。

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

インボイス情報の表示

ある顧客のインボイスを一覧表示する場合、インボイスのメソッドを使用し関連するインボイス情報を表示すると思います。たとえば、テーブル中の全インボイスをリストする場合、ユーザーがどれでも簡単にダウンロードできるようにしたいことでしょう。

<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メソッドを使います。

$invoice = $user->upcomingInvoice();

同様に、顧客が複数のサブスクリプションを持っている場合、指定するサブスクリプションの次期インボイスを取得することもできます。

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

サブスクリプションインボイスのプレビュー

previewInvoiceメソッドを使うと、価格変更をする前にインボイスをプレビューできます。これにより、特定の価格変更を行う場合、顧客のインボイスがどのようなものになるか確認できます。

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

新しい複数価格のインボイスをプレビューするには、価格の配列をpreviewInvoiceメソッドへ渡します。

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

インボイスＰＤＦの生成

ルートまたはコントローラ内から、downloadInvoiceメソッドを使用して、特定のインボイスのＰＤＦダウンロードを生成できます。このメソッドは、インボイスのダウンロードに必要なHTTP応答を適切かつ自動的に生成します。

use Illuminate\Http\Request;

Route::get('/user/invoice/{invoice}', function (Request $request, $invoiceId) {
    return $request->user()->downloadInvoice($invoiceId, [
        'vendor' => 'Your Company',
        'product' => 'Your Product',
    ]);
});

インボイスのすべてのデータはデフォルトで、Stripeに保存されている顧客と請求書のデータから作成します。しかし、downloadInvoiceメソッドの第２引数に配列を指定することで、データの一部をカスタマイズ可能です。この配列で、会社や製品の詳細などの情報がカスタマイズできます。

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' => 'info@example.com',
    'url' => 'https://example.com',
    'vendorVat' => 'BE123456789',
], 'my-invoice');

downloadInvoiceメソッドの第３引数でカスタムファイル名の指定もできます。このファイル名には自動的に.pdfというサフィックスが付きます。

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

カスタム・インボイス・レンダラ

また、Cashierはカスタムインボイスレンダラを使用可能です。デフォルトでCashierは、dompdf PHPライブラリを利用し請求書を生成する、DompdfInvoiceRendererの実装を使用します。しかし、Laravel\Cashier\Contracts\InvoiceRendererインターフェイスを実装することにより、任意のレンダラを使用できます。例えば、サードパーティのPDFレンダリングサービスへのAPIコールを使用し、請求書PDFをレンダリングするとしましょう。

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

class ApiInvoiceRenderer implements InvoiceRenderer
{
    /**
     * 与えられた請求書をレンダリングし、素のPDFバイトを返す
     *
     * @param  \Laravel\Cashier\Invoice. $invoice
     * @param  array  $data
     * @param  array  $options
     * @return string
     */
    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は、チェックアウトページを事前に構築しホストするという、支払いを受け入れるためカスタムページを実装する手間を省きます。

以下のドキュメントで、Stripe Checkoutをどのように利用開始するのかに関する情報を説明します。Stripe Checkoutの詳細は、StrepeのCheckoutに関するドキュメントを確認する必要があるでしょう

商品の支払い

Billableなモデル上のcheckoutメソッドを使用して、Stripeダッシュボード内に作成した既存の製品のチェックアウトを実行できます。checkoutメソッドは新しいStripeチェックアウトセッションを開始します。デフォルトで、Stripe価格IDを渡す必要があります。

use Illuminate\Http\Request;

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

必要に応じて、製品数量を指定することもできます。

use Illuminate\Http\Request;

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

顧客がこのルートを訪れると、Stripeのチェックアウトページにリダイレクトされます。デフォルトでは、ユーザーが購入を正常に完了した場合、または購入をキャンセルすると、Homeルートへリダイレクトされますが、success_urlとcancel_urlオプションを使い、カスタムコールバックURLを指定できます。

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チェックアウトオプションを定義する際に、URLを呼び出す際にチェックアウトセッションIDをクエリ文字列のパラメータとして追加するようStripeに指示することができます。それには、リテラル文字列 {CHECKOUT_SESSION_ID} を success_url のクエリ文字列に追加します。Stripeはこのプレースホルダーを実際のチェックアウトセッションIDに置き換えます。

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はデフォルトで、ユーザーが商品に使用できるプロモーションコードを許可していません。幸いわいに、チェックアウトページでこれを有効にする簡単な方法があります。そのためには、allowPromotionCodesメソッドを呼び出します。

use Illuminate\Http\Request;

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

一回限りの支払い

ストライプダッシュボードに作成していない、アドホックな商品をシンプルに課金することもできます。これには、BillableなモデルでcheckoutChargeメソッドを使用し、課金可能な料金、製品名、およびオプションの数量を渡たします。顧客がこのルートを訪れると、Stripeのチェックアウトページへリダイレクトされます。

use Illuminate\Http\Request;

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

{note}checkoutChargeメソッドを使用する場合、Stripeは常にStripeダッシュボードに新しい製品と価格を作成します。したがって、代わりにStripeダッシュボードで事前に商品を作成し、checkoutメソッドを使用することを推奨します。

サブスクリプションの支払い

{note} Stripe Checkoutのサブスクリプションを使用するには、Stripeダッシュボードでcustomer.subscription.created Webフックを有効にする必要があります。このWebフックは、データベースにサブスクリプションレコードを作成し、すべてのサブスクリプション関連アイテムを保存します。

サブスクリプションを開始するには、Stripe Checkoutを使用することもできます。Cashierのサブスクリプションビルダメソッドを使用してサブスクリプションを定義した後に、checkoutメソッドを呼び出せます。顧客がこのルートを訪れると、Stripeのチェックアウトページへリダイレクトされます。

use Illuminate\Http\Request;

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

製品のチェックアウトと同様に、成功およびキャンセルのURLをカスタマイズできます。

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'),
        ]);
});

もちろん、サブスクリプションチェックアウトのプロモーションコードを有効にすることもできます。

use Illuminate\Http\Request;

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

{note} 残念ながらStripe Checkoutはサブスクリプションを開始するとき、すべてのサブスクリプション請求オプションをサポートしていません。サブスクリプションビルダのanchorBillingCycleOnメソッドを使用して、プロレーション動作の設定、または支払い動作の設定は、Stripeチェックアウトセッション中に全く効果はありません。どのパラメータが利用可能であるかを確認するには、Stripe CheckoutセッションAPIのドキュメントを参照してください。

Stripeの支払と試用期間

もちろん、Stripe Checkoutを使用して購読を作成する際、試用期間の完了時間を定義できます。

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

ただし、試用期間は最低４８時間でなければならず、これはStripe Checkoutでサポートされている試行時間の最短時間です。

サブスクリプションとWebフック

StripeとCashierはWebフックを使いサブスクリプションの状態を更新することを覚えておいてください。そのため、顧客が支払い情報を入力した後でアプリケーションに戻った時点で、サブスクリプションが有効になっていない可能性があります。このシナリオを処理するには、ユーザーに支払いやサブスクリプションが保留中であることをユーザーに知らせるメッセージを表示することを推奨します。

課税IDの収集

Checkoutは、顧客の課税IDの収集もサポートしています。チェックアウトセッションでこれを有効にするには、セッションを作成するときにcollectTaxIdsメソッドを呼び出します。

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

このメソッドを呼び出すと、顧客が会社として購入するかを示すための新しいチェックボックスが利用可能になります。会社として購入する場合は、課税IDを入力してもらいます。

{note} アプリケーションのサービスプロバイダで自動徴税を設定済みであれば、この機能は自動的に有効になり、collectTaxIdsメソッドを呼び出す必要はありません。

支払い失敗の処理

サブスクリプションまたは１回限りの支払いが失敗する場合もあります。これが起きると、Cashierはこの発生を通知するLaravel\Cashier\Exceptions\IncompletePayment例外を投げます。この例外をキャッチした後に続行する方法は、２つの選択肢があります。

１つ目はCashierが用意している専用の支払い確認ページに顧客をリダイレクトすることです。このページは、Cashierのサービスプロバイダを介して登録済みの名前付きルートがすでに割り振られています。したがって、IncompletePayment例外をキャッチして、ユーザーを支払い確認ページにリダイレクトできます。

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

支払い確認ページで、顧客はクレジットカード情報を再度入力し、「3Dセキュア」確認などのStripeに必要な追加のアクションを実行するように求められます。支払いを確認すると、ユーザーは上記のredirectパラメータで指定したURLへリダイレクトされます。リダイレクト時に、message(文字列)およびsuccess(整数)クエリ文字列変数をURLへ追加します。支払い確認ページでは現在、以下の決済方法に対応しています。

Credit Cards
Alipay
Bancontact
BECS Direct Debit
EPS
Giropay
iDEAL
SEPA Direct Debit

もう一つの方法として、Stripeに支払い確認の処理を任せることもできます。この場合、支払い確認ページにリダイレクトする代わりに、StripeダッシュボードでStripeの自動請求メールを設定してください。ただし、IncompletePayment例外がキャッチされた場合でも、支払い確認の手順を記載したメールがユーザーへ届くよう、通知する必要があります。

Billableトレイトを使用するモデルのcharge、invoiceFor、invoiceメソッドでは、支払いの例外が投げられる場合があります。サブスクリプションを操作する場合では、SubscriptionBuilderのcreateメソッド、およびSubscriptionとSubscriptionItemモデルのincrementAndInvoiceメソッドとswapAndInvoiceメソッドは、不完全な支払い例外を投げる可能性があります。

既存のサブスクリプションの支払いが不完全であるかどうかの判断は、BillableモデルまたはサブスクリプションインスタンスでhasIncompletePaymentメソッドを使用して行えます。

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

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

例外インスタンスのpaymentプロパティを調べると、不完全な支払いの具体的なステータスを調べられます。

use Laravel\Cashier\Exceptions\IncompletePayment;

try {
    $user->charge(1000, 'pm_card_threeDSecure2Required');
} catch (IncompletePayment $exception) {
    // 支払いインテント状態の取得
    $exception->payment->status;

    // 特定の条件の確認
    if ($exception->payment->requiresPaymentMethod()) {
        // ...
    } elseif ($exception->payment->requiresConfirmation()) {
        // ...
    }
}

強力な顧客認証（ＳＣＡ）

あなたのビジネスがヨーロッパに拠点を置いているか、顧客がヨーロッパにいる場合は、ＥＵの強力な顧客認証（ＳＣＡ）法令を遵守する必要があります。これらの法令は、支払い詐欺を防ぐために２０１９年９月に欧州連合によって課されました。幸いにして、StripeとCashierは、ＳＣＡ準拠のアプリケーションを構築する準備ができています。

{note} 使用開始前に、PSD2とSCAに関するStripeのガイドと新しいSCA APIに関するドキュメントを確認してください。

追加の確認が必要な支払い

ＳＣＡ法令では支払いを確認し処理するため、追加の検証が頻繁に必要になります。これが起きると、Cashierは追加の検証が必要であることを通知するLaravel\Cashier\Exceptions\IncompletePayment例外を投げます。こうした例外の処理方法の詳細は、失敗した支払いの処理のドキュメントを参照してください。

StripeとCashierが提供する支払い確認画面は、特定の銀行またはカード発行者の支払いフローに合わせて調整することができ、追加のカード確認、一時的な少額の支払い、個別のデバイス認証、その他の形式の検証を含むことができます。

不完了と期限超過の状態

支払いに追加の確認が必要な場合、サブスクリプションはstripe_statusデータベースカラムが示すように、incompleteかpast_due状態のままになります。Cashierは支払いの確認が完了し、アプリケーションがWebフックを介してStripeから完了の通知を受けるととすぐに、顧客のサブスクリプションを自動的にアクティブ化します。

incompleteおよびpast_due状態の詳細については、これらの状態に関する追加のドキュメントを参照してください。

オフセッション支払い通知

ＳＣＡの法令では、サブスクリプションがアクティブな場合でも、顧客は支払いの詳細を時々確認する必要があるため、Cashierはオフセッションでの支払い確認が必要なときに顧客に通知を送信できます。たとえばこれは、サブスクリプションの更新時に発生する可能性があります。Cashierの支払い通知は、CASHIER_PAYMENT_NOTIFICATION環境変数を通知クラスに設定することで有効にできます。デフォルトでは、この通知は無効になっています。もちろん、Cashierにはこの目的で使用できる通知クラスが含まれていますが、必要に応じて独自の通知クラスを自由に提供できます。

CASHIER_PAYMENT_NOTIFICATION=Laravel\Cashier\Notifications\ConfirmPayment

オフセッションでの支払い確認通知が確実に配信されるようにするため、アプリケーションでStripe Webフックが設定されていることと、Stripeダッシュボードでinvoice.payment_action_requiredwebhookが有効になっていることを確認してください。さらに、BillableモデルでLaravelのIlluminate\Notifications\Notifiableトレイトを使用していることも確認する必要があります。

{note} 顧客が追加の確認を必要とする支払いを手動で行う場合でも、通知は送信されます。残念ながら、支払いが手動なのか「オフセッション」で行われたかをStripeが知る方法はありません。ただし、顧客が支払いを確認した後に支払いページへアクセスすると、「支払いが成功しました（Payment Successful）」というメッセージが表示されます。謝って顧客へ同じ支払いを２回確認させ、２回目の請求を行粉なってしまうことはありません。

Stripe SDK

Cashierのオブジェクトの多くは、StripeSDKオブジェクトのラッパーです。Stripeオブジェクトを直接操作したい場合は、asStripeメソッドを使用してオブジェクトを簡単に取得できます。

$stripeSubscription = $subscription->asStripeSubscription();

$stripeSubscription->application_fee_percent = 5;

$stripeSubscription->save();

updateStripeSubscriptionメソッドを使用して、Stripeサブスクリプションを直接更新することもできます。

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

Stripe\StripeClientのクライアントを直接使用したい場合は、Cashierクラスのstripeメソッドを呼び出せます。例えば、このメソッドを使ってStripeClientのインスタンスにアクセスし、Stripeアカウントから価格のリストを取得できます。

use Laravel\Cashier\Cashier;

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

テスト

Cashierを使用するアプリケーションをテストする場合、Stripe APIへの実際のHTTPリクエストをモックすることができます。ただし、これには、Cashier自身の動作を部分的に再実装する必要があります。したがって、テストが実際のStripe APIにヒットすることを許可することをおすすめします。これは遅いですが、アプリケーションが期待どおりに機能しているという確信が高まり、遅いテストは独自のPHPUnitテストグループ内に配置するのが良いでしょう。

テストするときは、Cashier自体には優れたテストスイートを既に持っていることを忘れないでください。したがって、基本的なCashierの動作すべてではなく、独自のアプリケーションのサブスクリプションと支払いフローのテストにのみ焦点を当てる必要があります。

テスト開始するには、Stripeシークレットのテストバージョンをphpunit.xmlファイルに追加します。

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

これで、テスト中にCashierとやり取りするたびに、実際のAPIリクエストがStripeテスト環境に送信されます。便宜上、Stripeテストアカウントに、テスト中に使用できるサブスクリプション/価格を事前に入力する必要があります。

{tip} クレジットカードの拒否や失敗など、さまざまな請求シナリオをテストするため、Stripeが提供しているさまざまなカード番号とトークンのテストを使用できます。

Laravel 8.x Laravel Cashier (Stripe)

イントロダクション

Cashierのアップデート

インストール

データベースマイグレーション

設定

Billableモデル

ＡＰＩキー

通貨設定

税設定

ログ

カスタムモデルの使用

顧客

顧客の取得

顧客の作成

顧客の更新

Balances

タックスID

顧客データをStripeと同期する

請求ポータル

支払い方法

支払い方法の保存

サブスクリプションの支払い方法

一回限りの支払いの支払い方法

支払い方法の取得

顧客に支払い方法があるか判定

デフォルト支払い方法の変更

支払い方法の追加

支払い方法の削除

サブスクリプション

サブスクリプションの作成

インボイスメールによる定期支払いの収集

サブスクリプション数

詳細の追加

クーポン

サブスクリプションの追加

Stripeダッシュボードからのサブスクリプション作成

サブスクリプション状態のチェック

サブスクリプションの取り消し

不完全および延滞ステータス

サブスクリプションのスコープ

価格の変更

按分

サブスクリプション数

複数価格でのサブスクリプション数

複数価格のサブスクリプション

価格の交換

按分

個数

サブスクリプションアイテム

従量制課金

資料状況の報告

使用記録の取得

サブスクリプションの税率

税率の同期

非課税

サブスクリプション基準日

サブスクリプションの取り消し

サブスクリプションの再開

サブスクリプションの試用期間

支払い方法の事前登録

ストライプ／Cashierでの試用期間日数の定義

支払い方法事前登録なし

試用期間の延長

StripeのWebフックの処理

WebフックとCSRF保護

Webフックイベントハンドラの定義

Webフック署名の確認

一回限りの支払い

シンプルな支払い

インボイス付きの支払い

支払いの払い戻し

インボイス

インボイスの取得

インボイス情報の表示

将来のインボイス

サブスクリプションインボイスのプレビュー

インボイスＰＤＦの生成

カスタム・インボイス・レンダラ

チェックアウト