updateQuantity メソッドを使用して、特定の数量を設定します:

$user = User::find(1);
$user->subscription('main')->incrementQuantity();
// 对当前的订阅量加5...
$user->subscription('main')->incrementQuantity(5);
$user->subscription('main')->decrementQuantity();
// 对当前的订阅量减5...
$user->subscription('main')->decrementQuantity(5);

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

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

Stripe のドキュメントを参照してください。

請求モード

メソッドを実装し、サブスクリプションでユーザーが支払う税率パーセンテージを指定するために使用される、小数点以下 2 桁以下の 0 ～ 100 の数値を返します。

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

メソッドを使用すると、モデル ベースで税率を適用できます。これは、複数の国と税率にまたがるユーザー ベースに役立つ場合があります。

taxPercentage

メソッドは、有料サブスクリプション モデルにのみ適用されます。チャージを使用して「1 回限り」のチャージを行う場合は、同時に税率を手動で指定する必要があります。

税率の同期

taxPercentage メソッドによって返されるハードコードされた値を変更する場合、ユーザーの既存のサブスクリプションの税率設定は変更されません。返された taxPercentage 値を使用して既存のサブスクリプションの税率を更新する場合は、ユーザーのサブスクリプション インスタンスで syncTaxPercentage メソッドを呼び出す必要があります:

public function taxPercentage() {
    return 20;
   }

サブスクリプション アンカー日

{注} サブスクリプション アンカー日の変更をサポートしているのは、Stripe in Cashier のみです。

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

$user->subscription('main')->syncTaxPercentage();

サブスクリプション請求サイクルの管理の詳細については、Stripe 請求サイクルのドキュメント##を参照してください。

cancel メソッドを呼び出して、 subscription:

use App\User;use Carbon\Carbon;
$user = User::find(1);
$anchor = Carbon::parse('first day of next month');
$user->newSubscription('main', 'premium')      
      ->anchorBillingCycleOn($anchor->startOfDay())            
      ->create($stripeToken);

ends_at 列を自動的に設定します。この列は、subscribed フィールドがいつ false を返し始めるかを知るためによく使用されます。たとえば、顧客が 3 月 1 日にサブスクリプションをキャンセルしたが、サブスクリプション プランが 3 月 5 日まで終了しない場合、subscribed メソッドは 3 月 5 日まで true を返し続けます。

onGracePeriod メソッドを使用して、ユーザーが確実に購読しているかどうかを判断できますが、まだ「猶予期間」が残っています:

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

cancelNow メソッドを呼び出してサブスクリプションをキャンセルしてください:

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

resume メソッドを使用できます。ユーザー は、サブスクリプションを再開する前に、猶予期間内である必要があります:

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

クレジット カードによるサブスクリプション

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

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

このメソッドは、データベース サブスクリプション レコードにサブスクリプション期間の終了時刻を設定して、それ以前にユーザーの請求情報を計算しないように Sripe/Braintree に指示します。

{注}顧客が試用期間が終了する前にキャンセルしない場合、サブスクリプションは自動的に請求されるため、ユーザーに試用期間の終了を必ず通知する必要があります。

trialUntil メソッドでは、DateTime インスタンスを提供することで試用期間の終了期間を指定できます。

$user = User::find(1);$user->newSubscription('main', 'monthly')    
        ->trialDays(10)            
        ->create($stripeToken);

onTrial を使用できます。ユーザー インスタンスの ## メソッドまたはサブスクリプション インスタンスの onTrial メソッドによって、ユーザーが試用期間中かどうかが決まります。次の 2 つの例は同等です:

use Carbon\Carbon;$user->newSubscription('main', 'monthly')        
    ->trialUntil(Carbon::now()->addDays(10))            
    ->create($stripeToken);

trial_ends_at 列を希望の試用終了日に設定するだけです。これは通常、ユーザー登録時に行われます:

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

{注 }

trial_ends_at 日付修飾子をモデル定義に追加していることを確認してください。

trail_ends_at 値を超えていない場合、User インスタンスの onTrial メソッドは true:

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

メソッドを使用できます。ユーザーの実際のサブスクリプションを作成します。サブスクライブするには、通常、newSubsription メソッドを使用します:

if ($user->onTrial()) { 
   // 用户在他们的试用期内...
  }

##Customer

顧客の作成

if ($user->onGenericTrial()) {
    // 用户在他们「一般」试用期...
   }

{ヒント} Braintree で顧客を作成するには、

メソッドを使用します。 ＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃バンクカード＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃

請求可能モデル インスタンスの cards メソッドは、

Laravel\Cashier\Card

$user = User::find(1);
$user->newSubscription('main', 'monthly')->create($stripeToken);

$user->createAsStripeCustomer();

カード番号がファイルに記録されていることを確認してください

hasCardOnFile メソッドを使用して、顧客が自分のアカウントにクレジット カードを保存しているかどうかを確認できます:

$cards = $user->cards();

UpdateCard

updateCard メソッドを使用して、ユーザーのクレジット カード情報を更新できます。このメソッドは、Stripe トークンと新しいクレジット カードをデフォルトの支払い元として設定します。:

$card = $user->defaultCard();

Stripe がカード情報を顧客のデフォルトのカード情報と同期するには、updateCardFromStripe メソッドを使用できます:

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

クレジット カードの削除

カードを削除するには、まず cards を使用して顧客のカードを取得する必要があります。方法。その後、削除するカード インスタンスで delete メソッドを呼び出すことができます。

$user->updateCard($stripeToken);

{注} デフォルトのカードを削除する場合は、必ず # を使用してください。 ##updateCardFromStripe メソッド 新しいデフォルト カードをデータベースと同期します。

deleteCards メソッドは、アプリケーションによって保存されているすべてのユーザーのカード情報を削除します。

$user->updateCardFromStripe();

{注} ユーザーがすでにサブスクリプションを持っている場合は、最後に残っている支払い方法を削除できないようにすることを検討する必要があります。

Stripe と Braintree は両方とも、Webhook イベントを通じてさまざまなタイプのアプリケーションに通知できます。 Stripe Webhook を処理するには、Cashier の Webhook コントローラーへのルートを定義する必要があります。このコントローラーは、すべての受信 Webhook リクエストを処理し、適切なコントローラー メソッドにディスパッチします。

foreach ($user->cards() as $card) {
    $card->delete();
  }

デフォルトでは、このコントローラーは、支払い失敗が多すぎるサブスクリプションを自動的にキャンセルします (この数は Stripe 設定で定義できます)。さらに、このコントローラーを拡張して処理できることもすぐにわかります。処理したい Webhook イベント。

Stripe Webhook は Laraval の CSRF 保護をバイパスする必要があるため、必ず

に含めてください。ミドルウェア URI を含めるか、web ミドルウェア グループの外に配置します:

$user->deleteCards();

Webhook イベント ハンドラーを定義する

Cashier は失敗した支払いのサブスクライブを自動的に解除しますが、処理したい他の Stripe Webhook イベントがある場合は、Webhook コントローラーを拡張できます。メソッド名は、Cashier が期待する規則と一致する必要があります。具体的には、Stripe Webhook を処理するメソッドには、名前の前に handle と「camelCase」を付ける必要があります。たとえば、invoice.payment_succeeded Webhook を処理したい場合は、handleInvoicePaymentSucceeded メソッドをコントローラーに追加する必要があります。

Route::post( 
   'stripe/webhook',    
   '\Laravel\Cashier\Http\Controllers\WebhookController@handleWebhook'
   );

次に、routes でCashier コントローラーのルートは /web.php ファイルで定義されています:

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

Subscription failed

If ユーザーのクレジット カードの有効期限が切れたらどうすればよいですか?心配しないでください。Cashier には、ユーザーの登録を簡単に解除できる Webhook コントローラーが含まれています。上で述べたように、必要なのは、コントローラーへのルートを指定することだけです。

<?php
    namespace App\Http\Controllers;
    use Laravel\Cashier\Http\Controllers\WebhookController as CashierController;
    class WebhookController extends CashierController{  
      /**
     * Handle invoice payment succeeded.
     *
     * @param  array  $payload
     * @return \Symfony\Component\HttpFoundation\Response
     */   
      public function handleInvoicePaymentSucceeded($payload)  
        {     
           // 此处处理事件   
         }
      }

以上です。失敗した支払いはコントローラーによって取得および処理され、Stripe がサブスクリプションが失敗したと判断した後 (通常は支払い試行が 3 回以上失敗した場合)、ユーザーのサブスクリプションはキャンセルされます。

Stripe の Webhook 署名#を使用する必要があります。 ## 。便宜上、Cashier には、Stripe Webhook に渡されたリクエストが有効であることを検証するミドルウェアが含まれています。 Webhook 認証を有効にする場合は、

の値が services 構成ファイルで設定されていることを確認してください。 Webhook の secret は、Stripe ユーザー コントロール パネルから見つけることができます。

Stripe と Braintree はどちらも、Webhook を通じてさまざまなイベントをアプリケーションに通知できます。 Braintree Webhook を処理するには、Cashier Webhook コントローラーへのルートを定義する必要があります。このコントローラーはすべての受信 Webhook リクエストを処理し、適切なルーター メソッドにディスパッチします:

Route::post( 
   'stripe/webhook',    
   '\App\Http\Controllers\WebhookController@handleWebhook'
  );

デフォルトでは、このコントローラーは、支払い失敗が多すぎるサブスクリプションを自動的にキャンセルします (この数は Braintree 設定で定義できます)。さらに、このコントローラーを次の目的に拡張できることもすぐにわかります。処理したい Webhook イベントを処理します。

Braintree Webhook は Laravel の CSRF 保護をバイパスする必要があるため、

ミドルウェア リスト URI に必ず含めてください。または、web ミドルウェア グループの外に配置します:

Route::post( 
   'stripe/webhook',    
   '\Laravel\Cashier\Http\Controllers\WebhookController@handleWebhook'
  );

Webhook イベント ハンドラーを定義する

Cashier は失敗した支払いのサブスクライブを自動的に解除しますが、処理したい他の Braintree Webhook イベントがある場合は、Webhook コントローラーを拡張できます。メソッド名は、Cashier が期待する規則と一致する必要があります。具体的には、Braintree Webhook を処理するメソッドには、名前の前に handle と「camelCase」を付ける必要があります。たとえば、dispute_opened Webhook を処理したい場合は、handleDisputeOpened メソッドをコントローラーに追加する必要があります:

Route::post(
    'braintree/webhook',    
    '\Laravel\Cashier\Http\Controllers\WebhookController@handleWebhook'
    );

サブスクリプションに失敗しました

ユーザーのクレジット カードの有効期限が切れたらどうなりますか?心配しないでください。Cashier には、ユーザーの登録を簡単に解除できる Webhook コントローラーが含まれています。ルートをコントローラーに向けるだけです:

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

以上です!失敗した支払いはコントローラーによってキャプチャされて処理され、Braintree がサブスクリプションが失敗したと判断した後 (通常は支払い試行が 3 回以上失敗した場合)、ユーザーのサブスクリプションがキャンセルされます。忘れないでください: Braintree コントローラー パネルで Webhook URI を設定します。 ＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃1回払い＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃ # #Simple Payment

{注} Stripe を使用する場合、charge

に渡す必要があります。 メソッド:

加入者のクレジット カードに「1 回限り」料金を請求する場合は、次のようにします。請求可能なモデル インスタンスで charge

<?php
    namespace App\Http\Controllers;
    use Braintree\WebhookNotification;
    use Laravel\Cashier\Http\Controllers\WebhookController as CashierController;
    class WebhookController extends CashierController{ 
       /**
     * Handle a new dispute.
     *
     * @param  \Braintree\WebhookNotification  $webhook
     * @return \Symfony\Component\HttpFoundation\Responses
     */  
      public function handleDisputeOpened(WebhookNotification $webhook)  
        {    
            // 此处处理时事件... 
         }
     }

charge

Route::post(
    'braintree/webhook',    
    '\Laravel\Cashier\Http\Controllers\WebhookController@handleWebhook'
  );

支払いが失敗した場合、charge メソッドは例外をスローします。支払いが成功すると、このメソッドは完全な Stripe / Braintree レスポンスを返します:

// Stripe 接收分为单位的费用...
$stripeCharge = $user->charge(100);
// Braintree 接收美元为单位的费用...
$user->charge(1);

料金と請求書

場合によっては、1 回限りの料金を支払う必要があり、PDF ファイル形式で領収書を顧客に提供できるように料金請求書を作成する必要がある場合もあります。 invoiceFor メソッドを使用すると、これを行うことができます。たとえば、$5.00 の「1 回限りの料金」を顧客に請求するには:

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

請求書はすぐにユーザーのクレジット カードに請求されます。 invoiceFor このメソッドは 3 番目の引数として配列を受け取り、支払いを作成するときに基礎となる Stripe/Braintree に任意のオプションを渡すことができます:

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

Braintree を使用している場合請求プロバイダーの場合、invoiceFor メソッドを呼び出すときに description オプションを含める必要があります:

// Stripe 接收分为单位的费用...
$user->invoiceFor('One Time Fee', 500);
// Braintree 接收美元为单位的费用...
$user->invoiceFor('One Time Fee', 5);

{Note} invoiceFor メソッド A Stripe請求書が作成され、支払いが失敗した場合は再試行されます。失敗後に再試行したくない場合は、最初の支払いが失敗した後に Stripe API を呼び出してそれを閉じる必要があります。

返金について

返金を処理する必要がある場合は、refund を使用してください。 ＃＃＃ 方法。このメソッドは、Stripe 請求 ID を唯一のパラメータとして受け入れます:

$user->invoiceFor('Stickers', 500,
 [
    'quantity' => 50,
 ], 
 [  
      'tax_percent' => 21,
 ]);

invoices を使用できます。 請求モデルの請求書配列を簡単に取得する方法:

$user->invoiceFor('One Time Fee', 500,
 [
     'description' => 'your invoice description here',
 ]);

$stripeCharge = $user->charge(100);
$user->refund($stripeCharge->id);

downloadInvoice メソッドを使用して請求書の PDF ダウンロードを生成します。このメソッドは、ブラウザーに対して適切な HTTP ダウンロード応答を自動的に生成します。

$invoices = $user->invoices();
// 结果包含处理中的发票...
$invoices = $user->invoicesIncludingPending();